com.atlassian.bamboo.collections
Interface ActionParametersMap

All Superinterfaces:

Map<String,Object>

All Known Implementing Classes:

ActionParametersMapImpl, SimpleActionParametersMap

public interface ActionParametersMap
extends Map<String,Object>

Nested Class Summary

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

Map.Entry<K,V>

Method Summary

boolean	getBoolean(String key) Returns a boolean value from the map of parameters.
double	getDouble(String key, double defaultValue) Retrieve Double value from the map of parameters.
Map<String,File>	getFiles() Returns map of Files uploaded to this form.
int	getInt(String key, int defaultValue) Retrieve Integer value from the map of parameters.
long	getLong(String key, long defaultValue) Retrieve Long value from the map of parameters.
Map<String,Object>	getParameters() Returns internal map of parameters.
String	getString(String key) Returns a String value from the map of parameters.
String	getString(String key, String defaultString) Returns a String value from the map of parmeters.
String[]	getStringArray(String key) Returns a String[] value from the map of parameters.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

getString

@Nullable
String getString(@Nullable
                          String key)

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

Parameters:

key - Key of value to be searched in the map

Returns:

String value of object found or null if not found

getString

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

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.

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

getStringArray

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

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

Parameters:

key - Key of value to be searched in the map

Returns:

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

getInt

int getInt(@Nullable
           String key,
           int defaultValue)

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.

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

long getLong(@Nullable
             String key,
             long defaultValue)

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.

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

getDouble

double getDouble(@Nullable
                 String key,
                 double defaultValue)

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.

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

getBoolean

boolean getBoolean(@Nullable
                   String key)

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

Parameters:

key - Key of value to be searched in the map

Returns:

True if the value converted to true or false otherwise

getFiles

@NotNull
Map<String,File> getFiles()

Returns map of Files uploaded to this form.

Returns:

Map of Files uploaded to this form

getParameters

Map<String,Object> getParameters()

Returns internal map of parameters.

Returns:

Parameters map