Package com.deltaxml.dita.config

Enum Class ShowNonPhraseChanges

java.lang.Object

java.lang.Enum<ShowNonPhraseChanges>

com.deltaxml.dita.config.ShowNonPhraseChanges

All Implemented Interfaces:

com.deltaxml.dita.DitaCompareDisplayable, Serializable, Comparable<ShowNonPhraseChanges>, Constable

public enum ShowNonPhraseChanges
extends Enum<ShowNonPhraseChanges>
implements com.deltaxml.dita.DitaCompareDisplayable

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	Description
String	getDisplayDescription()	Returns the user-friendly String description of the ShowNonPhraseChanges.
String	getDisplayName()	Returns the user-friendly String name of the ShowNonPhraseChanges.
String	toString()	Returns a String representation of ShowNonPhraseChanges.
static ShowNonPhraseChanges	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ShowNonPhraseChanges[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static ShowNonPhraseChanges[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ShowNonPhraseChanges valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

Returns the user-friendly String name of the ShowNonPhraseChanges.

Specified by:

getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String representing the ShowNonPhraseChanges object

getDisplayDescription

public String getDisplayDescription()

Returns the user-friendly String description of the ShowNonPhraseChanges.

Specified by:

getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user-friendly String description representing the ShowNonPhraseChanges object

toString

public String toString()

Returns a String representation of ShowNonPhraseChanges.

Overrides:

toString in class Enum<ShowNonPhraseChanges>

Returns:

a String representing the ShowNonPhraseChanges object