Package com.atlassian.bamboo.collections

Class SimpleActionParametersMap

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingMap<String,Object>

com.atlassian.bamboo.collections.SimpleActionParametersMap

All Implemented Interfaces:

ActionParametersMap, Map<String,Object>

Direct Known Subclasses:

ActionParametersMapImpl

public class SimpleActionParametersMap
extends com.google.common.collect.ForwardingMap<String,Object>
implements ActionParametersMap

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMap

com.google.common.collect.ForwardingMap.StandardEntrySet, com.google.common.collect.ForwardingMap.StandardKeySet, com.google.common.collect.ForwardingMap.StandardValues

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
SimpleActionParametersMap(Map<String,?> parameters)	Deprecated. since 6.0 use SimpleActionParametersMap(HttpParameters)
SimpleActionParametersMap(org.apache.struts2.dispatcher.HttpParameters parameters)

Method Summary

Modifier and Type	Method	Description
void	clear()
protected Map<String,Object>	delegate()
void	detachFromActionContext()	After you call this, changes will no longer propagate to the ActionContext.
boolean	getBoolean(@Nullable String key)	Returns a boolean value from the map of parameters.
double	getDouble(@Nullable String key, double defaultValue)	Retrieve Double value from the map of parameters.
@NotNull Map<String,File>	getFiles()	Returns map of Files uploaded to this form.
int	getInt(@Nullable String key, int defaultValue)	Retrieve Integer value from the map of parameters.
long	getLong(@Nullable String key, long defaultValue)	Retrieve Long value from the map of parameters.
Map<String,Object>	getParameters()	Returns internal map of parameters.
@Nullable String	getString(@Nullable String key)	Returns a String value from the map of parameters.
@NotNull String	getString(@Nullable String key, @NotNull String defaultString)	Returns a String value from the map of parmeters.
@Nullable String[]	getStringArray(@Nullable String key)	Returns a String[] value from the map of parameters.
Object	put(@NotNull String key, @NotNull Object value)
void	putAll(Map<? extends String,?> map)
Object	remove(Object object)

Methods inherited from class com.google.common.collect.ForwardingMap

containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString, values

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values

Constructor Detail

SimpleActionParametersMap

public SimpleActionParametersMap(org.apache.struts2.dispatcher.HttpParameters parameters)

SimpleActionParametersMap

@Deprecated
public SimpleActionParametersMap(Map<String,?> parameters)

Deprecated.

since 6.0 use SimpleActionParametersMap(HttpParameters)

Method Detail

getString

@NotNull
public @NotNull String getString(@Nullable
                                 @Nullable String key,
                                 @NotNull
                                 @NotNull String defaultString)

Description copied from interface: ActionParametersMap

Returns a String value from the map of parmeters. If the key does not exist in the map or the value is null then the defaultString is returned.

Specified by:

getString in interface ActionParametersMap

Parameters:

key - Key of value to be searched in the map

defaultString - the default string to return if the property does not exist in the map

Returns:

String value of object found or defaultString if not found

getString

@Nullable
public @Nullable String getString(@Nullable
                                  @Nullable String key)

Description copied from interface: ActionParametersMap

Returns a String value from the map of parameters. If the key does not exist in the map, then null is returned.

Specified by:

getString in interface ActionParametersMap

Parameters:

key - Key of value to be searched in the map

Returns:

String value of object found or null if not found

getStringArray

@Nullable
public @Nullable String[] getStringArray(@Nullable
                                         @Nullable String key)

Description copied from interface: ActionParametersMap

Returns a String[] value from the map of parameters. If the key does not exist in the map, then null is returned.

Specified by:

getStringArray in interface ActionParametersMap

Parameters:

key - Key of value to be searched in the map

Returns:

String[] value of object found or null if not found

getDouble

public double getDouble(@Nullable
                        @Nullable String key,
                        double defaultValue)

Description copied from interface: ActionParametersMap

Retrieve Double value from the map of parameters. If the key does not exist in the map, or is not convertible to Double then default value is returned.

Specified by:

getDouble in interface ActionParametersMap

Parameters:

key - Key of value to be searched in the map

defaultValue - Default value to be returned if key not found or not convertible to Double

Returns:

Value of object found or defaultValue if not convertible to Double or not found

getInt

public int getInt(@Nullable
                  @Nullable String key,
                  int defaultValue)

Description copied from interface: ActionParametersMap

Retrieve Integer value from the map of parameters. If the key does not exist in the map, or is not convertible to Integer then default value is returned.

Specified by:

getInt in interface ActionParametersMap

Parameters:

key - Key of value to be searched in the map

defaultValue - Default value to be returned if key not found or not convertible to Integer

Returns:

Value of object found or defaultValue if not convertible to Integer or not found

getLong

public long getLong(@Nullable
                    @Nullable String key,
                    long defaultValue)

Description copied from interface: ActionParametersMap

Retrieve Long value from the map of parameters. If the key does not exist in the map, or is not convertible to Long then default value is returned.

Specified by:

getLong in interface ActionParametersMap

Parameters:

key - Key of value to be searched in the map

defaultValue - Default value to be returned if key not found or not convertible to Long

Returns:

Value of object found or defaultValue if not convertible to Long or not found

getBoolean

public boolean getBoolean(@Nullable
                          @Nullable String key)

Description copied from interface: ActionParametersMap

Returns a boolean value from the map of parameters. If it does not exist in the map, then false is returned

Specified by:

getBoolean in interface ActionParametersMap

Parameters:

key - Key of value to be searched in the map

Returns:

True if the value converted to true or false otherwise

getFiles

@NotNull
public @NotNull Map<String,File> getFiles()

Description copied from interface: ActionParametersMap

Returns map of Files uploaded to this form.

Specified by:

getFiles in interface ActionParametersMap

Returns:

Map of Files uploaded to this form

getParameters

public Map<String,Object> getParameters()

Description copied from interface: ActionParametersMap

Returns internal map of parameters.

Specified by:

getParameters in interface ActionParametersMap

Returns:

Parameters map

delegate

protected Map<String,Object> delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingMap<String,Object>

put

public Object put(@NotNull
                  @NotNull String key,
                  @NotNull
                  @NotNull Object value)

Specified by:

put in interface Map<String,Object>

Overrides:

put in class com.google.common.collect.ForwardingMap<String,Object>

clear

public void clear()

Specified by:

clear in interface Map<String,Object>

Overrides:

clear in class com.google.common.collect.ForwardingMap<String,Object>

remove

public Object remove(Object object)

Specified by:

remove in interface Map<String,Object>

Overrides:

remove in class com.google.common.collect.ForwardingMap<String,Object>

putAll

public void putAll(Map<? extends String,?> map)

Specified by:

putAll in interface Map<String,Object>

Overrides:

putAll in class com.google.common.collect.ForwardingMap<String,Object>

detachFromActionContext

public void detachFromActionContext()

After you call this, changes will no longer propagate to the ActionContext.