Package com.atlassian.jira.issue.transport

Interface CollectionParams

All Superinterfaces:

FieldParams

All Known Subinterfaces:

CustomFieldParams, FieldTransportParams, StringParams

All Known Implementing Classes:

CustomFieldAdditionalParamsImpl, CustomFieldParamsImpl, NullCustomFieldParams, StringParamsImpl

@PublicApi
public interface CollectionParams
extends FieldParams

This is a field params with Lists as the value

Method Summary

Modifier and Type	Method	Description
Collection	getAllValues()	Return all values of all keys, flattened into a single collection.
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.
void	put(String key, Collection<String> value)	Put the values in.

Methods inherited from interface com.atlassian.jira.issue.transport.FieldParams

containsKey, getAllKeys, getKeysAndValues, isEmpty

Method Details

getAllValues

Collection getAllValues()

Return all values of all keys, flattened into a single collection. Use getValuesForNullKey() instead if, for example, you just need the values of the custom field.

getValuesForNullKey

Collection getValuesForNullKey()

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 getAllValues(), this method does not return values associated with other non-null keys.

getValuesForKey

@Nullable
Collection<String> getValuesForKey(@Nullable
 String key)

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.

Parameters:

key - that you want to search with.

Returns:

a collection of values OR null if nothing is found.

put

void put(String key,
 Collection<String> value)

Put the values in.

Parameters:

key - for mapping

value - a Collection of Strings.