com.helger.servlet.request

Interface IRequestParamMap

All Superinterfaces:

com.helger.commons.lang.IHasSize, Serializable

All Known Implementing Classes:

RequestParamMap

public interface IRequestParamMap
extends com.helger.commons.lang.IHasSize, Serializable

A request parameter map. It handles complex request parameters and lets you iterate the structure.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
boolean	contains(String... aPath)
boolean	containsKey(String sKey) Check if this map, contains the passed key.
com.helger.commons.collection.impl.ICommonsOrderedMap<String,RequestParamMapItem>	getAsObjectMap()
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAsValueMap()
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAsValueTrimmedMap()
default BigDecimal	getBigDecimal(String... aPath)
default BigInteger	getBigInteger(String... aPath)
default boolean	getBoolean(String sPath, boolean bDefault)
default double	getDouble(String sPath, double dDefault)
default int	getInt(String sPath, int nDefault)
default long	getLong(String sPath, long nDefault)
IRequestParamMap	getMap(String... aPath) Get a nested map for the specified path.
RequestParamMapItem	getObject(String... aPath)
default String	getString(String... aPath)
default String	getStringTrimmed(String... aPath)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getValueMap(String... aPath)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getValueTrimmedMap(String... aPath)
default boolean	isCheckBoxChecked(String sFieldName, boolean bDefaultValue) Get the value of the checkbox of the request parameter with the given name.
com.helger.commons.collection.impl.ICommonsOrderedSet<String>	keySet()
com.helger.commons.collection.impl.ICommonsList<RequestParamMapItem>	values()

Methods inherited from interface com.helger.commons.lang.IHasSize

isEmpty, isNotEmpty, size

Method Detail

contains

boolean contains(@Nonnull @Nonempty
                 String... aPath)

getObject

@Nullable
RequestParamMapItem getObject(@Nonnull @Nonempty
                                         String... aPath)

getString

@Nullable
default String getString(@Nonnull @Nonempty
                                    String... aPath)

getStringTrimmed

@Nullable
default String getStringTrimmed(@Nonnull @Nonempty
                                           String... aPath)

getBoolean

default boolean getBoolean(@Nonnull @Nonempty
                           String sPath,
                           boolean bDefault)

getDouble

default double getDouble(@Nonnull @Nonempty
                         String sPath,
                         double dDefault)

getInt

default int getInt(@Nonnull @Nonempty
                   String sPath,
                   int nDefault)

getLong

default long getLong(@Nonnull @Nonempty
                     String sPath,
                     long nDefault)

getBigInteger

@Nullable
default BigInteger getBigInteger(@Nonnull @Nonempty
                                            String... aPath)

getBigDecimal

@Nullable
default BigDecimal getBigDecimal(@Nonnull @Nonempty
                                            String... aPath)

isCheckBoxChecked

default boolean isCheckBoxChecked(@Nullable
                                  String sFieldName,
                                  boolean bDefaultValue)

Get the value of the checkbox of the request parameter with the given name. Ripped from IRequestParamContainer....

Parameters:

sFieldName - Request parameter name. May be null.

bDefaultValue - the default value to be returned, if no request attribute is present

Returns:

true if the checkbox is checked, false if it is not checked and the default value otherwise.

getValueMap

@Nullable
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getValueMap(@Nonnull @Nonempty
                                                                                            String... aPath)

getValueTrimmedMap

@Nullable
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getValueTrimmedMap(@Nonnull @Nonempty
                                                                                                   String... aPath)

getMap

@Nullable
IRequestParamMap getMap(@Nonnull @Nonempty
                                   String... aPath)

Get a nested map for the specified path.

Parameters:

aPath - The path to be resolved

Returns:

null if the path could not be resolved.

containsKey

boolean containsKey(@Nullable
                    String sKey)

Check if this map, contains the passed key. This will be true both for nested maps as well as for values.

Parameters:

sKey - The key to check.

Returns:

true if such a key is contained, false if not

keySet

@Nonnull
 @ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsOrderedSet<String> keySet()

Returns:

A set of all contained key. Never null but maybe empty.

values

@Nonnull
 @ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsList<RequestParamMapItem> values()

Returns:

A collection of all values of this map. The type of the value is usually either String, file item (from upload) or Map from String to Object.

getAsObjectMap

@Nonnull
 @ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsOrderedMap<String,RequestParamMapItem> getAsObjectMap()

Returns:

A copy of the contained map. For the value types see values()

getAsValueMap

@Nonnull
 @ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getAsValueMap()

Returns:

A key/value map, with enforced values. If this map contains a nested map, the nested maps are ignored!

getAsValueTrimmedMap

@Nonnull
 @ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getAsValueTrimmedMap()

Returns:

A key/value map, with enforced and trimmed values. If this map contains a nested map, the nested maps are ignored!