Class

org.apache.daffodil.processors.unparsers

UStateMain

Related Doc: package unparsers

Permalink

final class UStateMain extends UState

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

Instance Constructors

  1. new UStateMain(inputter: InfosetInputter, vmap: VariableMap, diagnosticsArg: List[Diagnostic], dataProcArg: DataProcessor, dataOutputStream: DirectOrBufferedDataOutputStream, initialSuspendedExpressions: Queue[Suspension], tunable: DaffodilTunables)

    Permalink

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. def addSuspension(se: Suspension): Unit

    Permalink
  13. def addUnparseError(ue: UnparseError): Unit

    Permalink
    Definition Classes
    UState
  14. def advance: Boolean

    Permalink
    Definition Classes
    UStateMain → Cursor
  15. def advanceAccessor: InfosetAccessor

    Permalink
    Definition Classes
    UStateMain → Cursor
  16. final def advanceMaybe: Maybe[InfosetAccessor]

    Permalink
    Definition Classes
    Cursor
  17. def advanceOrError: InfosetAccessor

    Permalink
    Definition Classes
    UStateMainUState
  18. def allTerminatingMarkup: List[DFADelimiter]

    Permalink
    Definition Classes
    UStateMainUState
  19. final def areLogging(lvl: Type): Boolean

    Permalink
    Definition Classes
    Logging
  20. val arrayIndexStack: MStackOfLong

    Permalink
    Definition Classes
    UStateMainUState
  21. def arrayPos: Long

    Permalink
  22. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  23. final def binaryFloatRep: BinaryFloatRep

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

    Permalink
    Definition Classes
    UStateParseOrUnparseStateStateForDebugger
  25. final def bitLimit1b: MaybeULong

    Permalink
    Definition Classes
    ParseOrUnparseState
  26. 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
  27. final def bitPos: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  28. def bitPos0b: Long

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  29. final def bitPos1b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  30. final def byteOrder: ByteOrder

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

    Permalink
    Definition Classes
    ParseOrUnparseStateStateForDebugger
  32. final def bytePos0b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  33. final def bytePos1b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  34. def charPos: Long

    Permalink
    Definition Classes
    UState
  35. final def checkBitOrder(): Unit

    Permalink

    Checks for legal bitOrder change (byte boundary required), or splits the DOS so that the check will occur later when they are collapsed back together.

    Checks for legal bitOrder change (byte boundary required), or splits the DOS so that the check will occur later when they are collapsed back together.

    If you think about it, the only way we could not have the absoluteBitPos is because something variable-length preceded us, and couldn't be computed due to suspended computation (forward referencing expression somewhere prior).

    At some point, that suspension will get resolved, and forward collapsing of the DataOutputStreams will occur. When it encounters a split created here, we already know that the bit orders are different (or we wouldn't have put in the split), so we just have to see if we're on a byte boundary. That could happen if the original DOS ended in a frag byte, but previous to it, was something that was variable bits wide (all bits shift such that original DOS's frag byte becomes a whole byte.)

    The invariant here is that the original DOS will get collapsed together with DOS preceding it. After that collapsing, it has to end at a byte boundary (no frag byte). If it doesn't then it's a bit order-change error. Otherwise we're ok.

    This is why we can always proceed with a new buffered DOS, knowing we're going to be on a byte boundary with the bit order needed.

    Attributes
    protected
    Definition Classes
    UStateParseOrUnparseState
  36. val childIndexStack: MStackOfLong

    Permalink
    Definition Classes
    UStateMainUState
  37. def childPos: Long

    Permalink
  38. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. def cloneForSuspension(suspendedDOS: DirectOrBufferedDataOutputStream): UState

    Permalink
  40. def copyStateForDebugger: TupleForDebugger

    Permalink
    Definition Classes
    ParseOrUnparseState
  41. def currentInfosetNode: DINode

    Permalink
    Definition Classes
    UStateMainUState
  42. def currentInfosetNodeMaybe: Maybe[DINode]

    Permalink
    Definition Classes
    UStateMainUState
  43. val currentInfosetNodeStack: MStackOfMaybe[DINode]

    Permalink
    Definition Classes
    UStateMainUState
  44. def currentLocation: DataLocation

    Permalink
    Definition Classes
    UStateStateForDebuggerState
  45. def currentNode: Maybe[DINode]

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  46. 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
  47. var dataOutputStream: DirectOrBufferedDataOutputStream

    Permalink
    Definition Classes
    UState
  48. var dataProc: Maybe[DataProcessor]

    Permalink
    Definition Classes
    ParseOrUnparseState
  49. def dataStream: Maybe[DirectOrBufferedDataOutputStream]

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  50. final def decoder: BitsCharsetDecoder

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  51. val delimiterStack: MStackOf[DelimiterStackUnparseNode]

    Permalink
  52. var diagnostics: List[Diagnostic]

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  53. def discriminator: Boolean

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  60. lazy val escapeSchemeEVCache: MStackOfMaybe[EscapeSchemeUnparserHelper]

    Permalink
    Definition Classes
    UStateMainUState
  61. def evalSuspensions(ustate: UState): Unit

    Permalink
  62. final def fillByte: Byte

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  64. def fini: Unit

    Permalink
    Definition Classes
    UStateMain → Cursor
  65. final def getClass(): Class[_]

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  73. val groupIndexStack: MStackOfLong

    Permalink
    Definition Classes
    UStateMainUState
  74. def groupPos: Long

    Permalink
  75. def hasInfoset: Boolean

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  76. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  77. def infoset: DIElement

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  78. def inspect: Boolean

    Permalink
    Definition Classes
    UStateMain → Cursor
  79. def inspectAccessor: InfosetAccessor

    Permalink
    Definition Classes
    UStateMain → Cursor
  80. final def inspectMaybe: Maybe[InfosetAccessor]

    Permalink
    Definition Classes
    Cursor
  81. def inspectOrError: InfosetAccessor

    Permalink

    Use this so if there isn't an event we get a clean diagnostic message saying that is what has gone wrong.

    Use this so if there isn't an event we get a clean diagnostic message saying that is what has gone wrong.

    Definition Classes
    UStateMainUState
  82. final def isFixedWidthEncoding: Boolean

    Permalink
    Definition Classes
    FormatInfo
  83. def isInspectArrayEnd: Boolean

    Permalink
    Definition Classes
    UStateMainUState
  84. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  85. final def jByteOrder: ByteOrder

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

    Permalink
    Definition Classes
    EncoderDecoderMixin
  87. def localDelimiters: DelimiterStackUnparseNode

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

    Permalink
    Definition Classes
    Logging
  89. lazy val logID: String

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

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

    Permalink
    Definition Classes
    Logging
  92. final def maybeCharWidthInBits: MaybeInt

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

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

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

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  96. def moveOverOneArrayIndexOnly(): Unit

    Permalink
    Definition Classes
    UStateMainUState
  97. def moveOverOneElementChildOnly(): Unit

    Permalink
    Definition Classes
    UStateMainUState
  98. def moveOverOneGroupIndexOnly(): Unit

    Permalink
    Definition Classes
    UStateMainUState
  99. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  103. 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
    UStateParseOrUnparseState
  104. val occursBoundsStack: MStackOfLong

    Permalink
    Definition Classes
    UStateMainParseOrUnparseState
  105. def popDelimiters(): Unit

    Permalink
    Definition Classes
    UStateMainUState
  106. def prior: UStateForSuspension

    Permalink
    Definition Classes
    UStateMainUState
  107. final def processor: Processor

    Permalink
    Definition Classes
    SetProcessorMixin
  108. def processorStatus: ProcessorResult

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  109. def pushDelimiters(node: DelimiterStackUnparseNode): Unit

    Permalink
    Definition Classes
    UStateMainUState
  110. final def replacingDecoder: BitsCharsetDecoder

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

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  112. 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
  113. final def schemaDefinitionError(str: String, args: Any*): Nothing

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  120. def schemaFileLocation: SchemaFileLocation

    Permalink
    Definition Classes
    ParseOrUnparseState → ThrowsSDE
  121. final def setFailed(failureDiagnostic: Diagnostic): Unit

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

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

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

    Permalink
    Definition Classes
    SetProcessorMixin
  125. 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
  126. 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
  127. def setVariableMap(newMap: VariableMap): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState
  128. def setVariables(newVariableMap: VariableMap): Unit

    Permalink
    Definition Classes
    UStateMainUState
  129. 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
  130. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  131. def thisElement: DIElement

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  132. def toString(): String

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

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

    Permalink
    Definition Classes
    EncoderDecoderMixin
  135. val tunable: DaffodilTunables

    Permalink
    Definition Classes
    ParseOrUnparseState
  136. lazy val unparseResult: UnparseResult

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

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

    Permalink
    Definition Classes
    ParseOrUnparseState
  139. def validationStatus: Boolean

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  140. var variableBox: VariableBox

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

    Permalink

    Variable map provides access to variable bindings.

    Variable map provides access to variable bindings.

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

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

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

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

    Permalink
    Definition Classes
    ParseOrUnparseState
  146. lazy val withByteArrayOutputStream: LocalStack[(ByteArrayOutputStream, DirectOrBufferedDataOutputStream)]

    Permalink
    Definition Classes
    UStateMainUState
  147. final lazy val withLocalByteBuffer: LocalStack[LocalByteBuffer]

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

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

    Permalink
    Definition Classes
    Logging
  150. lazy val withUnparserDataInputStream: LocalStack[StringDataInputStreamForUnparse]

    Permalink
    Definition Classes
    UStateMainUState

Inherited from UState

Inherited from Cursor[InfosetAccessor]

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