com.lexmark.saperion.document

Enum LoadKindEnumeration

java.lang.Object

java.lang.Enum<LoadKindEnumeration>

com.lexmark.saperion.document.LoadKindEnumeration

All Implemented Interfaces:

Serializable, Comparable<LoadKindEnumeration>

public enum LoadKindEnumeration
extends Enum<LoadKindEnumeration>

This enumeration holds the different ways a document can be loaded.

Author:

jschwarz

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE This member indicates that documents should be loaded completely.
WITHOUT_CONTENT This member indicates that the content of the document - and its children - should be omitted.

Method Summary

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

COMPLETE

public static final LoadKindEnumeration COMPLETE

This member indicates that documents should be loaded completely.

WITHOUT_CONTENT

public static final LoadKindEnumeration WITHOUT_CONTENT

This member indicates that the content of the document - and its children - should be omitted.

Method Detail

values

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

Returns:

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

valueOf

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