@Immutable @PublicApi public class

IssueIndexingParams

extends Object
java.lang.Object
   ↳ com.atlassian.jira.issue.index.IssueIndexingParams

@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

Provides parameters required to conduct indexing or re-indexing JIRA issues.

  • indexIssues - true if issues should be indexed
  • indexComments - true if comments should be indexed
  • indexChangeHistory - true if change history should be indexed
  • indexWorklogs true if issue worklogs should be indexed
  • forceReloadFromDatabase - true if issues should be reloaded from the database before indexing
Clients should use the provided IssueIndexingParams.Builder to construct an instance of this class.

Summary

Nested Classes
class IssueIndexingParams.Builder  
Fields
public static IssueIndexingParams INDEX_ALL Sets all values to true.
public static IssueIndexingParams INDEX_ISSUE_ONLY Only index the core issue values, not comments, history etc.
public static IssueIndexingParams INDEX_NONE Sets all values to false.
Public Methods
static IssueIndexingParams.Builder builder(IssueIndexingParams issueIndexingParams)
Return a new builder with the values initially set to those specified by issueIndexingParams
static IssueIndexingParams.Builder builder()
boolean equals(Object o)
int getAffectedIndexCount()
Return the number of indexes that needs to be updated
int hashCode()
boolean isForceReloadFromDatabase()
boolean isIndex()
boolean isIndexAll()
boolean isIndexChangeHistory()
boolean isIndexComments()
boolean isIndexIssues()
boolean isIndexWorklogs()
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

public static IssueIndexingParams INDEX_ALL

Sets all values to true.

public static IssueIndexingParams INDEX_ISSUE_ONLY

Only index the core issue values, not comments, history etc. Issues will be reloaded from the database before indexing.

public static IssueIndexingParams INDEX_NONE

Sets all values to false.

Public Methods

public static IssueIndexingParams.Builder builder (IssueIndexingParams issueIndexingParams)

Return a new builder with the values initially set to those specified by issueIndexingParams

Parameters
issueIndexingParams The default values for new builder. Can not be null
Returns
  • New Builder

public static IssueIndexingParams.Builder builder ()

public boolean equals (Object o)

public int getAffectedIndexCount ()

Return the number of indexes that needs to be updated

Returns
  • number of indexes to be updated

public int hashCode ()

public boolean isForceReloadFromDatabase ()

Returns
  • True if the issues should be reloaded from the database before performing the actual index

public boolean isIndex ()

public boolean isIndexAll ()

public boolean isIndexChangeHistory ()

public boolean isIndexComments ()

public boolean isIndexIssues ()

public boolean isIndexWorklogs ()

public String toString ()