org.weborganic.furi
Interface Parameters

All Known Implementing Classes:

URIParameters

public interface Parameters

An interface to hold a collection of parameters for use during the expansion process.

Version:

5 November 2009

Author:

Christophe Lauret

Method Summary

boolean	exists(String name) Indicates whether the parameters for the given name has a value.
String	getValue(String name) Returns the value for the specified parameter.
String[]	getValues(String name) Returns the values for the specified parameter.
boolean	hasValue(String name) Indicates whether the parameters for the given name has a value.
Set<String>	names() Returns the set of parameter names as an unmodifiable set.
void	set(String name, String value) Set a parameter with only one value.
void	set(String name, String[] values) Set a parameter with only multiple values.

Method Detail

getValue

String getValue(String name)

Returns the value for the specified parameter.

Parameters:

name - The name of the parameter.

Returns:

The value for this parameter or null if not specified.

getValues

String[] getValues(String name)

Returns the values for the specified parameter.

Parameters:

name - The name of the parameter.

Returns:

The values for this parameter or null if not specified.

exists

boolean exists(String name)

Indicates whether the parameters for the given name has a value. A parameter has a value if: - it is defined in the parameter list - its array of value has at least one value that is not an empty string

Parameters:

name - The name of the parameter.

Returns:

true if it has a value; false otherwise.

hasValue

boolean hasValue(String name)

Indicates whether the parameters for the given name has a value.

A parameter has a value if:

• It is defined in the parameter list
• Its array of value has at least one value that is not an empty string

Parameters:

name - The name of the parameter.

Returns:

true if it has a value; false otherwise.

names

Set<String> names()

Returns the set of parameter names as an unmodifiable set.

Returns:

The set of parameter names as an unmodifiable set.

set

void set(String name,
         String value)

Set a parameter with only one value.

Parameters:

name - The name of the parameter.

value - The value.

set

void set(String name,
         String[] values)

Set a parameter with only multiple values.

Parameters:

name - The name of the parameter.

values - The values.