PreservationProcessingMode

java.lang.Object
- java.lang.Enum<PreservationProcessingMode>
- - com.deltaxml.cores9api.config.PreservationProcessingMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PreservationProcessingMode>
```
public enum PreservationProcessingMode
extends java.lang.Enum<PreservationProcessingMode>
```
Represents the behaviour required when outputting preserved lexical items which have changed.

If Lexical Preservation is used to keep hold of items such as Doctype declarations, comments, processing instructions etc, you must choose whether or not to convert these items back from the XML encoded form into their original form in the result. If you wish to convert them back to their original form (i.e. not encoded in XML elements), you must decide which version of any changed items you are going to use. This enumeration stored the possible values to use when making these decisions.

Since:

7.0

Enum Constant Summary

Enum Constants
Enum Constant and Description
`A` Keep the A version.
`AB` Keep the A version if it exists, otherwise keep the B version.
`AdB` Same as `PreservationProcessingMode.A`, except when handling internal subset declarations which are treated as `PreservationProcessingMode.AB`.
`AUTOMATIC` Use the default ProcessingMode.
`B` Keep the B version.
`BA` Keep the B version if it exists, otherwise keep the A version.
`BdA` Same as `PreservationProcessingMode.B`, except when handling internal subset declarations which are treated as `PreservationProcessingMode.BA`.
`CHANGE` Do not process at this point.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PreservationProcessingMode`	`getProcessingMode(java.lang.String val)` Returns a ProcessingMode object from the supplied String value if appropriate.
`java.lang.String`	`toString()` The string representation of the enumerated type constants.
`static PreservationProcessingMode`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static PreservationProcessingMode[]`	`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
  - A
```
public static final PreservationProcessingMode A
```
    Keep the A version.
  - B
```
public static final PreservationProcessingMode B
```
    Keep the B version.
  - AB
```
public static final PreservationProcessingMode AB
```
    Keep the A version if it exists, otherwise keep the B version.
  - BA
```
public static final PreservationProcessingMode BA
```
    Keep the B version if it exists, otherwise keep the A version.
  - AdB
```
public static final PreservationProcessingMode AdB
```
    Same as PreservationProcessingMode.A, except when handling internal subset declarations which are treated as PreservationProcessingMode.AB.
  - BdA
```
public static final PreservationProcessingMode BdA
```
    Same as PreservationProcessingMode.B, except when handling internal subset declarations which are treated as PreservationProcessingMode.BA.
  - AUTOMATIC
```
public static final PreservationProcessingMode AUTOMATIC
```
    Use the default ProcessingMode.
  - CHANGE
```
public static final PreservationProcessingMode CHANGE
```
    Do not process at this point. If items have not been processed earlier in the pipeline then this effectively chooses to leave any changes present in the result in the encoded form.
- Method Detail
  - values
```
public static PreservationProcessingMode[] 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 (PreservationProcessingMode c : PreservationProcessingMode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PreservationProcessingMode 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 same as the enumerated types except for 'AUTOMATIC' and 'CHANGE' whose string representations are 'auto' and 'skip' respectively.
    
    Overrides:
    
    toString in class java.lang.Enum<PreservationProcessingMode>
    
    Returns:
    
    The string representation of the enumerated type constants.
  - getProcessingMode
```
public static PreservationProcessingMode getProcessingMode(java.lang.String val)
```
    Returns a ProcessingMode 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 ProcessingMode value or null for the default value
    
    Returns:
    
    the ProcessingMode instance corresponding to the parameter, or null if the value is invalid

Enum PreservationProcessingMode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

A

B

AB

BA

AdB

BdA

AUTOMATIC

CHANGE

Method Detail

values

valueOf

toString

getProcessingMode