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, HandleAware, IndexTask, ConfluenceIndexTask

public class UnIndexSpaceIndexTask
extends Object
implements ConfluenceIndexTask, HandleAware

Task to unindex a space.

Nested Class Summary

static class

UnIndexSpaceIndexTask.SpaceKeyHandle The spaceKey is sufficient to serve as the handle for spaces stored in the index.

Constructor Summary

UnIndexSpaceIndexTask(String spaceKey)

Method Summary

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

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