com.deltaxml.mergecommon.config

Enum FormattingOutputType

java.lang.Object

java.lang.Enum<FormattingOutputType>

com.deltaxml.mergecommon.config.FormattingOutputType

All Implemented Interfaces:

Serializable, Comparable<FormattingOutputType>

public enum FormattingOutputType
extends Enum<FormattingOutputType>

Values in this Enum control the method for representing or reconstructing Formatting Elements.

All elements marked with a deltaxml:format='true' attribute by a filter in the ExtensionPoint.PRE_FLATTENING extension point are processed as Formatting Elements.

Formatting Elements are XML elements whose primary purpose is to affect the rendering style of their text contents. Normally Formatting Elements occur as 'inline' elements, that is, children of 'block' elements that contain mixed-content (i.e. elements and text).

See Also:

MergeBase.setFormattingOutputType(FormattingOutputType)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTENT_GROUP Content Group Reconstruction - formatting elements are resolved and output using our "Content Group" format.
DELTA_V_2_1 Delta v2.1 Reconstruction - formatting elements are resolved and output using our Delta v2.1 format.
NON_OVERLAPPING_MILESTONES "Non-Overlapping" Milestones - the formatting element milestones have extra milestones inserted to allow well-nested reconstruction of 'fragmented' elements from the milestones, keeping information about overlaps.
OVERLAPPING_MILESTONES "Overlapping" Milestones - each milestone marks the start or end of each formatting element in the original input XML.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTENT_GROUP

public static final FormattingOutputType CONTENT_GROUP

Content Group Reconstruction - formatting elements are resolved and output using our "Content Group" format.

DELTA_V_2_1

public static final FormattingOutputType DELTA_V_2_1

Delta v2.1 Reconstruction - formatting elements are resolved and output using our Delta v2.1 format.

NON_OVERLAPPING_MILESTONES

public static final FormattingOutputType NON_OVERLAPPING_MILESTONES

"Non-Overlapping" Milestones - the formatting element milestones have extra milestones inserted to allow well-nested reconstruction of 'fragmented' elements from the milestones, keeping information about overlaps.

OVERLAPPING_MILESTONES

public static final FormattingOutputType OVERLAPPING_MILESTONES

"Overlapping" Milestones - each milestone marks the start or end of each formatting element in the original input XML. Milestone positions are optimised to prevent fragmentation solely due to differences in input document content.

Method Detail

values

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

Returns:

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

valueOf

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