Package com.atlassian.confluence.internal.search.tasks

Class UpdateDocumentIndexTask

java.lang.Object

com.atlassian.confluence.internal.search.tasks.UpdateDocumentIndexTask

All Implemented Interfaces:

ConfluenceIndexTask, ConvertibleToJournalEntry, HandleAware, IndexTask

@LuceneIndependent
@Internal
public class UpdateDocumentIndexTask
extends Object
implements ConfluenceIndexTask, HandleAware

Constructor Summary

Constructors

Constructor	Description
UpdateDocumentIndexTask(Searchable searchable, IndexTaskFactoryInternal indexTaskFactory)
UpdateDocumentIndexTask(Searchable searchable, IndexTaskFactoryInternal indexTaskFactory, boolean includeDependents)

Method Summary

Modifier and Type	Method	Description
Optional<JournalEntry>	convertToJournalEntry(JournalIdentifier journalId)	Convert to journal entry.
boolean	equals(Object o)
String	getDescription()	A description of the task that can be presented to the user via the UI.
Handle	getHandle()
SearchIndex	getSearchIndex()
int	hashCode()
void	perform(SearchIndexWriter writer)	Executes this task against a document writer.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateDocumentIndexTask

public UpdateDocumentIndexTask(Searchable searchable,
                               IndexTaskFactoryInternal indexTaskFactory)

UpdateDocumentIndexTask

public UpdateDocumentIndexTask(Searchable searchable,
                               IndexTaskFactoryInternal indexTaskFactory,
                               boolean includeDependents)

Method Detail

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.

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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getHandle

public Handle getHandle()

Specified by:

getHandle in interface HandleAware

Returns:

the handle

toString

public String toString()

Overrides:

toString in class Object

getSearchIndex

public SearchIndex getSearchIndex()

Specified by:

getSearchIndex in interface ConfluenceIndexTask

Returns:

the SearchIndex that the task should write to