org.attribyte.api.http

Class Parameter

java.lang.Object

org.attribyte.api.http.Parameter

public final class Parameter
extends java.lang.Object

An immutable HTTP request (query string) parameter.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	name The parameter name.
static java.util.Comparator<Parameter>	nameComparator Compare parameters by name.
<any>	values An immutable list of parameter values.

Constructor Summary

Constructors

Constructor and Description
Parameter(java.lang.String name, java.util.Collection<java.lang.String> values) Creates a multi-valued parameter from a collection of values.
Parameter(java.lang.String name, java.lang.String value) Creates a parameter.
Parameter(java.lang.String name, java.lang.String[] values) Creates a multi-valued parameter.

Method Summary

Modifier and Type	Method and Description
Parameter	addValue(java.lang.String value) Returns a copy of this parameter with the new value added.
java.lang.String	getName() Gets the name.
java.lang.String	getValue() Gets the first value.
<any>	getValueList() Gets an immutable list of values.
java.lang.String[]	getValues() Gets all the values.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

nameComparator

public static final java.util.Comparator<Parameter> nameComparator

Compare parameters by name. Safe for use by many threads.

name

public final java.lang.String name

The parameter name.

values

public final <any> values

An immutable list of parameter values.

Constructor Detail

Parameter

public Parameter(java.lang.String name,
                 java.lang.String value)

Creates a parameter.

Parameters:

name - The parameter name.

value - The parameter value.

Parameter

public Parameter(java.lang.String name,
                 java.lang.String[] values)

Creates a multi-valued parameter.

Parameters:

name - The parameter name.

values - The parameter values.

Parameter

public Parameter(java.lang.String name,
                 java.util.Collection<java.lang.String> values)

Creates a multi-valued parameter from a collection of values.

Parameters:

name - The parameter name.

values - The parameter values.

Method Detail

addValue

public Parameter addValue(java.lang.String value)

Returns a copy of this parameter with the new value added.

Parameters:

value - The added value.

Returns:

The new parameter.

getName

public java.lang.String getName()

Gets the name.

Returns:

The name.

getValue

public java.lang.String getValue()

Gets the first value.

Never returns null. If the parameter has no value(s), an empty string is returned.

getValues

public java.lang.String[] getValues()

Gets all the values.

Returns:

The values.

getValueList

public <any> getValueList()

Gets an immutable list of values.

Returns:

The values.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object