com.xmlmind.xml.validate

Class DiagnosticImpl

java.lang.Object

com.xmlmind.xml.validate.DiagnosticImpl

All Implemented Interfaces:

Diagnostic

public final class DiagnosticImpl
extends Object
implements Diagnostic

Implementation of Diagnostic.

This class also has a number of helper functions (static methods) operating on Diagnostics of any kind such as format(com.xmlmind.xml.validate.Diagnostic[]).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiagnosticImpl.DiagnosticComparator Compares two diagnostics, first by the order of their elements, then by the severity of the diagnostic (most severe comes first), then by their messages.

Nested classes/interfaces inherited from interface com.xmlmind.xml.validate.Diagnostic

Diagnostic.Severity

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticImpl.DiagnosticComparator	compareDiagnostics A ready-to-use instance of DiagnosticComparator.
String	detailId Value returned by getDiagnosticDetailId().
Object[]	detailValues Value returned by getDiagnosticDetailValues().
Element	element Value returned by getDiagnosticMessage().
String	message Value returned by getDiagnosticMessage().
static DiagnosticImpl[]	NO_DIAGNOSTICS An empty array of DiagnosticImpl.
Diagnostic.Severity	severity Value returned by getDiagnosticSeverity().

Fields inherited from interface com.xmlmind.xml.validate.Diagnostic

BAD_ATTRIBUTE_NAME, BROKEN_IDREF, BROKEN_LINK, DUPLICATE_ANCHOR, DUPLICATE_ID, ORIGINAL_ANCHOR, ORIGINAL_ID

Constructor Summary

Constructors

Constructor and Description
DiagnosticImpl(Element element, String message, Diagnostic.Severity severity) Constructs a diagnostic containing specified information.
DiagnosticImpl(Element element, String message, Diagnostic.Severity severity, String detailId, Object detailValue) Constructs a diagnostic containing specified information.
DiagnosticImpl(Element element, String message, Diagnostic.Severity severity, String detailId, Object[] detailValues) Constructs a diagnostic containing specified information.

Method Summary

Modifier and Type	Method and Description
static boolean	equals(Diagnostic d1, Diagnostic d2) Tests specified diagnostics for equality.
static String	format(Diagnostic diagnostic) Returns the formatted error message corresponding to specified diagnostic.
static String	format(Diagnostic[] diagnostics) Returns a newline separated list of formatted error messages corresponding to specified diagnostics.
static void	format(Diagnostic diagnostic, StringBuilder buffer) Appends to specified buffer the formatted error message corresponding to specified diagnostic.
Element	getDiagnosedElement() Returns the element where this error was found.
String	getDiagnosticDetailId() Returns a string identifying extra information about this diagnostic.
Object[]	getDiagnosticDetailValues() Returns extra information about this diagnostic.
String	getDiagnosticMessage() Returns a message describing this error.
Diagnostic.Severity	getDiagnosticSeverity() Returns the severity of this error.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NO_DIAGNOSTICS

public static final DiagnosticImpl[] NO_DIAGNOSTICS

An empty array of DiagnosticImpl.

element

public final Element element

Value returned by getDiagnosticMessage().

message

public final String message

Value returned by getDiagnosticMessage().

severity

public final Diagnostic.Severity severity

Value returned by getDiagnosticSeverity().

detailId

public final String detailId

Value returned by getDiagnosticDetailId().

detailValues

public final Object[] detailValues

Value returned by getDiagnosticDetailValues().

compareDiagnostics

public static final DiagnosticImpl.DiagnosticComparator compareDiagnostics

A ready-to-use instance of DiagnosticComparator.

Constructor Detail

DiagnosticImpl

public DiagnosticImpl(Element element,
                      String message,
                      Diagnostic.Severity severity)

Constructs a diagnostic containing specified information.

DiagnosticImpl

public DiagnosticImpl(Element element,
                      String message,
                      Diagnostic.Severity severity,
                      String detailId,
                      Object detailValue)

Constructs a diagnostic containing specified information.

DiagnosticImpl

public DiagnosticImpl(Element element,
                      String message,
                      Diagnostic.Severity severity,
                      String detailId,
                      Object[] detailValues)

Constructs a diagnostic containing specified information.

Method Detail

getDiagnosedElement

public Element getDiagnosedElement()

Description copied from interface: Diagnostic

Returns the element where this error was found.

Specified by:

getDiagnosedElement in interface Diagnostic

getDiagnosticMessage

public String getDiagnosticMessage()

Description copied from interface: Diagnostic

Returns a message describing this error.

Specified by:

getDiagnosticMessage in interface Diagnostic

getDiagnosticSeverity

public Diagnostic.Severity getDiagnosticSeverity()

Description copied from interface: Diagnostic

Returns the severity of this error.

Specified by:

getDiagnosticSeverity in interface Diagnostic

getDiagnosticDetailId

public String getDiagnosticDetailId()

Description copied from interface: Diagnostic

Returns a string identifying extra information about this diagnostic. Returns null if no extra information about this diagnostic is available.

Important: the returned string is tested against known detail identifiers using == and not using equals.

Specified by:

getDiagnosticDetailId in interface Diagnostic

See Also:

Diagnostic.getDiagnosticDetailValues(), Diagnostic.BROKEN_IDREF, Diagnostic.DUPLICATE_ID, Diagnostic.ORIGINAL_ID

getDiagnosticDetailValues

public Object[] getDiagnosticDetailValues()

Description copied from interface: Diagnostic

Returns extra information about this diagnostic. Returns null if no extra information about this diagnostic is available.

Specified by:

getDiagnosticDetailValues in interface Diagnostic

See Also:

Diagnostic.getDiagnosticDetailId()

format

public static String format(Diagnostic[] diagnostics)

Returns a newline separated list of formatted error messages corresponding to specified diagnostics.

format

public static String format(Diagnostic diagnostic)

Returns the formatted error message corresponding to specified diagnostic.

format

public static void format(Diagnostic diagnostic,
                          StringBuilder buffer)

Appends to specified buffer the formatted error message corresponding to specified diagnostic.

equals

public static final boolean equals(Diagnostic d1,
                                   Diagnostic d2)

Tests specified diagnostics for equality.