@PublicApi public class

PhraseQuerySupportField

extends Object
java.lang.Object
   ↳ com.atlassian.jira.issue.index.indexers.phrase.PhraseQuerySupportField

@PublicApi

This class 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

Encapsulates the information to create a special purpose Field to be used for quoted phrase query searches for a given JIRA text field.

Summary

Public Constructors
PhraseQuerySupportField()
Public Methods
static String forIndexField(String indexFieldName)
Returns the name of the phrase query support field to build for a given field.
static boolean isPhraseQuerySupportField(String indexFieldName)
Determines whether a given document field is a phrase query support field.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public PhraseQuerySupportField ()

Public Methods

public static String forIndexField (String indexFieldName)

Returns the name of the phrase query support field to build for a given field.

Parameters
indexFieldName The name of the original field.
Returns
  • A String containing the name of the phrase query support field.

public static boolean isPhraseQuerySupportField (String indexFieldName)

Determines whether a given document field is a phrase query support field.

Parameters
indexFieldName the name of the field to inspect.
Returns
  • true if the passed in field is a phrase query support field; otherwise, false.