com.atlassian.bamboo.collections
Interface ActionParametersMap

All Superinterfaces:
java.util.Map<java.lang.String,java.lang.Object>
All Known Implementing Classes:
ActionParametersMapImpl

public interface ActionParametersMap
extends java.util.Map<java.lang.String,java.lang.Object>


Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Method Summary
 boolean getBoolean(java.lang.String key)
          Returns a boolean value from the map of parameters.
 double getDouble(java.lang.String key, double defaultValue)
          Retrieve Double value from the map of parameters.
 java.util.Map<java.lang.String,java.io.File> getFiles()
          Returns map of Files uploaded to this form.
 int getInt(java.lang.String key, int defaultValue)
          Retrieve Integer value from the map of parameters.
 long getLong(java.lang.String key, long defaultValue)
          Retrieve Long value from the map of parameters.
 java.util.Map<java.lang.String,java.lang.Object> getParameters()
          Returns internal map of parameters.
 java.lang.String getString(java.lang.String key)
          Returns a String value from the map of parameters.
 java.lang.String getString(java.lang.String key, java.lang.String defaultString)
          Returns a String value from the map of parmeters.
 java.lang.String[] getStringArray(java.lang.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
java.lang.String getString(@Nullable
                                    java.lang.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
java.lang.String getString(@Nullable
                                   java.lang.String key,
                                   @NotNull
                                   java.lang.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
java.lang.String[] getStringArray(@Nullable
                                           java.lang.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
           java.lang.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
             java.lang.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
                 java.lang.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
                   java.lang.String key)
Returns a boolean value from the map of parameters. If it does no 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
java.util.Map<java.lang.String,java.io.File> getFiles()
Returns map of Files uploaded to this form.

Returns:
Map of Files uploaded to this form

getParameters

java.util.Map<java.lang.String,java.lang.Object> getParameters()
Returns internal map of parameters.

Returns:
Parameters map


Copyright © 2010 Atlassian. All Rights Reserved.