Package com.helger.web.scope.util

Class RequestFieldDataMultiValue

java.lang.Object

com.helger.web.scope.util.AbstractRequestFieldData

com.helger.web.scope.util.RequestFieldDataMultiValue

Direct Known Subclasses:

SessionBackedRequestFieldDataMultiValue

@Immutable
public class RequestFieldDataMultiValue
extends AbstractRequestFieldData

Represents a wrapper around a single request value. It allows gathering the current values, optionally using default values.

Since:

9.0.2

Author:

Philip Helger

See Also:

For single value class

Constructor Summary

Constructors

Constructor	Description
RequestFieldDataMultiValue(RequestFieldDataMultiValue aRF)	Copy constructor
RequestFieldDataMultiValue(String sFieldName)	Create a new request field that has no default value
RequestFieldDataMultiValue(String sFieldName, Collection<String> aDefaultValues)	Default constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsList<String>	getDefaultValues()
com.helger.commons.collection.impl.ICommonsList<String>	getRequestValues()	Get the value of the request - optionally falling back to the provided default value if no such request parameter is present
protected com.helger.commons.collection.impl.ICommonsList<String>	getRequestValuesWithoutDefault()	Helper method to get the request value without falling back to the provided default value.
int	hashCode()
boolean	hasRequestValues(Collection<String> aExpectedValues)	Utility method that checks if the passed expected value matches the request parameter (considering the fallback mechanism)
String	toString()

Methods inherited from class com.helger.web.scope.util.AbstractRequestFieldData

getFieldName, getParams

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestFieldDataMultiValue

public RequestFieldDataMultiValue(@Nonnull
                                  RequestFieldDataMultiValue aRF)

Copy constructor

Parameters:

aRF - The request field to copy the values from. May not be null.

RequestFieldDataMultiValue

public RequestFieldDataMultiValue(@Nonnull @Nonempty
                                  String sFieldName)

Create a new request field that has no default value

Parameters:

sFieldName - The field name to use. May neither be null nor empty.

RequestFieldDataMultiValue

public RequestFieldDataMultiValue(@Nonnull @Nonempty
                                  String sFieldName,
                                  @Nullable
                                  Collection<String> aDefaultValues)

Default constructor.

Parameters:

sFieldName - The field name to use. May neither be null nor empty.

aDefaultValues - The default values to use, if no value is present in the request scope.

Method Detail

getDefaultValues

@Nonnull
@ReturnsMutableCopy
@OverrideOnDemand
public com.helger.commons.collection.impl.ICommonsList<String> getDefaultValues()

Returns:

The default values to be used if no request parameter is present. Is never null but an empty list if no default value is available.

getRequestValuesWithoutDefault

@Nullable
protected final com.helger.commons.collection.impl.ICommonsList<String> getRequestValuesWithoutDefault()

Helper method to get the request value without falling back to the provided default value.

Returns:

null if no such request value is present

getRequestValues

@Nonnull
public final com.helger.commons.collection.impl.ICommonsList<String> getRequestValues()

Get the value of the request - optionally falling back to the provided default value if no such request parameter is present

Returns:

A single request value as string.

hasRequestValues

public final boolean hasRequestValues(@Nonnull
                                      Collection<String> aExpectedValues)

Utility method that checks if the passed expected value matches the request parameter (considering the fallback mechanism)

Parameters:

aExpectedValues - The list of expected values. May not be null.

Returns:

true if the passed value equals the actual request value

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractRequestFieldData

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRequestFieldData

toString

public String toString()

Overrides:

toString in class AbstractRequestFieldData