com.deltaxml.ditamerge

Enum ThreeWayMerge.ResultFormat

java.lang.Object

java.lang.Enum<ThreeWayMerge.ResultFormat>

com.deltaxml.ditamerge.ThreeWayMerge.ResultFormat

All Implemented Interfaces:

Serializable, Comparable<ThreeWayMerge.ResultFormat>

Enclosing class:

ThreeWayMerge

public static enum ThreeWayMerge.ResultFormat
extends Enum<ThreeWayMerge.ResultFormat>

The various result formats for some of the result types produced by the three way merge. This enumeration controls how certain result types are represented. It is only applicable when the ThreeWayMerge.ThreeWayMergeResultType is either ThreeWayMerge.ThreeWayMergeResultType.TWO_WAY_RESULT or ThreeWayMerge.ThreeWayMergeResultType.RULE_PROCESSED_TWO_WAY_RESULT.

The release supports the track-change format used by the oXygenXML editor/author tools when used in author mode. Further editor support could in introduced in future releases.

See Also:

ThreeWayMerge.setResultFormat(ResultFormat), ThreeWayMerge.getResultFormat(), ThreeWayMerge.ThreeWayMergeResultType.TWO_WAY_RESULT, ThreeWayMerge.ThreeWayMergeResultType.RULE_PROCESSED_TWO_WAY_RESULT

Enum Constant Summary

Enum Constants

Enum Constant and Description
DITA_MARKUP This result format is a DITA document are marked up using DITA specific scheme.
OXYGEN_TRACK_CHANGES This result format is an XML file with processing instructions used in the accept/reject interface of the oXygen XML editor/author.
XML_DELTA This result format produces either a deltaV2 result or a simplified delta result.

Method Summary

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

XML_DELTA

public static final ThreeWayMerge.ResultFormat XML_DELTA

This result format produces either a deltaV2 result or a simplified delta result. These formats are XML files with additional elements and attributes used to describe the changes. These formats are described in detail in the product documentation.

OXYGEN_TRACK_CHANGES

public static final ThreeWayMerge.ResultFormat OXYGEN_TRACK_CHANGES

This result format is an XML file with processing instructions used in the accept/reject interface of the oXygen XML editor/author. This interface is also used by the editors track-change system. The format relies on XML Processing Instructions to describe the changes.

DITA_MARKUP

public static final ThreeWayMerge.ResultFormat DITA_MARKUP

This result format is a DITA document are marked up using DITA specific scheme. The DITA Markup output format uses rev and status attributes to identify change. These attributes can be added to many DITA elements. The rev attribute can take any value and the status attribute can take one of the following values: 'changed', 'new', 'deleted', 'unchanged'.

Method Detail

values

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

Returns:

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

valueOf

public static ThreeWayMerge.ResultFormat 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