Summary: Methods | [Expand All]
@PublicSpi public interface

CustomFieldValueProvider

com.atlassian.jira.issue.customfields.CustomFieldValueProvider
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Provides access to custom field values for the purpose of rendering with custom field searchers.

Summary

Public Methods
Object getStringValue(CustomField customField, FieldValuesHolder fieldValuesHolder)
Provides a string value representation of the value specified for this searcher.
Object getValue(CustomField customField, FieldValuesHolder fieldValuesHolder)
Provides an object value representation of the value specified for this searcher.

Public Methods

public Object getStringValue (CustomField customField, FieldValuesHolder fieldValuesHolder)

Provides a string value representation of the value specified for this searcher. The result is used to populate the velocity context with the variable "value".

Parameters
customField the custom field that is using this searcher.
fieldValuesHolder contains values populated by the populate methods of the input transformer.
Returns
  • a string value representation of the value specified for this searcher.

public Object getValue (CustomField customField, FieldValuesHolder fieldValuesHolder)

Provides an object value representation of the value specified for this searcher. The result is used to populate the velocity context with the variable "valueObject".

Parameters
customField the custom field that is using this searcher.
fieldValuesHolder contains values populated by the populate methods of the input transformer.
Returns
  • an object value representation of the value specified for this searcher.