com.atlassian.confluence.search.lucene.tasks
Class DeleteDocumentIndexTask

java.lang.Object
  com.atlassian.confluence.search.lucene.tasks.DeleteDocumentIndexTask

All Implemented Interfaces:

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

public class DeleteDocumentIndexTask
extends java.lang.Object
implements ConfluenceIndexTask, HandleAware

Index task that removes a searchable from the index.

Constructor Summary

DeleteDocumentIndexTask(com.atlassian.bonnie.Searchable target)

DeleteDocumentIndexTask(java.lang.String handle)

Method Summary

boolean	equals(java.lang.Object o)
java.lang.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)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteDocumentIndexTask

public DeleteDocumentIndexTask(java.lang.String handle)

DeleteDocumentIndexTask

public DeleteDocumentIndexTask(com.atlassian.bonnie.Searchable target)

Method Detail

getDescription

public java.lang.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 java.io.IOException

Specified by:

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

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getHandle

public com.atlassian.bonnie.Handle getHandle()

Specified by:

getHandle in interface HandleAware

Returns:

the handle

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object