org.apache.daffodil.japi

Class Diagnostic

java.lang.Object

org.apache.daffodil.japi.Diagnostic

public class Diagnostic
extends java.lang.Object

Class containing diagnostic information

Constructor Summary

Constructors

Constructor and Description
Diagnostic(org.apache.daffodil.lib.api.Diagnostic d)

Method Summary

Modifier and Type	Method and Description
java.util.List<DataLocation>	getDataLocations() Get data location information relevant to this diagnostic object.
java.util.List<LocationInSchemaFile>	getLocationsInSchemaFiles() Get schema location information relevant to this diagnostic object.
java.lang.String	getMessage() Get all diagnostic information, including mode name, schema context, and data location
java.lang.String	getMessageOnly() Get only the message part of a diagnostic.
java.lang.String	getModeName() Get the diagnostic mode name
java.lang.Throwable	getSomeCause() Get the cause of that cause this diagnostic
java.lang.String	getSomeMessage() Get the message that caused this diagnostic
boolean	isError() Determine if a diagnostic object represents an error or something less serious.
java.lang.String	toString() Get a string containing the mode name, message, schema location, and data location combined into a single string

Methods inherited from class java.lang.Object

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

Constructor Detail

Diagnostic

public Diagnostic(org.apache.daffodil.lib.api.Diagnostic d)

Method Detail

getDataLocations

public java.util.List<DataLocation> getDataLocations()

Get data location information relevant to this diagnostic object.

For example, this might be a file name, and position within the file.

Returns:

list of DataLocation's related to this diagnostic

getLocationsInSchemaFiles

public java.util.List<LocationInSchemaFile> getLocationsInSchemaFiles()

Get schema location information relevant to this diagnostic object.

For example, this might be a file name of a schema, and position within the schema file.

Returns:

list of LocationInSchemaFile's related to this diagnostic.

getMessage

public java.lang.String getMessage()

Get all diagnostic information, including mode name, schema context, and data location

Future versions of Daffodil will change getMessage to return only the message portion of a diagnostic, matching the behavior of getMessageOnly--users should call toString() instead.

Returns:

diagnostic message in string form

getMessageOnly

public java.lang.String getMessageOnly()

Get only the message part of a diagnostic.

This does not include mode name, schema context, or data location information

Returns:

diagnostic message in string form

getModeName

public java.lang.String getModeName()

Get the diagnostic mode name

Returns:

diagnostic mode name in string form

getSomeCause

public java.lang.Throwable getSomeCause()

Get the cause of that cause this diagnostic

Returns:

the exception that caused the diagnostic

getSomeMessage

public java.lang.String getSomeMessage()

Get the message that caused this diagnostic

Returns:

the message that caused the diagnostic

isError

public boolean isError()

Determine if a diagnostic object represents an error or something less serious.

Returns:

true if it represents an error, false otherwise

toString

public java.lang.String toString()

Get a string containing the mode name, message, schema location, and data location combined into a single string

Overrides:

toString in class java.lang.Object

Returns:

all diagnostic information as a string