org.apache.daffodil.japi

Class WithDiagnostics

java.lang.Object

org.apache.daffodil.japi.WithDiagnostics

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

DataProcessor, ParseResult, ProcessorFactory, UnparseResult

public abstract class WithDiagnostics
extends java.lang.Object
implements scala.Serializable

Abstract class that adds diagnostic information to classes that extend it.

When a function returns a class that extend this, one should call isError() on that class before performing any further actions. If an error exists, any use of that class, aside from those functions in WithDiagnostics, is invalid and will result in an Exception.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WithDiagnostics(org.apache.daffodil.lib.api.WithDiagnostics wd)

Method Summary

Modifier and Type	Method and Description
java.util.List<Diagnostic>	getDiagnostics() Get the list of Diagnostic's created during the construction of the parent object
boolean	isError() Determine if any errors occurred in the creation of the parent object.

Methods inherited from class java.lang.Object

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

Constructor Detail

WithDiagnostics

public WithDiagnostics(org.apache.daffodil.lib.api.WithDiagnostics wd)

Method Detail

getDiagnostics

public java.util.List<Diagnostic> getDiagnostics()

Get the list of Diagnostic's created during the construction of the parent object

Returns:

list of Diagnostic's. May contain errors or warnings, and so may be non-empty even if isError() is false.

isError

public boolean isError()

Determine if any errors occurred in the creation of the parent object.

Returns:

true if it represents an error, false otherwise