com.atlassian.confluence.search.lucene.tasks

Class UnIndexSpaceIndexTask

java.lang.Object

com.atlassian.confluence.search.lucene.tasks.UnIndexSpaceIndexTask

All Implemented Interfaces:

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

public class UnIndexSpaceIndexTask
extends Object
implements ConfluenceIndexTask, HandleAware

Task to unindex a space.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnIndexSpaceIndexTask.SpaceKeyHandle The spaceKey is sufficient to serve as the handle for spaces stored in the index.

Constructor Summary

Constructors

Constructor and Description
UnIndexSpaceIndexTask(String spaceKey)

Method Summary

Modifier and Type	Method and 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.
com.atlassian.bonnie.Handle	getHandle()
int	hashCode()
void	perform(org.apache.lucene.index.IndexWriter writer)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnIndexSpaceIndexTask

public UnIndexSpaceIndexTask(String spaceKey)

Parameters:

spaceKey - the spaceKey for the space being unindexed

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(org.apache.lucene.index.IndexWriter writer)
             throws IOException

Specified by:

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

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 com.atlassian.bonnie.Handle getHandle()

Specified by:

getHandle in interface HandleAware

Returns:

the handle