com.atlassian.confluence.search.lucene.tasks

Class NoOpIndexTask

java.lang.Object

com.atlassian.confluence.search.lucene.tasks.NoOpIndexTask

All Implemented Interfaces:

com.atlassian.bonnie.ILuceneConnection.WriterAction, ConvertibleToJournalEntry, IndexTask, ConfluenceIndexTask

@LuceneIndependent
 @Internal
public class NoOpIndexTask
extends Object
implements ConfluenceIndexTask

Represents a no operation index task.

Method Summary

Modifier and Type	Method and Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId) Convert to journal entry.
static NoOpIndexTask	getChangeInstance()
static NoOpIndexTask	getContentInstance()
String	getDescription() A description of the task that can be presented to the user via the UI.
static NoOpIndexTask	getInstance() Deprecated. since 7.9. use getChangeInstance() or getContentInstance()
SearchIndex	getSearchIndex()
void	perform(org.apache.lucene.index.IndexWriter indexWriter)
void	perform(SearchIndexWriter writer) Executes this task against a document writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.search.lucene.tasks.ConfluenceIndexTask

getSearchIndexAccessor

Method Detail

getContentInstance

public static NoOpIndexTask getContentInstance()

getChangeInstance

public static NoOpIndexTask getChangeInstance()

getInstance

@Deprecated
public static NoOpIndexTask getInstance()

Deprecated. since 7.9. use getChangeInstance() or getContentInstance()

perform

public void perform(SearchIndexWriter writer)
             throws IOException

Description copied from interface: ConfluenceIndexTask

Executes this task against a document writer.

Specified by:

perform in interface ConfluenceIndexTask

Throws:

IOException

convertToJournalEntry

public Optional<JournalEntry> convertToJournalEntry(JournalIdentifier journalId)

Description copied from interface: ConvertibleToJournalEntry

Convert to journal entry.

Specified by:

convertToJournalEntry in interface ConvertibleToJournalEntry

Parameters:

journalId - journal identifier

Returns:

an optional containing a journal entry or empty if this cannot be converted.

getDescription

public String getDescription()

Description copied from interface: IndexTask

A description of the task that can be presented to the user via the UI.

Specified by:

getDescription in interface IndexTask

Returns:

an readable message.

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to

perform

public void perform(org.apache.lucene.index.IndexWriter indexWriter)
             throws IOException

Specified by:

perform in interface com.atlassian.bonnie.ILuceneConnection.WriterAction

Specified by:

perform in interface ConfluenceIndexTask

Throws:

IOException