@PublicSpi @PublicApi public interface

CustomFieldSearcher

implements IssueSearcher<T extends SearchableField>
com.atlassian.jira.issue.customfields.CustomFieldSearcher
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).

@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

The custom field searcher interface defines an IssueSearcher that's usable by CustomField objects. Since JIRA 4.0, searchers have changed a lot with the introduction of JQL. For examples of usage you might want to check out AbstractInitializationCustomFieldSearcher and its inheritors.

Summary

[Expand]
Inherited Fields
From interface com.atlassian.jira.issue.search.searchers.IssueSearcher
Public Methods
CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler()
Provides an object that can be used to handle the clauses that this searcher generates.
CustomFieldSearcherModuleDescriptor getDescriptor()
void init(CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)
Initializes the searcher.
[Expand]
Inherited Methods
From interface com.atlassian.jira.issue.search.searchers.IssueSearcher

Public Methods

public CustomFieldSearcherClauseHandler getCustomFieldSearcherClauseHandler ()

Provides an object that can be used to handle the clauses that this searcher generates.

Returns
  • an object that can be used to handle the clauses that this searcher generates, can be null.

public CustomFieldSearcherModuleDescriptor getDescriptor ()

Returns
  • the module descriptor that defined this searcher.

public void init (CustomFieldSearcherModuleDescriptor customFieldSearcherModuleDescriptor)

Initializes the searcher. This is called the first time this searcher is retrieved from the plugin manager. You can expect that JIRA will be initialized when this method is invoked.

Parameters
customFieldSearcherModuleDescriptor the module descriptor that defines this searcher.