org.apache.stylebook

Interface Parameters

All Known Subinterfaces:

CreationContext

All Known Implementing Classes:

BasicContext, BasicEntry, BasicParameters, NodeListParameters

public interface Parameters

Version:

CVS $Revision: 313195 $ $Date: 1999-11-15 23:08:18 +0100 (Mon, 15 Nov 1999) $

Author:

Pierpaolo Fumagalli, Copyright 1999 © The Apache Software Foundation. All rights reserved.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getParameter(java.lang.String name) Retrieve a value for a specified parameter.
java.lang.String	getParameter(java.lang.String name, java.lang.String def) Retrieve a value for a specified parameter.
java.util.Enumeration	getParameterNames() Get all valid parameter names.
Parameters	merge(Parameters p) Merge the values from another Parameters object into this instance.
java.lang.String	setParameter(java.lang.String name, java.lang.String value) Set or update parameter value.

Method Detail

getParameter

java.lang.String getParameter(java.lang.String name)

Retrieve a value for a specified parameter.

Parameters:

name - The parameter name.

Returns:

The parameter value or null if the parameter has no specified value.

getParameter

java.lang.String getParameter(java.lang.String name,
                            java.lang.String def)

Retrieve a value for a specified parameter.

Parameters:

name - The parameter name.

def - The parameter default value.

Returns:

The parameter value or def if the parameter has no specified value.

getParameterNames

java.util.Enumeration getParameterNames()

Get all valid parameter names.

Returns:

A non-null (maybe empty) Enumeration.

setParameter

java.lang.String setParameter(java.lang.String name,
                            java.lang.String value)

Set or update parameter value.

Returns:

The old value of the parameter or null.

merge

Parameters merge(Parameters p)

Merge the values from another Parameters object into this instance.

Parameters:

p - The Parameters object from wich values must be retrieved.