com.atlassian.jira.issue.transport.impl
Class StringParamsImpl

java.lang.Object
  extended by com.atlassian.jira.issue.transport.impl.StringParamsImpl
All Implemented Interfaces:
CollectionParams, FieldParams, StringParams

public class StringParamsImpl
extends Object
implements StringParams


Field Summary
protected  Map<String,Collection<String>> params
           
 
Constructor Summary
StringParamsImpl()
           
StringParamsImpl(ActionParams actionParams)
           
StringParamsImpl(Map params)
           
 
Method Summary
 boolean containsKey(String key)
           
 Set getAllKeys()
           
 Collection getAllValues()
          Return all values of all keys, flattened into a single collection.
 String getFirstValueForKey(String key)
           
 String getFirstValueForNullKey()
           
 Map getKeysAndValues()
           
 Collection<String> getValuesForKey(String key)
          Return the values associated with the given key in the parameters.
 Collection getValuesForNullKey()
          Return the values of the custom field.
 boolean isEmpty()
           
 void put(String key, Collection<String> value)
          Put the values in.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

params

protected Map<String,Collection<String>> params
Constructor Detail

StringParamsImpl

public StringParamsImpl()

StringParamsImpl

public StringParamsImpl(Map params)

StringParamsImpl

public StringParamsImpl(ActionParams actionParams)
Method Detail

getAllKeys

public Set getAllKeys()
Specified by:
getAllKeys in interface FieldParams

getKeysAndValues

public Map getKeysAndValues()
Specified by:
getKeysAndValues in interface FieldParams

containsKey

public boolean containsKey(String key)
Specified by:
containsKey in interface FieldParams

isEmpty

public boolean isEmpty()
Specified by:
isEmpty in interface FieldParams

getAllValues

public Collection getAllValues()
Description copied from interface: CollectionParams
Return all values of all keys, flattened into a single collection. Use CollectionParams.getValuesForNullKey() instead if, for example, you just need the values of the custom field.

Specified by:
getAllValues in interface CollectionParams

getValuesForNullKey

public Collection getValuesForNullKey()
Description copied from interface: CollectionParams
Return the values of the custom field.

The values associated with the null key represents the values of the custom field. For example, the user selected in a single user picker, or the list of users selected in a multiple user picker.

Note that unlike CollectionParams.getAllValues(), this method does not return values associated with other non-null keys.

Specified by:
getValuesForNullKey in interface CollectionParams

getValuesForKey

public Collection<String> getValuesForKey(@Nullable
                                          String key)
Description copied from interface: CollectionParams
Return the values associated with the given key in the parameters.

Depending on the type of field, additional keys might be introduced in addition to the null key. JIRA might also add additional keys into the parameters. For example, issue id and project id might be passed into the parameters under separate keys during custom field validation.

Specified by:
getValuesForKey in interface CollectionParams

put

public void put(String key,
                Collection<String> value)
Description copied from interface: CollectionParams
Put the values in.

Specified by:
put in interface CollectionParams
Parameters:
key - for mapping
value - a Collection of Strings.

getFirstValueForNullKey

public String getFirstValueForNullKey()
Specified by:
getFirstValueForNullKey in interface StringParams

getFirstValueForKey

public String getFirstValueForKey(String key)
Specified by:
getFirstValueForKey in interface StringParams


Copyright © 2002-2014 Atlassian. All Rights Reserved.