com.groupdocs.search.options

Enum OutputFormat

java.lang.Object

java.lang.Enum<OutputFormat>

com.groupdocs.search.options.OutputFormat

All Implemented Interfaces:

Serializable, Comparable<OutputFormat>

public enum OutputFormat
extends Enum<OutputFormat>

The output format of a data.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Html The HTML format.
PlainText The plain text format.

Method Summary

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

Html

public static final OutputFormat Html

The HTML format.

PlainText

public static final OutputFormat PlainText

The plain text format.

Method Detail

valueOf

public static OutputFormat 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

values

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

Returns:

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