com.deltaxml.cores9api.config

Enum PreservationOutputType

java.lang.Object

java.lang.Enum<PreservationOutputType>

com.deltaxml.cores9api.config.PreservationOutputType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PreservationOutputType>

public enum PreservationOutputType
extends java.lang.Enum<PreservationOutputType>

Used to specify how the lexically preserved items should be styled. Here, the two available styles are either 'normal' or 'encoded'. A third option of 'auto' enables the specified default style to be applied. Note that when 'auto' is selected for the default style then the default style is treated as 'normal'.

Since:

7.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTOMATIC The automatic mode specifies that the default encoding style should be used.
ENCODED The encoded preservation element should appear encoded in the output.
NORMAL The encoded preservation element should be decoded by the final output transformation (which is typically part of serialisation process).

Method Summary

Modifier and Type	Method and Description
static PreservationOutputType	getOutputType(java.lang.String val) Returns a OutputType object from the supplied String value if appropriate.
java.lang.String	toString() The string representation of the enumerated type constants.
static PreservationOutputType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PreservationOutputType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTOMATIC

public static final PreservationOutputType AUTOMATIC

The automatic mode specifies that the default encoding style should be used. In the case of the default encoding format the automatic behaviour is the same as the normal behaviour.

NORMAL

public static final PreservationOutputType NORMAL

The encoded preservation element should be decoded by the final output transformation (which is typically part of serialisation process).

ENCODED

public static final PreservationOutputType ENCODED

The encoded preservation element should appear encoded in the output.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

The string representation of the enumerated type constants. Here, the strings are the lower case versions of the enumerated constants, except for 'AUTOMATIC' whose string representation is 'auto'.

Overrides:

toString in class java.lang.Enum<PreservationOutputType>

Returns:

The string representation of the enumerated type constants.

getOutputType

public static PreservationOutputType getOutputType(java.lang.String val)

Returns a OutputType object from the supplied String value if appropriate.

This method should not be used under normal circumstances, enum instance values should be used instead.

Parameters:

val - a String representation of a OutputType value or null for the default value

Returns:

the OutputType instance corresponding to the parameter, or null if the value is invalid