Package com.deltaxml.dita.config

Enum Class WarningReportMode

java.lang.Object

java.lang.Enum<WarningReportMode>

com.deltaxml.dita.config.WarningReportMode

All Implemented Interfaces:

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

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

An enum representing the warning report modes.

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
COMMENTS	Add the recoverable errors and warnings as comments.
DOCUMENT_MARKUP	Add the recoverable errors and warnings as document content.
MESSAGE	Report the recoverable errors and warnings as XSL messages, which are typically visible when the comparison is run from a command-line terminal.
PROCESSING_INSTRUCTIONS	Add the recoverable errors and warnings as processing instructions.

Method Summary

Modifier and Type	Method	Description
String	getDisplayDescription()	Returns the user friendly String description of the WarningReportMode.
String	getDisplayName()	Returns the user friendly String name of the WarningReportMode.
String	toString()	Returns a String representation of WarningReportMode.
static WarningReportMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WarningReportMode[]	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

MESSAGE

public static final WarningReportMode MESSAGE

Report the recoverable errors and warnings as XSL messages, which are typically visible when the comparison is run from a command-line terminal.

PROCESSING_INSTRUCTIONS

public static final WarningReportMode PROCESSING_INSTRUCTIONS

Add the recoverable errors and warnings as processing instructions.

COMMENTS

public static final WarningReportMode COMMENTS

Add the recoverable errors and warnings as comments.

DOCUMENT_MARKUP

public static final WarningReportMode DOCUMENT_MARKUP

Add the recoverable errors and warnings as document content.

Method Details

values

public static WarningReportMode[] 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 WarningReportMode 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 WarningReportMode.

Specified by:

getDisplayName in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user friendly String representing the WarningReportMode object

getDisplayDescription

public String getDisplayDescription()

Returns the user friendly String description of the WarningReportMode.

Specified by:

getDisplayDescription in interface com.deltaxml.dita.DitaCompareDisplayable

Returns:

a user friendly String description representing the WarningReportMode object

toString

public String toString()

Returns a String representation of WarningReportMode.

Overrides:

toString in class Enum<WarningReportMode>

Returns:

a String representing the WarningReportMode object