@PublicApi public interface

IndexingCounter

com.atlassian.jira.util.index.IndexingCounter
Known Indirect Subclasses

@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

IndexingCounter provides access to a persistent 'count' of full re-indexes. This may be used by upgraded plugins to determine whether the index is up to date for whatever custom field changes they have made. For example, an upgrade task can record the current index value and a plugin can display a 're-index required' message until a full re-index has occurred and the value has changed.

Summary

Public Methods
long getCurrentValue()
This method returns the current re-indexing count.

Public Methods

public long getCurrentValue ()

This method returns the current re-indexing count.

Returns
  • the value of the most recent re-index run