votorola.g.web.wic

Class PageParametersX

java.lang.Object

PageParametersX

@ThreadSafe
public final class PageParametersX
extends Object

PageParameters utilities.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	SPLIT_ON_BAR_PATTERN A pattern that splits on vertical bars '|'.

Method Summary

Methods

Modifier and Type	Method and Description
static PageParameters	copyOrNew(PageParameters pP) Constructs a PageParameters, copying its state from pP if it is not null.
static String	getString(PageParameters pP, String name) Returns the value of the specified parameter as a string.
static String	getStringNonEmpty(PageParameters pP, String name) Returns the null or non-empty value of the specified parameter as a string.
static String	getStringRequired(PageParameters pP, String name) Returns the non-null, non-empty value of the specified parameter as a string.
static Set<String>	splitAsSet(String value, Pattern pattern) Splits the specified value into a set of strings, separated by the given pattern.
static PageParameters	withSet(PageParameters pP, String name, String value) Returns the specified page parameters (p) with a new value set.

Methods inherited from class java.lang.Object

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

Field Detail

SPLIT_ON_BAR_PATTERN

public static final Pattern SPLIT_ON_BAR_PATTERN

A pattern that splits on vertical bars '|'.

Method Detail

copyOrNew

public static PageParameters copyOrNew(PageParameters pP)

Constructs a PageParameters, copying its state from pP if it is not null.

getString

public static final String getString(PageParameters pP,
               String name)

Returns the value of the specified parameter as a string. This is a convenient short hand for p.get(name).toString().

getStringNonEmpty

public static final String getStringNonEmpty(PageParameters pP,
                       String name)

Returns the null or non-empty value of the specified parameter as a string.

Throws:

VotorolaRuntimeException - if the value is the empty string "".

See Also:

HTTPServletRequestX.getParameterNonEmpty(String,javax.servlet.ServletRequest)

getStringRequired

public static final String getStringRequired(PageParameters pP,
                       String name)

Returns the non-null, non-empty value of the specified parameter as a string.

Throws:

VotorolaRuntimeException - if the value is either null, or the empty string "".

See Also:

HTTPServletRequestX.getParameterRequired(String,javax.servlet.ServletRequest)

splitAsSet

public static Set<String> splitAsSet(String value,
                     Pattern pattern)

Splits the specified value into a set of strings, separated by the given pattern. The set will not include the empty string.

withSet

public static PageParameters withSet(PageParameters pP,
                     String name,
                     String value)

Returns the specified page parameters (p) with a new value set. This is just a convenience method for setting values on the fly. If p is null but the value is non-null, then p is automatically constructed and returned.

Parameters:

pP - the parameters, which may be null.

value - the value to set. If null, then this method is a no-op.

Returns:

the same p; or, if p was null and the value was non-null, the p that was constucted in order to set the value.