org.dmfs.httpessentials.parameters

Interface ParameterType<ValueType>

Type Parameters:

ValueType - The type of the parameter value.

All Superinterfaces:

EntityType<ValueType>

public interface ParameterType<ValueType>
extends EntityType<ValueType>

Represents the type of a parameter. That is, it binds a parameter name to a value type.

Two ParameterTypes are considered to equal if they have the same header name.

Author:

Marten Gajda

Method Summary

Methods

Modifier and Type	Method and Description
Parameter<ValueType>	entity(ValueType value) Factory method to create Parameters of this type from a value.
Parameter<ValueType>	entityFromString(java.lang.String parameterValueString) Factory method to create Parameters of this type from the given String representation.
java.lang.String	name() Returns the name of the parameter.
java.lang.String	valueString(ValueType headerValue) Returns the string representation of the given parameter value as defined for this Parameter.

Methods inherited from interface org.dmfs.httpessentials.typedentity.EntityType

valueFromString

Method Detail

name

java.lang.String name()

Returns the name of the parameter.

Specified by:

name in interface EntityType<ValueType>

Returns:

The parameter name, never null.

entityFromString

Parameter<ValueType> entityFromString(java.lang.String parameterValueString)

Factory method to create Parameters of this type from the given String representation.

Specified by:

entityFromString in interface EntityType<ValueType>

Parameters:

parameterValueString - The String representation of the Parameter value.

Returns:

A new Parameter instance.

entity

Parameter<ValueType> entity(ValueType value)

Factory method to create Parameters of this type from a value.

Specified by:

entity in interface EntityType<ValueType>

Parameters:

value - The value of the parameter, must not be null

Returns:

A new Parameter instance.

valueString

java.lang.String valueString(ValueType headerValue)

Returns the string representation of the given parameter value as defined for this Parameter.

Specified by:

valueString in interface EntityType<ValueType>

Parameters:

value - The value to convert.

Returns:

A value String representing the given value.