org.apache.avalon.excalibur.source
Class SourceParameters

java.lang.Object
  |
  +--org.apache.avalon.excalibur.source.SourceParameters

All Implemented Interfaces:

java.io.Serializable

public final class SourceParameters

extends java.lang.Object

implements java.io.Serializable

This class holds parameters for a Source object. It differs from the usual Parameters object because in can hold more than one value for a parameter.

Version:

$Id: SourceParameters.java,v 1.4 2001/12/11 09:53:36 jefft Exp $

Author:

Carsten Ziegeler

See Also:

Serialized Form

Constructor Summary

SourceParameters()
Standard Constructor

SourceParameters(java.lang.String queryString)
Construct a new object from a queryString

Method Summary

void	add(SourceParameters parameters) Add all parameters from the incoming parameters object.
java.lang.Object	clone() Returns a copy of the parameters object.
boolean	containsParameter(java.lang.String name) Test if a value for this parameter exists.
java.lang.String	getEncodedQueryString() Build a query string and encode each parameter value The query string can e.g.
org.apache.avalon.framework.parameters.Parameters	getFirstParameters() Create a Parameters object.
java.lang.String	getParameter(java.lang.String name) Get the value of a parameter.
java.lang.String	getParameter(java.lang.String name, java.lang.String defaultValue) Get the value of a parameter.
boolean	getParameterAsBoolean(java.lang.String name, boolean defaultValue) Get the boolean value of a parameter.
int	getParameterAsInteger(java.lang.String name, int defaultValue) Get the integer value of a parameter.
java.util.Iterator	getParameterNames() Get all parameter names.
java.util.Iterator	getParameterValues(java.lang.String name) Get all values of a parameter.
java.lang.String	getQueryString() Build a query string.
boolean	hasParameters() Test if there are any parameters.
void	removeParameter(java.lang.String name) Remove all values for this parameter
void	setSingleParameterValue(java.lang.String name, java.lang.String value) Set the value of this parameter to the given value.
java.lang.String	toString() Overriding toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SourceParameters

public SourceParameters()

Standard Constructor

SourceParameters

public SourceParameters(java.lang.String queryString)

Construct a new object from a queryString

Method Detail

getParameter

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

Get the value of a parameter.

Parameters:

name - The name of the parameter.

Returns:

The value of the first parameter with the name or null

getParameter

public java.lang.String getParameter(java.lang.String name,
                                     java.lang.String defaultValue)

Get the value of a parameter.

Parameters:

name - The name of the parameter.

defaultValue - The default value if the parameter does not exist.

Returns:

The value of the first parameter with the name or defaultValue

getParameterAsInteger

public int getParameterAsInteger(java.lang.String name,
                                 int defaultValue)

Get the integer value of a parameter.

Parameters:

name - The name of the parameter.

defaultValue - The default value if the parameter does not exist.

Returns:

The value of the first parameter with the name or defaultValue

getParameterAsBoolean

public boolean getParameterAsBoolean(java.lang.String name,
                                     boolean defaultValue)

Get the boolean value of a parameter.

Parameters:

name - The name of the parameter.

defaultValue - The default value if the parameter does not exist.

Returns:

The value of the first parameter with the name or defaultValue

containsParameter

public boolean containsParameter(java.lang.String name)

Test if a value for this parameter exists.

Parameters:

name - The name of the parameter.

Returns:

true if a value exists, otherwise false

getParameterValues

public java.util.Iterator getParameterValues(java.lang.String name)

Get all values of a parameter.

Parameters:

name - The name of the parameter.

Returns:

Iterator for the (String) values or null if the parameter is not defined.

getParameterNames

public java.util.Iterator getParameterNames()

Get all parameter names.

Returns:

Iterator for the (String) parameter names.

getFirstParameters

public org.apache.avalon.framework.parameters.Parameters getFirstParameters()

Create a Parameters object. The first value of each parameter is added to the Parameters object.

Returns:

An Parameters object - if no parameters are defined this is an empty object.

getQueryString

public java.lang.String getQueryString()

Build a query string. The query string can e.g. be used for http connections.

Returns:

A query string which contains for each parameter/value pair a part, like "parameter=value" separated by "&". If no parameter is defined null is returned.

getEncodedQueryString

public java.lang.String getEncodedQueryString()

Build a query string and encode each parameter value The query string can e.g. be used for http connections.

Returns:

A query string which contains for each parameter/value pair a part, like "parameter=value" separated by "&". If no parameter is defined null is returned.

add

public void add(SourceParameters parameters)

Add all parameters from the incoming parameters object.

toString

public java.lang.String toString()

Overriding toString

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Returns a copy of the parameters object.

Overrides:

clone in class java.lang.Object

hasParameters

public boolean hasParameters()

Test if there are any parameters.

setSingleParameterValue

public void setSingleParameterValue(java.lang.String name,
                                    java.lang.String value)

Set the value of this parameter to the given value. Remove all other values for this parameter.

removeParameter

public void removeParameter(java.lang.String name)

Remove all values for this parameter