Package com.helger.servlet.request

Class RequestParamMap

java.lang.Object

com.helger.servlet.request.RequestParamMap

All Implemented Interfaces:

com.helger.commons.lang.IHasSize, IRequestParamMap

@NotThreadSafe
public class RequestParamMap
extends Object
implements IRequestParamMap

This class represents a nested map that is build from request parameters. E.g. the parameter struct[key]=value results in a map{struct=map{key=value}}.
If another parameter struct[key2]=value2 is added the resulting map looks like this: map{struct=map{key=value, key2=value2}}. Theses maps can indefinitely be nested.
Having only struct[key1][key2][key3]=value results in map{struct=map{key1=map{key2=map{key3=value}}}}

By default the separator chars are "[" and "]" but since this may be a problem with JS expressions, setSeparators(char, char) and setSeparators(String, String) offer the possibility to set different separator separators that are not special.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_CLOSE
static String	DEFAULT_OPEN

Constructor Summary

Constructors

Constructor	Description
RequestParamMap()
RequestParamMap(Map<String,?> aMap)	This constructor is private, because it does not call the put(String, Object) method which does the main string parsing!

Method Summary

Modifier and Type	Method	Description
boolean	contains(String... aPath)
boolean	containsKey(String sKey)	Check if this map, contains the passed key.
static IRequestParamMap	create(Map<String,Object> aAttrCont)
static IRequestParamMap	createFromRequest(jakarta.servlet.http.HttpServletRequest aHttpRequest)
boolean	equals(Object o)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,RequestParamMapItem>	getAsObjectMap()
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAsValueMap()
static com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAsValueMap(Map<String,? extends RequestParamMapItem> aMap)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAsValueTrimmedMap()
static com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getAsValueTrimmedMap(Map<String,? extends RequestParamMapItem> aMap)
static String	getCloseSeparator()
static String	getFieldName(String sBaseName)	Deprecated.
static String	getFieldName(String sBaseName, int... aSuffixes)
static String	getFieldName(String sBaseName, String... aSuffixes)
IRequestParamMap	getMap(String... aPath)	Get a nested map for the specified path.
RequestParamMapItem	getObject(String... aPath)
static String	getOpenSeparator()
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getValueMap(String... aPath)
com.helger.commons.collection.impl.ICommonsOrderedMap<String,String>	getValueTrimmedMap(String... aPath)
int	hashCode()
boolean	isEmpty()
com.helger.commons.collection.impl.ICommonsOrderedSet<String>	keySet()
void	put(String sPath, Object aValue)
static void	setSeparators(char cOpen, char cClose)	Set the separator chars to use.
static void	setSeparators(String sOpen, String sClose)	Set the separators to use.
static void	setSeparatorsToDefault()
int	size()
String	toString()
com.helger.commons.collection.impl.ICommonsList<RequestParamMapItem>	values()

Methods inherited from class java.lang.Object

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

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

isNotEmpty

Methods inherited from interface com.helger.servlet.request.IRequestParamMap

getBigDecimal, getBigInteger, getBoolean, getDouble, getInt, getLong, getString, getStringTrimmed, isCheckBoxChecked

Field Detail

DEFAULT_OPEN

public static final String DEFAULT_OPEN

See Also:

Constant Field Values

DEFAULT_CLOSE

public static final String DEFAULT_CLOSE

See Also:

Constant Field Values

Constructor Detail

RequestParamMap

public RequestParamMap()

RequestParamMap

public RequestParamMap(@Nonnull
                       Map<String,?> aMap)

This constructor is private, because it does not call the put(String, Object) method which does the main string parsing!

Parameters:

aMap - The map to use. May not be null.

Method Detail

put

public void put(@Nonnull
                String sPath,
                @Nullable
                Object aValue)

contains

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

Specified by:

contains in interface IRequestParamMap

getObject

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

Specified by:

getObject in interface IRequestParamMap

getValueMap

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

Specified by:

getValueMap in interface IRequestParamMap

getValueTrimmedMap

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

Specified by:

getValueTrimmedMap in interface IRequestParamMap

getMap

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

Description copied from interface: IRequestParamMap

Get a nested map for the specified path.

Specified by:

getMap in interface IRequestParamMap

Parameters:

aPath - The path to be resolved

Returns:

null if the path could not be resolved.

containsKey

public boolean containsKey(@Nullable
                           String sKey)

Description copied from interface: IRequestParamMap

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

Specified by:

containsKey in interface IRequestParamMap

Parameters:

sKey - The key to check.

Returns:

true if such a key is contained, false if not

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface com.helger.commons.lang.IHasSize

size

@Nonnegative
public int size()

Specified by:

size in interface com.helger.commons.lang.IHasSize

keySet

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

Specified by:

keySet in interface IRequestParamMap

Returns:

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

values

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

Specified by:

values in interface IRequestParamMap

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
public com.helger.commons.collection.impl.ICommonsOrderedMap<String,RequestParamMapItem> getAsObjectMap()

Specified by:

getAsObjectMap in interface IRequestParamMap

Returns:

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

getAsValueMap

@Nonnull
@ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getAsValueMap(@Nonnull
                                                                                                       Map<String,? extends RequestParamMapItem> aMap)

getAsValueMap

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

Specified by:

getAsValueMap in interface IRequestParamMap

Returns:

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

getAsValueTrimmedMap

@Nonnull
@ReturnsMutableCopy
public static com.helger.commons.collection.impl.ICommonsOrderedMap<String,String> getAsValueTrimmedMap(@Nonnull
                                                                                                              Map<String,? extends RequestParamMapItem> aMap)

getAsValueTrimmedMap

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

Specified by:

getAsValueTrimmedMap in interface IRequestParamMap

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
public static IRequestParamMap create(@Nonnull
                                      Map<String,Object> aAttrCont)

createFromRequest

@Nonnull
public static IRequestParamMap createFromRequest(@Nonnull
                                                 jakarta.servlet.http.HttpServletRequest aHttpRequest)

getFieldName

@Nonnull
@Nonempty
@Deprecated(forRemoval=false)
public static String getFieldName(@Nonnull @Nonempty
                                  String sBaseName)

Deprecated.

This method doesn't make sense but it should stay, so that it's easy to spot usage of this invalid method.

Parameters:

sBaseName - Base name

Returns:

Base name as is.

getFieldName

@Nonnull
@Nonempty
public static String getFieldName(@Nonnull @Nonempty
                                  String sBaseName,
                                  @Nullable
                                  String... aSuffixes)

getFieldName

@Nonnull
@Nonempty
public static String getFieldName(@Nonnull @Nonempty
                                  String sBaseName,
                                  @Nullable
                                  int... aSuffixes)

setSeparatorsToDefault

public static void setSeparatorsToDefault()

setSeparators

public static void setSeparators(char cOpen,
                                 char cClose)

Set the separator chars to use.

Parameters:

cOpen - Open char

cClose - Close char - must be different from open char!

setSeparators

public static void setSeparators(@Nonnull @Nonempty
                                 String sOpen,
                                 @Nonnull @Nonempty
                                 String sClose)

Set the separators to use.

Parameters:

sOpen - Open string. May neither be null nor empty.

sClose - Close string. May neither be null nor empty.

getOpenSeparator

@Nonnull
@Nonempty
public static String getOpenSeparator()

Returns:

The open char. By default this is "[". Never null nor empty.

See Also:

DEFAULT_OPEN

getCloseSeparator

@Nonnull
@Nonempty
public static String getCloseSeparator()

Returns:

The close char. By default this is "]". Never null nor empty.

See Also:

DEFAULT_CLOSE