Package org.xwiki.diff.display

Enum UnifiedDiffElement.Type

java.lang.Object

java.lang.Enum<UnifiedDiffElement.Type>

org.xwiki.diff.display.UnifiedDiffElement.Type

All Implemented Interfaces:

Serializable, Comparable<UnifiedDiffElement.Type>

Enclosing class:

UnifiedDiffElement<E,F>

public static enum UnifiedDiffElement.Type
extends Enum<UnifiedDiffElement.Type>

The possible types of elements you can find within a unified diff.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ADDED	An element that was added.
CONTEXT	An element that was left unmodified.
DELETED	An element that was removed.

Method Summary

Modifier and Type	Method	Description
char	getSymbol()
static UnifiedDiffElement.Type	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UnifiedDiffElement.Type[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADDED

public static final UnifiedDiffElement.Type ADDED

An element that was added.

DELETED

public static final UnifiedDiffElement.Type DELETED

An element that was removed.

CONTEXT

public static final UnifiedDiffElement.Type CONTEXT

An element that was left unmodified. This type of elements show the context where a change was made.

Method Detail

values

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

Returns:

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

valueOf

public static UnifiedDiffElement.Type 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

getSymbol

public char getSymbol()

Returns:

the symbol associated with this element type