com.deltaxml.dita

Enum ShowNonPhraseChanges

java.lang.Object

java.lang.Enum<ShowNonPhraseChanges>

com.deltaxml.dita.ShowNonPhraseChanges

All Implemented Interfaces:

DitaCompareDisplayable, java.io.Serializable, java.lang.Comparable<ShowNonPhraseChanges>

public enum ShowNonPhraseChanges
extends java.lang.Enum<ShowNonPhraseChanges>
implements DitaCompareDisplayable

Enumeration representing how to show changes in elements where phrase would be invalid DITA.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS If set to 'always' always wrap in the element set from 'phrase-element-name', defaulting to <ph>.
NEVER If set to 'never' do not show change where a phrase element is not valid.
WHERE_VALID If set to 'where-valid', uses -[[old-text]]- +[[new-text]]+ delimiters to show change where <ph> is not valid.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayDescription() Returns the user friendly String description of the ShowNonPhraseChanges.
java.lang.String	getDisplayName() Returns the user friendly String name of the ShowNonPhraseChanges.
static ShowNonPhraseChanges	getShowNonPhraseChanges(java.lang.String value) Returns a ShowNonPhraseChanges object from the supplied String value if appropriate.
static ShowNonPhraseChanges	parseValue(java.lang.String value) Returns a ShowNonPhraseChanges object from the supplied String value if appropriate.
java.lang.String	toString() Returns a String representation of ShowNonPhraseChanges.
static ShowNonPhraseChanges	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ShowNonPhraseChanges[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WHERE_VALID

public static final ShowNonPhraseChanges WHERE_VALID

If set to 'where-valid', uses -[[old-text]]- +[[new-text]]+ delimiters to show change where <ph> is not valid. Note that although <ph> is the default setting for 'phrase-element-name', a different element such as <text> can be set.

ALWAYS

public static final ShowNonPhraseChanges ALWAYS

If set to 'always' always wrap in the element set from 'phrase-element-name', defaulting to <ph>.

NEVER

public static final ShowNonPhraseChanges NEVER

If set to 'never' do not show change where a phrase element is not valid.

Method Detail

values

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

Returns:

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

valueOf

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

getDisplayName

public java.lang.String getDisplayName()

Returns the user friendly String name of the ShowNonPhraseChanges.

Specified by:

getDisplayName in interface DitaCompareDisplayable

Returns:

a user friendly String representing the ShowNonPhraseChanges object

getDisplayDescription

public java.lang.String getDisplayDescription()

Returns the user friendly String description of the ShowNonPhraseChanges.

Specified by:

getDisplayDescription in interface DitaCompareDisplayable

Returns:

a user friendly String description representing the ShowNonPhraseChanges object

toString

public java.lang.String toString()

Returns a String representation of ShowNonPhraseChanges.

Overrides:

toString in class java.lang.Enum<ShowNonPhraseChanges>

Returns:

a String representing the ShowNonPhraseChanges object

getShowNonPhraseChanges

public static ShowNonPhraseChanges getShowNonPhraseChanges(java.lang.String value)

Returns a ShowNonPhraseChanges 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:

value - a String representation of a ShowNonPhraseChanges value

Returns:

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

parseValue

public static ShowNonPhraseChanges parseValue(java.lang.String value)
                                       throws java.lang.IllegalArgumentException

Returns a ShowNonPhraseChanges 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:

value - a String representation of a ShowNonPhraseChanges value

Returns:

the ShowNonPhraseChanges instance corresponding to the parameter.

Throws:

java.lang.IllegalArgumentException - Whenever the provided string does not represent one of this enum's enumerated values.