@PublicApi public interface

CollectionParams

implements FieldParams
com.atlassian.jira.issue.transport.CollectionParams
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

This is a field params with Lists as the value

Summary

Public Methods
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.
[Expand]
Inherited Methods
From interface com.atlassian.jira.issue.transport.FieldParams

Public Methods

public 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.

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

public 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.

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

Put the values in.

Parameters
key for mapping
value a Collection of Strings.