to.etc.domui.state

Interface IPageParameters

All Known Implementing Classes:

PageParameters

public interface IPageParameters

Method Summary

Modifier and Type	Method and Description
String	calculateHashString() EXPENSIVE Hash all parameter values into an MD5 hash.
boolean	equals(Object obj) Compare this with another instance.
boolean	getBoolean(String name) Gets the value for the specified parametername as a boolean (primitive).
boolean	getBoolean(String name, boolean df) Gets the value for the specified parametername as a boolean (primitive).
int	getDataLength() Return the number of characters that this would take on an url.
int	getInt(String name) Gets the value for the specified parametername as an int (primitive).
int	getInt(String name, int df) Gets the value for the specified parametername as an int (primitive).
long	getLong(String name) Gets the value for the specified parametername as a long (primitive).
long	getLong(String name, long df) Gets the value for the specified parametername as a long (primitive).
Long	getLongW(String name) Gets the value for the specified parametername as a Long object.
Long	getLongW(String name, long df) Gets the value for the specified parametername as a Long object.
Long	getLongW(String name, Long df) Gets the value for the specified parametername as a Long object.
String[]	getParameterNames() Gets all the names of the parameters this object is holding
String	getString(String name) Gets the value for the specified parametername as a String object.
String	getString(String name, String df) Gets the value for the specified parametername as a String object.
String[]	getStringArray(String name) Gets the value for the specified parametername as a String array.
String[]	getStringArray(String name, String[] deflt)
PageParameters	getUnlockedCopy() Creates copy of current PageParameters.
int	hashCode()
boolean	hasParameter(String name) Indicates whether a given parameter name exists in this PageParameters object.
boolean	isReadOnly()
int	size()

Method Detail

getUnlockedCopy

PageParameters getUnlockedCopy()

Creates copy of current PageParameters. Since modification of live page params is not allowed, in order to navigate to other page with similar set of params, use this method to get params template for new page navigation.

Returns:

hasParameter

boolean hasParameter(String name)

Indicates whether a given parameter name exists in this PageParameters object.

Parameters:

name, - the name of the parameter to be checked for.

Returns:

true when the parameter exists, false otherwise.

getInt

int getInt(String name)

Gets the value for the specified parametername as an int (primitive). If the parameter does not exists or the value cannot be converted to an int, a MissingParameterException is thrown.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

Returns:

the value as an int

getInt

int getInt(String name,
           int df)

Gets the value for the specified parametername as an int (primitive). If the parameter does cannot be converted to an int, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

df, - the default value to be returned, when the specified parameter does not exist.

Returns:

the value as an int

getLong

long getLong(String name)

Gets the value for the specified parametername as a long (primitive). When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does not exists or the value cannot be converted to an long, a MissingParameterException is thrown.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

Returns:

the value as a long

getLong

long getLong(String name,
             long df)

Gets the value for the specified parametername as a long (primitive). When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does cannot be converted to an long, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

df, - the default value to be returned, when the specified parameter does not exist.

Returns:

the value as a long

getBoolean

boolean getBoolean(String name)

Gets the value for the specified parametername as a boolean (primitive). When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does not exists or the value cannot be converted to an boolean, a MissingParameterException is thrown.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

Returns:

the value as a long

getBoolean

boolean getBoolean(String name,
                   boolean df)

Gets the value for the specified parametername as a boolean (primitive). When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does cannot be converted to an boolean, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

df, - the default value to be returned, when the specified parameter does not exist.

Returns:

the value as a boolean

getLongW

Long getLongW(String name)

Gets the value for the specified parametername as a Long object. When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does not exists or the value cannot be converted to an int, a MissingParameterException is thrown. This method uses decode() so hexadecimal and octal strings can be used as parameter values.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

Returns:

the value as a Long

getLongW

Long getLongW(String name,
              long df)

Gets the value for the specified parametername as a Long object. When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does cannot be converted to an int, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned. This method uses decode() so hexadecimal and octal strings can be used as parameter values.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

df, - the default value to be returned, when the specified parameter does not exist.

Returns:

the value as a Long

getLongW

Long getLongW(String name,
              Long df)

Gets the value for the specified parametername as a Long object. When multiple value exists for the specified parameter, the first element of the array is returned. If the parameter does cannot be converted to an int, a MissingParameterException is thrown. When the parameter does not exist, the specified default value is returned. This method uses decode() so hexadecimal and octal strings can be used as parameter values.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

df, - the default value to be returned, when the specified parameter does not exist.

Returns:

the value as a Long

getString

@Nonnull
String getString(String name)

Gets the value for the specified parametername as a String object. When multiple value exists for the specified parameter, a MultipleParameterException is thrown. When the parameter does not exist, a MissingParameterException is thrown.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

Returns:

the value as a String

getString

@Nullable
String getString(String name,
                           String df)

Gets the value for the specified parametername as a String object. When multiple value exists for the specified parameter, a MultipleParameterException is thrown. When the parameter does not exist, the specified default value is returned.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

df, - the default value to be returned, when the specified parameter does not exist.

Returns:

the value as a String

getStringArray

@Nonnull
String[] getStringArray(@Nonnull
                                 String name)

Gets the value for the specified parametername as a String array. When the parameter does not exist, a MissingParameterException is thrown. This method is provided for legacy reasons only. The domui framework discourages uses of parameter arrays.

Parameters:

name, - the name of the parameter who's value is to be retrieved.

Returns:

the value as a String

getStringArray

@Nullable
String[] getStringArray(@Nonnull
                                  String name,
                                  @Nullable
                                  String[] deflt)

getParameterNames

@Nonnull
String[] getParameterNames()

Gets all the names of the parameters this object is holding

Returns:

the parameter names in an array

equals

boolean equals(Object obj)

Compare this with another instance. Used to see that a new request has different parameters than an earlier request.

remark

We check the size of the maps; if they are equal we ONLY have to check that each key-value pair in SOURCE exists in TARGET AND is the same. We don't need to check for "thingies in SRC that do not occur in TGT" because that cannot happen if the map sizes are equal.

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hashCode

int hashCode()

Overrides:

hashCode in class Object

calculateHashString

@Nonnull
String calculateHashString()

EXPENSIVE Hash all parameter values into an MD5 hash. This must be repeatable so same parameters get the same hash code.

Returns:

getDataLength

int getDataLength()

Return the number of characters that this would take on an url.

Returns:

isReadOnly

boolean isReadOnly()

size

int size()