Package com.norconex.committer.core3

Class DeleteRequest

java.lang.Object

com.norconex.committer.core3.DeleteRequest

All Implemented Interfaces:

ICommitterRequest

public class DeleteRequest
extends Object
implements ICommitterRequest

A committer deletion request. Metadata associated with a deletion request is typically minimal in comparison with an addition or update. It is even possible for it to be empty.

Since:

3.0.0

Author:

Pascal Essiembre

Constructor Summary

Constructors

Constructor	Description
DeleteRequest(String reference, Properties metadata)	Creates a deletion request.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
Properties	getMetadata()	Gets the metadata.
String	getReference()	Gets the document reference.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DeleteRequest

public DeleteRequest(String reference,
 Properties metadata)

Creates a deletion request.

Parameters:

reference - unique document reference

metadata - metadata associated with the deletion request

Method Details

getReference

public String getReference()

Description copied from interface: ICommitterRequest

Gets the document reference.

Specified by:

getReference in interface ICommitterRequest

Returns:

document reference

getMetadata

public Properties getMetadata()

Description copied from interface: ICommitterRequest

Gets the metadata.

Specified by:

getMetadata in interface ICommitterRequest

Returns:

metadata

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object