Class

edu.illinois.ncsa.daffodil.sapi

WithDiagnostics

Related Doc: package sapi

Permalink

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.

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WithDiagnostics
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def getDiagnostics: Seq[Diagnostic]

    Permalink

    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.

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. def isError(): Boolean

    Permalink

    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

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def canProceed(): Boolean

    Permalink

    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

Inherited from AnyRef

Inherited from Any

Ungrouped