org.apache.jackrabbit.oak.plugins.index.fulltext

Enum ExtractedText.ExtractionResult

java.lang.Object

java.lang.Enum<ExtractedText.ExtractionResult>

org.apache.jackrabbit.oak.plugins.index.fulltext.ExtractedText.ExtractionResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ExtractedText.ExtractionResult>

Enclosing class:

ExtractedText

public static enum ExtractedText.ExtractionResult
extends java.lang.Enum<ExtractedText.ExtractionResult>

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMPTY Indicates that no text was extracted.
ERROR Indicates that text extraction resulted in an error.
SUCCESS Indicates that text extraction was successful and some text was extracted

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final ExtractedText.ExtractionResult SUCCESS

Indicates that text extraction was successful and some text was extracted

EMPTY

public static final ExtractedText.ExtractionResult EMPTY

Indicates that no text was extracted. This can happen if the mimeType for the binary is part of exclusion list

ERROR

public static final ExtractedText.ExtractionResult ERROR

Indicates that text extraction resulted in an error. The ExtractedText.getExtractedText() might contain more details

Method Detail

values

public static ExtractedText.ExtractionResult[] 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 (ExtractedText.ExtractionResult c : ExtractedText.ExtractionResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static ExtractedText.ExtractionResult valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null