Package com.atlassian.jira.index

Interface Index

All Known Implementing Classes:

DefaultIndex

public interface Index

An Index is where data is stored for fast retrieval. The Index itself has operations performed on it to update it. The index is held by a Index.Manager where you can access a searcher that reflects the latest update that has completed.

Note: in order to guarantee that an IndexSearcher returned from Index.Manager.openSearcher() contains a particular Index.Operation that is performed, the Index.Result must be waited on.

Since:

v4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Index.Manager	Management of an Index
static class	Index.Operation	An operation that is performed on an Index.
static interface	Index.Result	The payload is unimportant.
static enum	Index.UpdateMode

Method Summary

Modifier and Type	Method	Description
Index.Result	perform(Index.Operation operation)	Perform an Index.Operation on the index.

Method Details

perform

@Nonnull
Index.Result perform(@Nonnull
 Index.Operation operation)

Perform an Index.Operation on the index.

Parameters:

operation - the work to do.

Returns:

a Result object