abstract class WithDiagnostics extends AnyRef
Abstract class that adds diagnostic information to classes that extend it.
When a function returns a class that extend this, one should call WithDiagnostics.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.
- Alphabetic
- By Inheritance
- WithDiagnostics
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getDiagnostics: Seq[Diagnostic]
Get the list of Diagnostic's created during the construction of the parent object
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 WithDiagnostics.isError is false.
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
isError(): Boolean
Determine if any errors occurred in the creation of the parent object.
Determine if any errors occurred in the creation of the parent object.
- returns
true if no errors occurred, false otherwise
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
Deprecated Value Members
-
def
canProceed(): Boolean
Determine if this object can be used in any future parse activities
Determine if this object can be used in any future parse activities
- returns
true it is safe to proceed, false otherwise
- Annotations
- @deprecated
- Deprecated
(Since version 2.0.0) Use !isError() to determine if it is safe to proceed
Apache Daffodil (incubating) Scala API
Packages
org.apache.daffodil.sapi - Provides the classes necessary to compile DFDL schemas, parse and unparse files using the compiled objects, and retrieve results and parsing diagnostics
org.apache.daffodil.sapi.logger - Provides the classes necessary to receive logging messages from Daffodil.
org.apache.daffodil.sapi.debugger - Provides the classes necessary to perform parse tracing or create a custom debugger