com.exalead.pdoc.plugins

Enum DocumentPartTransformer.TransformKind

java.lang.Object

java.lang.Enum<DocumentPartTransformer.TransformKind>

com.exalead.pdoc.plugins.DocumentPartTransformer.TransformKind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocumentPartTransformer.TransformKind>

Enclosing interface:

DocumentPartTransformer

public static enum DocumentPartTransformer.TransformKind
extends java.lang.Enum<DocumentPartTransformer.TransformKind>

Kind of transformation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
display Display target: extract meta-data and content for display/presentation purpose.
extract Extraction target: extract meta-data and content for content analysis.

Method Summary

Modifier and Type	Method and Description
static DocumentPartTransformer.TransformKind	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DocumentPartTransformer.TransformKind[]	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

extract

public static final DocumentPartTransformer.TransformKind extract

Extraction target: extract meta-data and content for content analysis.

display

public static final DocumentPartTransformer.TransformKind display

Display target: extract meta-data and content for display/presentation purpose.

Method Detail

values

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

Returns:

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

valueOf

public static DocumentPartTransformer.TransformKind 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