com.deltaxml.odf.merge
Enum EditOutput

java.lang.Object
  java.lang.Enum<EditOutput>
      com.deltaxml.odf.merge.EditOutput

All Implemented Interfaces:

Serializable, Comparable<EditOutput>

public enum EditOutput
extends Enum<EditOutput>

Enumeration representing the different options for outputting edit units in the ODT Merger

Enum Constant Summary

ALL
Output all edit units

MULTIPLE_ONLY
Output edit units only for merge units that have been changed by more than one editor

NONE
Output no edit units

Method Summary

static EditOutput	getEditOutput(String value) Returns an EditOutput object from the supplied String value if appropriate
String	toString() Returns a String representation of the EditOutput
static EditOutput	valueOf(String name) Returns the enum constant of this type with the specified name.
static EditOutput[]	values() Returns an array containing the constants of this enum type, in the order they're 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

ALL

public static final EditOutput ALL

Output all edit units

MULTIPLE_ONLY

public static final EditOutput MULTIPLE_ONLY

Output edit units only for merge units that have been changed by more than one editor

NONE

public static final EditOutput NONE

Output no edit units

Method Detail

values

public static final EditOutput[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(EditOutput c : EditOutput.values())
        System.out.println(c);

Returns:

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

valueOf

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

toString

public String toString()

Returns a String representation of the EditOutput

Overrides:

toString in class Enum<EditOutput>

Returns:

a String representing the EditOutput object

getEditOutput

public static EditOutput getEditOutput(String value)

Returns an EditOutput object from the supplied String value if appropriate

This method should not normally be necessary, enum values should be accessed directly. However, if you have a String representation of EditOutput, it may be a useful utility method.

Parameters:

value - the String representation of EditOutput

Returns:

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