Package org.exoplatform.documents.model

Enum Class DocumentTextContent.Status

java.lang.Object

java.lang.Enum<DocumentTextContent.Status>

org.exoplatform.documents.model.DocumentTextContent.Status

All Implemented Interfaces:

Serializable, Comparable<DocumentTextContent.Status>, Constable

Enclosing class:

DocumentTextContent

public static enum DocumentTextContent.Status
extends Enum<DocumentTextContent.Status>

Where the text of a file came from, or why there is none.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BUSY	Too many extractions were in progress to take this one: a later attempt may succeed.
EXTRACTED	Extracted from the file itself, the search index not holding it.
INDEXED	Read from the search index, which had already extracted it.
NO_TEXT	The file was read but holds no text, a scanned document for instance.
NOT_A_FILE	The document is not a file with a content, a folder for instance.
TIMED_OUT	The extraction took longer than allowed and was abandoned.
TOO_LARGE	The file is at least as large as the limit of what is extracted on the fly.
UNREADABLE	The file could not be read or parsed.
UNSUPPORTED_FORMAT	No text extractor handles the file's format.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INDEXED

public static final DocumentTextContent.Status INDEXED

Read from the search index, which had already extracted it.

EXTRACTED

public static final DocumentTextContent.Status EXTRACTED

Extracted from the file itself, the search index not holding it.

UNSUPPORTED_FORMAT

public static final DocumentTextContent.Status UNSUPPORTED_FORMAT

No text extractor handles the file's format.

TOO_LARGE

public static final DocumentTextContent.Status TOO_LARGE

The file is at least as large as the limit of what is extracted on the fly.

NO_TEXT

public static final DocumentTextContent.Status NO_TEXT

The file was read but holds no text, a scanned document for instance.

NOT_A_FILE

public static final DocumentTextContent.Status NOT_A_FILE

The document is not a file with a content, a folder for instance.

BUSY

public static final DocumentTextContent.Status BUSY

Too many extractions were in progress to take this one: a later attempt may succeed.

TIMED_OUT

public static final DocumentTextContent.Status TIMED_OUT

The extraction took longer than allowed and was abandoned.

UNREADABLE

public static final DocumentTextContent.Status UNREADABLE

The file could not be read or parsed.

Method Details

values

public static DocumentTextContent.Status[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DocumentTextContent.Status valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null