com.levigo.jadice.document.read

Enum ReaderListener.ReaderEvent.Type

java.lang.Object

java.lang.Enum<ReaderListener.ReaderEvent.Type>

com.levigo.jadice.document.read.ReaderListener.ReaderEvent.Type

All Implemented Interfaces:

Serializable, Comparable<ReaderListener.ReaderEvent.Type>

Enclosing class:

ReaderListener.ReaderEvent

public static enum ReaderListener.ReaderEvent.Type
extends Enum<ReaderListener.ReaderEvent.Type>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORMAT_READ_CANCELED Indicates that a read-process for some format stream has been canceled.
FORMAT_READ_COMPLETED Indicates that a read-process for some format stream has been completed.
FORMAT_READ_FAILED Indicates that a read-process for some format stream has failed.
FORMAT_READ_STARTED Indicates that a read-process for some format stream has been started.
PAGE_READ_COMPLETED Indicates that a read-process for a single page has been completed.
PAGE_READ_STARTED Indicates that a read-process for a single page has been started.
READ_CANCELED Indicates that a read-process has been canceled.
READ_COMPLETED Indicates that a read-process has been completed.

Method Summary

Modifier and Type	Method and Description
static ReaderListener.ReaderEvent.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReaderListener.ReaderEvent.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FORMAT_READ_STARTED

public static final ReaderListener.ReaderEvent.Type FORMAT_READ_STARTED

Indicates that a read-process for some format stream has been started.

PAGE_READ_STARTED

public static final ReaderListener.ReaderEvent.Type PAGE_READ_STARTED

Indicates that a read-process for a single page has been started.

PAGE_READ_COMPLETED

public static final ReaderListener.ReaderEvent.Type PAGE_READ_COMPLETED

Indicates that a read-process for a single page has been completed.

FORMAT_READ_CANCELED

public static final ReaderListener.ReaderEvent.Type FORMAT_READ_CANCELED

Indicates that a read-process for some format stream has been canceled.

FORMAT_READ_FAILED

public static final ReaderListener.ReaderEvent.Type FORMAT_READ_FAILED

Indicates that a read-process for some format stream has failed. The cause will be available via ReaderListener.ReaderEvent.getCause().

FORMAT_READ_COMPLETED

public static final ReaderListener.ReaderEvent.Type FORMAT_READ_COMPLETED

Indicates that a read-process for some format stream has been completed.

READ_COMPLETED

public static final ReaderListener.ReaderEvent.Type READ_COMPLETED

Indicates that a read-process has been completed. This event is issued in response to a call to Reader.complete(), if reading was not canceled.

READ_CANCELED

public static final ReaderListener.ReaderEvent.Type READ_CANCELED

Indicates that a read-process has been canceled. This event is issued in response to a call to Reader.complete(), if cancelation was requested.

Method Detail

values

public static ReaderListener.ReaderEvent.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ReaderListener.ReaderEvent.Type c : ReaderListener.ReaderEvent.Type.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ReaderListener.ReaderEvent.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null