org.ldp4j.application.ext

Interface Parameter

All Superinterfaces:

Serializable

public interface Parameter
extends Serializable

A collection of values defined for a query parameter. The values are defined as strings, which can be transformed to other Java types.

Method Summary

Methods

Modifier and Type	Method and Description
int	cardinality() Returns the number of values in this parameter.
boolean	isMultivalued() Returns true if this parameter contains multiple values.
String	name() Returns the name of the parameter.
String	rawValue() Returns the first raw value of this parameter.
<T> T	rawValueAs(Class<? extends T> clazz) Returns the first raw value of this parameter as an instance of a given type.
List<String>	rawValues() Returns all the raw values of this parameter.
<T> List<T>	rawValuesAs(Class<? extends T> clazz) Returns the raw values of this parameter as instances of a given type.

Method Detail

name

String name()

Returns the name of the parameter.

Returns:

the name of the parameter

isMultivalued

boolean isMultivalued()

Returns true if this parameter contains multiple values.

Returns:

true if this parameter contains multiple values

cardinality

int cardinality()

Returns the number of values in this parameter. If the parameter contains more than Integer.MAX_VALUE value, returns Integer.MAX_VALUE.

Returns:

the number of values in this parameter

rawValue

String rawValue()

Returns the first raw value of this parameter.

Returns:

the first raw value of this parameter

rawValues

List<String> rawValues()

Returns all the raw values of this parameter. If the parameter is not multivalued, the result will just contain that parameter's single value.

Returns:

the raw values of this parameter

rawValueAs

<T> T rawValueAs(Class<? extends T> clazz)

Returns the first raw value of this parameter as an instance of a given type.

Type Parameters:

T - the type of object to be returned

Parameters:

clazz - the Class for the type T to which the raw value will be transformed to.

Returns:

the instance of the specified Class to which the first raw value of this parameter is transformed to.

Throws:

ObjectTransformationException - if the raw value cannot be transformed to the specified type T.

rawValuesAs

<T> List<T> rawValuesAs(Class<? extends T> clazz)

Returns the raw values of this parameter as instances of a given type.

Type Parameters:

T - the type of object to be returned

Parameters:

clazz - the Class for the type T to which the raw values will be transformed to.

Returns:

the instances of the specified Class to which the raw values of this parameter are transformed to.

Throws:

ObjectTransformationException - if any of the raw values cannot be transformed to the specified type T.