Class/Object

org.apache.daffodil.processors.parsers

PState

Related Docs: object PState | package parsers

Permalink

final class PState extends ParseOrUnparseState

Linear Supertypes
ParseOrUnparseState, SetProcessorMixin, FormatInfo, Logging, Identity, EncoderDecoderMixin, LocalBufferMixin, SavesErrorsAndWarnings, ThrowsSDE, StateForDebugger, State, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PState
  2. ParseOrUnparseState
  3. SetProcessorMixin
  4. FormatInfo
  5. Logging
  6. Identity
  7. EncoderDecoderMixin
  8. LocalBufferMixin
  9. SavesErrorsAndWarnings
  10. ThrowsSDE
  11. StateForDebugger
  12. State
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class LocalByteBuffer extends LocalBuffer[ByteBuffer]

    Permalink
    Definition Classes
    LocalBufferMixin
  2. final class LocalCharBuffer extends LocalBuffer[CharBuffer]

    Permalink
    Definition Classes
    LocalBufferMixin

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. def SDE(str: String, args: Any*): Nothing

    Permalink
    Definition Classes
    ParseOrUnparseState → SavesErrorsAndWarnings → ThrowsSDE
  5. final def SDE(th: Throwable): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  6. def SDEButContinue(str: String, args: Any*): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState → SavesErrorsAndWarnings
  7. def SDW(warnID: WarnID, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState → SavesErrorsAndWarnings
  8. def SDW(str: String, args: Any*): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState
  9. def ThrowSDE: PartialFunction[Throwable, Nothing]

    Permalink
    Definition Classes
    ThrowsSDE
  10. var _processorStatus: ProcessorResult

    Permalink
    Attributes
    protected
    Definition Classes
    ParseOrUnparseState
  11. var _validationStatus: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    ParseOrUnparseState
  12. final def areLogging(lvl: Type): Boolean

    Permalink
    Definition Classes
    Logging
  13. def arrayPos: Long

    Permalink
    Definition Classes
    PStateParseOrUnparseStateStateForDebugger
  14. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  15. final def binaryFloatRep: BinaryFloatRep

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  16. def bitLimit0b: MaybeULong

    Permalink
    Definition Classes
    PStateParseOrUnparseStateStateForDebugger
  17. final def bitLimit1b: MaybeULong

    Permalink
    Definition Classes
    ParseOrUnparseState
  18. final def bitOrder: BitOrder

    Permalink

    Returns bit order.

    Returns bit order. If text, this is the bit order for the character set encoding. If binary, this is the bitOrder property value.

    Definition Classes
    ParseOrUnparseState → FormatInfo
  19. final def bitPos: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  20. def bitPos0b: Long

    Permalink
    Definition Classes
    PStateParseOrUnparseState
  21. final def bitPos1b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  22. final def byteOrder: ByteOrder

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  23. final def bytePos: Long

    Permalink
    Definition Classes
    ParseOrUnparseStateStateForDebugger
  24. final def bytePos0b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  25. final def bytePos1b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  26. final def checkBitOrder(): Unit

    Permalink

    Checks for bit order change.

    Checks for bit order change. If the bit order is changing, checks if we're on a proper byte boundary.

    Attributes
    protected
    Definition Classes
    PStateParseOrUnparseState
  27. def childPos: Long

    Permalink
    Definition Classes
    PStateParseOrUnparseStateStateForDebugger
  28. def clearDelimitedParseResult(): Unit

    Permalink
  29. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def complexElement: DIComplex

    Permalink
  31. def copyStateForDebugger: TupleForDebugger

    Permalink
    Definition Classes
    ParseOrUnparseState
  32. def currentLocation: DataLocation

    Permalink
    Definition Classes
    PStateStateForDebuggerState
  33. def currentNode: Maybe[DIElement]

    Permalink
    Definition Classes
    PStateParseOrUnparseState
  34. def dState: DState

    Permalink

    Used when evaluating expressions.

    Used when evaluating expressions. Holds state of expression during evaluation.

    Doesn't hold every bit of state - that is to say there's still the regular execution call stack, which keeps track of exactly where in the expression evaluation we are.

    Definition Classes
    ParseOrUnparseState
  35. var dataInputStream: ByteBufferDataInputStream

    Permalink
  36. var dataProc: Maybe[DataProcessor]

    Permalink
    Definition Classes
    ParseOrUnparseState
  37. def dataStream: Maybe[ByteBufferDataInputStream]

    Permalink
    Definition Classes
    PStateParseOrUnparseState
  38. final def decoder: BitsCharsetDecoder

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  39. var delimitedParseResult: Maybe[dfa.ParseResult]

    Permalink
  40. var diagnostics: List[Diagnostic]

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  41. def discard(m: Mark): Unit

    Permalink
  42. def discriminator: Boolean

    Permalink
    Definition Classes
    PStateStateForDebugger
  43. def doLogging(lvl: Type, msg: String, args: Seq[Any]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  44. final def encoder: BitsCharsetEncoder

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  45. final def encodingErrorPolicy: EncodingErrorPolicy

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  46. final def encodingMandatoryAlignmentInBits: Int

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  47. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  49. final def fillByte: Byte

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  50. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  52. def getContext(): ElementRuntimeData

    Permalink
    Definition Classes
    ParseOrUnparseState
  53. def getDecoder(charset: BitsCharset): BitsCharsetDecoder

    Permalink
    Definition Classes
    EncoderDecoderMixin
  54. def getDecoderInfo(charset: BitsCharset): DecoderInfo

    Permalink
    Definition Classes
    EncoderDecoderMixin
  55. def getEncoder(charset: BitsCharset): BitsCharsetEncoder

    Permalink
    Definition Classes
    EncoderDecoderMixin
  56. def getEncoderInfo(charset: BitsCharset): EncoderInfo

    Permalink
    Definition Classes
    EncoderDecoderMixin
  57. def getLogWriter(): LogWriter

    Permalink
    Definition Classes
    Logging
  58. final def getLoggingLevel(): Type

    Permalink
    Definition Classes
    Logging
  59. def groupPos: Long

    Permalink
    Definition Classes
    PStateParseOrUnparseStateStateForDebugger
  60. def hasInfoset: Boolean

    Permalink
    Definition Classes
    PStateParseOrUnparseState
  61. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  62. var infoset: DIElement

    Permalink
    Definition Classes
    PStateParseOrUnparseState
  63. final def isFixedWidthEncoding: Boolean

    Permalink
    Definition Classes
    FormatInfo
  64. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  65. final def jByteOrder: ByteOrder

    Permalink
    Definition Classes
    FormatInfo
  66. final def lengthInBits(str: String, bitsCharset: BitsCharset): Long

    Permalink
    Definition Classes
    EncoderDecoderMixin
  67. final macro def log(lvl: Type, msg: String, args: Any*): Unit

    Permalink
    Definition Classes
    Logging
  68. lazy val logID: String

    Permalink
    Definition Classes
    Logging → Identity
  69. var logLevel: Maybe[Type]

    Permalink
    Definition Classes
    Logging
  70. var logWriter: Maybe[LogWriter]

    Permalink
    Definition Classes
    Logging
  71. def mark(requestorID: String): Mark

    Permalink
  72. final def maybeCharWidthInBits: MaybeInt

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  73. def maybeERD: Maybe[ElementRuntimeData]

    Permalink
    Definition Classes
    ParseOrUnparseState
  74. final def maybeProcessor: Maybe[Processor]

    Permalink
    Definition Classes
    SetProcessorMixin
  75. final def maybeUTF16Width: Maybe[UTF16Width]

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  76. val mpstate: MPState

    Permalink
  77. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  78. final def notYetImplemented(msg: String, args: Any*): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  79. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  81. final def notifyDebugging(flag: Boolean): Unit

    Permalink

    The User API sets the debugger and debug on/off flag on the DataProcessor object.

    The User API sets the debugger and debug on/off flag on the DataProcessor object. When a PState or UState is created by the DataProcessor, the DataProcessor sets notifies the state object so that it can setup any debug-specific behaviors.

    Definition Classes
    PStateParseOrUnparseState
  82. def occursBoundsStack: MStackOfLong

    Permalink
    Definition Classes
    PStateParseOrUnparseState
  83. val output: InfosetOutputter

    Permalink
  84. def parentDocument: InfosetDocument

    Permalink
  85. def popDiscriminator: Unit

    Permalink
  86. final def processor: Processor

    Permalink
    Definition Classes
    SetProcessorMixin
  87. def processorStatus: ProcessorResult

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  88. def pushDiscriminator: Unit

    Permalink
  89. final def replacingDecoder: BitsCharsetDecoder

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  90. final def reportingDecoder: BitsCharsetDecoder

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  91. def reset(m: Mark): Unit

    Permalink
  92. final def resetFormatInfoCaches(): Unit

    Permalink

    Must call after all processors so as to recompute the formatInfo slots for the next parser - since the values could change.

    Must call after all processors so as to recompute the formatInfo slots for the next parser - since the values could change.

    Definition Classes
    ParseOrUnparseState
  93. def saveDelimitedParseResult(result: Maybe[dfa.ParseResult]): Unit

    Permalink
  94. final def schemaDefinitionError(str: String, args: Any*): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  95. def schemaDefinitionErrorButContinue(str: String, args: Any*): Unit

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  96. def schemaDefinitionErrorDueToPropertyValue(propertyName: String, propertyValue: String, propertyLocation: LookupLocation, otherPropertyLocation: LookupLocation, str: String, args: Any*): Nothing

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  97. final macro def schemaDefinitionUnless(testThatWillThrowIfFalse: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    ThrowsSDE
  98. macro def schemaDefinitionWarningUnless(warnID: WarnID, testThatWillWarnIfFalse: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  99. macro def schemaDefinitionWarningWhen(warnID: WarnID, testThatWillWarnIfTrue: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    SavesErrorsAndWarnings
  100. final macro def schemaDefinitionWhen(testThatWillThrowIfTrue: Boolean, str: String, args: Any*): Unit

    Permalink
    Definition Classes
    ThrowsSDE
  101. def schemaFileLocation: SchemaFileLocation

    Permalink
    Definition Classes
    ParseOrUnparseState → ThrowsSDE
  102. def setDiscriminator(disc: Boolean): Unit

    Permalink
  103. def setEndBitLimit(bitLimit0b: Long): Unit

    Permalink
  104. final def setFailed(failureDiagnostic: Diagnostic): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState
  105. def setLogWriter(lw: LogWriter): Unit

    Permalink
    Definition Classes
    Logging
  106. def setLoggingLevel(level: Type): Unit

    Permalink
    Definition Classes
    Logging
  107. final def setMaybeProcessor(mp: Maybe[Processor]): Unit

    Permalink
    Definition Classes
    SetProcessorMixin
  108. def setParent(newParent: DIElement): Unit

    Permalink

    This takes newParent as DIElement, not DIComplex, because there is code where we don't know whether the node is simple or complex but we set it as the parent anyway.

    This takes newParent as DIElement, not DIComplex, because there is code where we don't know whether the node is simple or complex but we set it as the parent anyway. If simple children will simply not be appended.

    But this invariant that there is always a parent we could append a child into is being maintained. THis invariant starts at the very top as there is a Document which is the parent of the root element. So there's no time when there isn't a parent there.

  109. final def setProcessor(p: Processor): Unit

    Permalink

    Must be called on the state before any call to the I/O layer, as that will call back to get property-related information and that has to be obtained via the runtime data for the term - whether element or model group.

    Must be called on the state before any call to the I/O layer, as that will call back to get property-related information and that has to be obtained via the runtime data for the term - whether element or model group. The

    Definition Classes
    SetProcessorMixin
  110. def setSuccess(): Unit

    Permalink

    Important: If an error is being suppressed, you must call this to reset the state back so that the prior failure doesn't "last forever" past the point where it is being suppressed.

    Important: If an error is being suppressed, you must call this to reset the state back so that the prior failure doesn't "last forever" past the point where it is being suppressed.

    This happens, for example, in the debugger when it is evaluating expressions.

    Definition Classes
    ParseOrUnparseState
  111. def setVariable(vrd: VariableRuntimeData, newValue: Any, referringContext: VariableRuntimeData, pstate: PState): Unit

    Permalink
  112. def setVariableMap(newMap: VariableMap): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState
  113. def simpleElement: DISimple

    Permalink
  114. final def suppressDiagnosticAndSucceed(d: Diagnostic): Unit

    Permalink

    Used when errors are caught by interactive debugger expression evaluation.

    Used when errors are caught by interactive debugger expression evaluation. We don't want to accumulate the diagnostics that we're suppressing.

    Definition Classes
    ParseOrUnparseState
  115. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  116. def thisElement: DIElement

    Permalink
    Definition Classes
    PStateParseOrUnparseState
  117. def toString(): String

    Permalink
    Definition Classes
    PState → AnyRef → Any
  118. final def toss(th: Throwable): Nothing

    Permalink
    Definition Classes
    ThrowsSDE
  119. final def truncateToBits(str: String, bitsCharset: BitsCharset, nBits: Long): String

    Permalink
    Definition Classes
    EncoderDecoderMixin
  120. val tunable: DaffodilTunables

    Permalink
    Definition Classes
    ParseOrUnparseState
  121. def validationError(msg: String, args: Any*): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState
  122. def validationErrorNoContext(cause: Throwable): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState
  123. def validationStatus: Boolean

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  124. var variableBox: VariableBox

    Permalink
    Attributes
    protected
    Definition Classes
    ParseOrUnparseState
  125. def variableMap: VariableMap

    Permalink

    Variable map provides access to variable bindings.

    Variable map provides access to variable bindings.

    Definition Classes
    ParseOrUnparseState
  126. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  129. final def whichBit0b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  130. final lazy val withLocalByteBuffer: LocalStack[LocalByteBuffer]

    Permalink
    Definition Classes
    LocalBufferMixin
  131. final lazy val withLocalCharBuffer: LocalStack[LocalCharBuffer]

    Permalink
    Definition Classes
    LocalBufferMixin
  132. macro def withLoggingLevel[S](newLevel: Type)(body: ⇒ S): Unit

    Permalink
    Definition Classes
    Logging

Inherited from ParseOrUnparseState

Inherited from SetProcessorMixin

Inherited from FormatInfo

Inherited from Logging

Inherited from Identity

Inherited from EncoderDecoderMixin

Inherited from LocalBufferMixin

Inherited from SavesErrorsAndWarnings

Inherited from ThrowsSDE

Inherited from StateForDebugger

Inherited from State

Inherited from AnyRef

Inherited from Any

Ungrouped