com.atlassian.jira.issue.customfields.vdi

Interface NonNullCustomFieldProvider

All Known Implementing Classes:

DefaultNonNullCustomFieldProvider, NonNullCustomFieldProviderWithStats

@ExperimentalApi
public interface NonNullCustomFieldProvider

Provides a collection of nonnull custom fields of a given issue. The getIdentity() will be used for deduplication of a provider that have multiple instances (e.g. Spring Proxies around the core instance). See also IdentifiableComponent.

Since:

8.12

Method Summary

Modifier and Type	Method and Description
default Map<String,CustomFieldPrefetchedData>	getCustomFieldInfo(Issue issue) Deprecated. since 8.12, use getCustomFieldInfo(List issues) instead
default Map<Long,Map<String,CustomFieldPrefetchedData>>	getCustomFieldInfo(List<Issue> issues)
Object	getIdentity()

Method Detail

getCustomFieldInfo

@Deprecated
default Map<String,CustomFieldPrefetchedData> getCustomFieldInfo(Issue issue)

Deprecated. since 8.12, use getCustomFieldInfo(List issues) instead

Parameters:

issue - the id of the issue

Returns:

a map, where the keys are a collection of nonnull value custom field associated with the given issue and known to this provider and the nullable values are prefetched data objects passed on to the indexer of this custom field. See FieldIndexer.addIndex(Document, Issue, CustomFieldPrefetchedData)

getCustomFieldInfo

default Map<Long,Map<String,CustomFieldPrefetchedData>> getCustomFieldInfo(List<Issue> issues)

Parameters:

issues - list of the issues

Returns:

a map, where each issue is linked to a map, where the keys are a collection of nonnull value custom field associated with the given issue and known to this provider and the nullable values are prefetched data objects passed on to the indexer of this custom field. See FieldIndexer.addIndex(Document, Issue, CustomFieldPrefetchedData)

getIdentity

Object getIdentity()

Returns:

the identity of this provider. The identity will be used for equality check to ensure that any proxy of a provider will equal to it.