com.atlassian.jira.issue.customfields.view

Class NullCustomFieldParams

java.lang.Object

com.atlassian.jira.issue.customfields.view.NullCustomFieldParams

All Implemented Interfaces:

CustomFieldParams, CollectionParams, FieldParams, FieldTransportParams

public class NullCustomFieldParams
extends Object
implements CustomFieldParams

Constructor Summary

Constructors

Constructor and Description
NullCustomFieldParams()

Method Summary

Modifier and Type	Method and Description
boolean	contains(String key, String value)
boolean	containsKey(String key)
Set<String>	getAllKeys()
Collection	getAllValues() Return all values of all keys, flattened into a single collection.
CustomField	getCustomField()
Object	getFirstValueForKey(String key)
Object	getFirstValueForNullKey()
Map	getKeysAndValues()
String	getQueryString()
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.
void	remove(String key)
void	setCustomField(CustomField customField)
void	transform(org.apache.commons.collections.Transformer transformer)
void	transformObjectsToStrings()
void	transformStringsToObjects()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NullCustomFieldParams

public NullCustomFieldParams()

Method Detail

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.

remove

public void remove(String key)

Specified by:

remove in interface CustomFieldParams

getAllKeys

public Set<String> getAllKeys()

Specified by:

getAllKeys in interface FieldParams

transformStringsToObjects

public void transformStringsToObjects()

Specified by:

transformStringsToObjects in interface CustomFieldParams

setCustomField

public void setCustomField(CustomField customField)

Specified by:

setCustomField in interface CustomFieldParams

getCustomField

public CustomField getCustomField()

Specified by:

getCustomField in interface CustomFieldParams

getValuesForKey

public Collection<String> getValuesForKey(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

Parameters:

key - that you want to search with.

Returns:

a collection of values OR null if nothing is found.

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

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

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface CustomFieldParams

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface FieldParams

contains

public boolean contains(String key,
                        String value)

Specified by:

contains in interface CustomFieldParams

transformObjectsToStrings

public void transformObjectsToStrings()

Specified by:

transformObjectsToStrings in interface CustomFieldParams

getFirstValueForNullKey

public Object getFirstValueForNullKey()

Specified by:

getFirstValueForNullKey in interface FieldTransportParams

getKeysAndValues

public Map getKeysAndValues()

Specified by:

getKeysAndValues in interface CustomFieldParams

Specified by:

getKeysAndValues in interface FieldParams

containsKey

public boolean containsKey(String key)

Specified by:

containsKey in interface FieldParams

getFirstValueForKey

public Object getFirstValueForKey(String key)

Specified by:

getFirstValueForKey in interface FieldTransportParams

transform

public void transform(org.apache.commons.collections.Transformer transformer)

Specified by:

transform in interface CustomFieldParams