Package com.yahoo.docproc

Class DocumentProcessor.Progress

java.lang.Object

com.yahoo.docproc.DocumentProcessor.Progress

Direct Known Subclasses:

DocumentProcessor.LaterProgress

Enclosing class:

DocumentProcessor

public static class DocumentProcessor.Progress
extends Object

An enumeration of possible results of calling a process method

Field Summary

Fields

Modifier and Type	Field	Description
static final DocumentProcessor.Progress	DONE	Returned by a processor when it is done with a processing
static final DocumentProcessor.Progress	FAILED	Returned by a processor when a processing has failed and it should not be called again for this processing.
static final DocumentProcessor.Progress	LATER	Returned by a processor when it should be called again later for the same processing
static final DocumentProcessor.Progress	PERMANENT_FAILURE	Returned by a processor when processing has permanently failed, so that the document processing service should disable itself until reconfigured or restarted.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Progress(String name)
protected	Progress(String name, String reason)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
Optional<String>	getReason()
int	hashCode()
static DocumentProcessor.Progress	later(long delay)
String	toString()
DocumentProcessor.Progress	withReason(String reason)

Methods inherited from class java.lang.Object

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

Field Details

DONE

public static final DocumentProcessor.Progress DONE

Returned by a processor when it is done with a processing

LATER

public static final DocumentProcessor.Progress LATER

Returned by a processor when it should be called again later for the same processing

FAILED

public static final DocumentProcessor.Progress FAILED

Returned by a processor when a processing has failed and it should not be called again for this processing.

PERMANENT_FAILURE

public static final DocumentProcessor.Progress PERMANENT_FAILURE

Returned by a processor when processing has permanently failed, so that the document processing service should disable itself until reconfigured or restarted.

Constructor Details

Progress

protected Progress(String name)

Progress

protected Progress(String name,
 String reason)

Method Details

later

public static DocumentProcessor.Progress later(long delay)

withReason

public DocumentProcessor.Progress withReason(String reason)

toString

public String toString()

Overrides:

toString in class Object

getReason

public Optional<String> getReason()

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object