core.tut.pori.http.parameters

Class DataGroups

java.lang.Object

core.tut.pori.http.parameters.HTTPParameter

core.tut.pori.http.parameters.DataGroups

public final class DataGroups
extends HTTPParameter

Default dataGroups parser. Syntax: ?data_groups=DATA_GROUP_VALUE or with type ?data_groups=TYPE;DATA_GROUP_VALUE, these can be combined: ?data_groups=DATA_GROUP_VALUE,TYPE:DATA_GROUP_VALUE Note: this has no way of knowing if the given string are valid for the required context, you should check the values manually There is no concept of order for the data groups, and they can be provided in any order for the data_groups parameter.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATA_GROUP_ALL If present in a request, all available content should be returned in the response
static java.lang.String	DATA_GROUP_BASIC If present in a request, the basic should be returned in the response.
static java.lang.String	DATA_GROUP_DEFAULTS If present in a request, the default content should be returned in the response.
static java.lang.String	PARAMETER_DEFAULT_NAME the default HTTP parameter name

Constructor Summary

Constructors

Constructor and Description
DataGroups() required for serialization
DataGroups(DataGroups dataGroups) Create a new copy based on the given dataGroup, this will create a deep copy of the given object.
DataGroups(java.lang.String... dataGroups) varargs constructor for data groups

Method Summary

Modifier and Type	Method and Description
void	addDataGroup(java.lang.String dataGroup) Add datagroup to the default, non-typed datagroup list
void	addDataGroup(java.lang.String dataGroup, java.lang.String type) Add the given dataGroup for the given type
java.lang.String	getValue()
static boolean	hasDataGroup(java.lang.String dataGroup, DataGroups dataGroups)
static boolean	hasDataGroup(java.lang.String dataGroup, DataGroups dataGroups, java.lang.String type)
boolean	hasValues()
void	initialize(java.util.List<java.lang.String> parameterValues) Initialize this parameter based on the given parameter values
void	initialize(java.lang.String parameterValue) Initialize this parameter based on the given parameter value
static boolean	isEmpty(DataGroups dataGroups)
boolean	removeDataGroup(java.lang.String dataGroup) Remove the data group from the default type
boolean	removeDataGroup(java.lang.String dataGroup, java.lang.String type) Remove data group from the given type
java.lang.String	toDataGroupString()

Methods inherited from class core.tut.pori.http.parameters.HTTPParameter

getParameterName, initialize, initializeRaw, initializeRaw, setParameterName

Methods inherited from class java.lang.Object

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

Field Detail

DATA_GROUP_ALL

public static final java.lang.String DATA_GROUP_ALL

If present in a request, all available content should be returned in the response

See Also:

Constant Field Values

DATA_GROUP_BASIC

public static final java.lang.String DATA_GROUP_BASIC

If present in a request, the basic should be returned in the response. Note that the definition of "basic" is service specific.

See Also:

Constant Field Values

DATA_GROUP_DEFAULTS

public static final java.lang.String DATA_GROUP_DEFAULTS

If present in a request, the default content should be returned in the response. This in general equals to not providing a data group parameter.

See Also:

Constant Field Values

PARAMETER_DEFAULT_NAME

public static final java.lang.String PARAMETER_DEFAULT_NAME

the default HTTP parameter name

See Also:

Constant Field Values

Constructor Detail

DataGroups

public DataGroups(java.lang.String... dataGroups)

varargs constructor for data groups

Parameters:

dataGroups -

DataGroups

public DataGroups()

required for serialization

DataGroups

public DataGroups(DataGroups dataGroups)

Create a new copy based on the given dataGroup, this will create a deep copy of the given object.

Parameters:

dataGroups - not-null

Method Detail

initialize

public void initialize(java.util.List<java.lang.String> parameterValues)
                throws java.lang.IllegalArgumentException

Description copied from class: HTTPParameter

Initialize this parameter based on the given parameter values

Specified by:

initialize in class HTTPParameter

Parameters:

parameterValues - can NOT be null

Throws:

java.lang.IllegalArgumentException - on bad input data

initialize

public void initialize(java.lang.String parameterValue)
                throws java.lang.IllegalArgumentException

Description copied from class: HTTPParameter

Initialize this parameter based on the given parameter value

Specified by:

initialize in class HTTPParameter

Parameters:

parameterValue - can be null

Throws:

java.lang.IllegalArgumentException - on bad input data

hasValues

public boolean hasValues()

Specified by:

hasValues in class HTTPParameter

Returns:

true if this parameter has one or more values

hasDataGroup

public static boolean hasDataGroup(java.lang.String dataGroup,
                                   DataGroups dataGroups)

Parameters:

dataGroup -

dataGroups - can be null

Returns:

true if the data group contains the given group

hasDataGroup

public static boolean hasDataGroup(java.lang.String dataGroup,
                                   DataGroups dataGroups,
                                   java.lang.String type)

Parameters:

dataGroup -

dataGroups - can be null

type -

Returns:

true if the given data group is given for the given type and data group. If the type is not found, returns true if the data group is given by default (non-typed).

removeDataGroup

public boolean removeDataGroup(java.lang.String dataGroup)

Remove the data group from the default type

Parameters:

dataGroup -

Returns:

true if the dataGroup was removed

removeDataGroup

public boolean removeDataGroup(java.lang.String dataGroup,
                               java.lang.String type)

Remove data group from the given type

Parameters:

dataGroup -

type -

Returns:

true if the group was removed (existed in this group)

addDataGroup

public void addDataGroup(java.lang.String dataGroup)

Add datagroup to the default, non-typed datagroup list

Parameters:

dataGroup -

addDataGroup

public void addDataGroup(java.lang.String dataGroup,
                         java.lang.String type)

Add the given dataGroup for the given type

Parameters:

dataGroup -

type -

isEmpty

public static boolean isEmpty(DataGroups dataGroups)

Parameters:

dataGroups -

Returns:

true if this group is empty

toDataGroupString

public java.lang.String toDataGroupString()

Returns:

this group as data group uri string

getValue

public java.lang.String getValue()

Specified by:

getValue in class HTTPParameter

Returns:

the datagroups as datagroup String or null if no datagroups