Class/Object

org.apache.daffodil.processors.unparsers

UState

Related Docs: object UState | package unparsers

Permalink

abstract class UState extends ParseOrUnparseState with Cursor[InfosetAccessor] with ThrowsSDE with SavesErrorsAndWarnings

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

Instance Constructors

  1. new UState(dos: DirectOrBufferedDataOutputStream, vbox: VariableBox, diagnosticsArg: List[Diagnostic], dataProcArg: Maybe[DataProcessor], 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

Abstract Value Members

  1. abstract def advance: Boolean

    Permalink
    Definition Classes
    Cursor
  2. abstract def advanceAccessor: InfosetAccessor

    Permalink
    Definition Classes
    Cursor
  3. abstract def advanceOrError: InfosetAccessor

    Permalink
  4. abstract def allTerminatingMarkup: List[DFADelimiter]

    Permalink
  5. abstract def arrayIndexStack: MStackOfLong

    Permalink
  6. abstract def arrayPos: Long

    Permalink
    Definition Classes
    ParseOrUnparseStateStateForDebugger
  7. abstract def childIndexStack: MStackOfLong

    Permalink
  8. abstract def childPos: Long

    Permalink
    Definition Classes
    ParseOrUnparseStateStateForDebugger
  9. abstract def currentInfosetNode: DINode

    Permalink
  10. abstract def currentInfosetNodeMaybe: Maybe[DINode]

    Permalink
  11. abstract def currentInfosetNodeStack: MStackOfMaybe[DINode]

    Permalink
  12. abstract def escapeSchemeEVCache: MStackOfMaybe[EscapeSchemeUnparserHelper]

    Permalink
  13. abstract def fini: Unit

    Permalink
    Definition Classes
    Cursor
  14. abstract def groupIndexStack: MStackOfLong

    Permalink
  15. abstract def groupPos: Long

    Permalink
    Definition Classes
    ParseOrUnparseStateStateForDebugger
  16. abstract def inspect: Boolean

    Permalink
    Definition Classes
    Cursor
  17. abstract def inspectAccessor: InfosetAccessor

    Permalink
    Definition Classes
    Cursor
  18. abstract def inspectOrError: InfosetAccessor

    Permalink
  19. abstract def isInspectArrayEnd: Boolean

    Permalink
  20. abstract def localDelimiters: DelimiterStackUnparseNode

    Permalink
  21. abstract def moveOverOneArrayIndexOnly(): Unit

    Permalink
  22. abstract def moveOverOneElementChildOnly(): Unit

    Permalink
  23. abstract def moveOverOneGroupIndexOnly(): Unit

    Permalink
  24. abstract def occursBoundsStack: MStackOfLong

    Permalink
    Definition Classes
    ParseOrUnparseState
  25. abstract def popDelimiters(): Unit

    Permalink
  26. abstract def prior: UStateForSuspension

    Permalink
  27. abstract def pushDelimiters(node: DelimiterStackUnparseNode): Unit

    Permalink
  28. abstract def setVariables(newVariableMap: VariableMap): Unit

    Permalink
  29. abstract def withByteArrayOutputStream: LocalStack[(ByteArrayOutputStream, DirectOrBufferedDataOutputStream)]

    Permalink
  30. abstract def withUnparserDataInputStream: LocalStack[StringDataInputStreamForUnparse]

    Permalink

Concrete 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 addUnparseError(ue: UnparseError): Unit

    Permalink
  13. final def advanceMaybe: Maybe[InfosetAccessor]

    Permalink
    Definition Classes
    Cursor
  14. final def areLogging(lvl: Type): Boolean

    Permalink
    Definition Classes
    Logging
  15. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  16. final def binaryFloatRep: BinaryFloatRep

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

    Permalink
    Definition Classes
    UStateParseOrUnparseStateStateForDebugger
  18. final def bitLimit1b: MaybeULong

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

    Permalink
    Definition Classes
    ParseOrUnparseState
  21. def bitPos0b: Long

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  22. final def bitPos1b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  23. final def byteOrder: ByteOrder

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

    Permalink
    Definition Classes
    ParseOrUnparseStateStateForDebugger
  25. final def bytePos0b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  26. final def bytePos1b: Long

    Permalink
    Definition Classes
    ParseOrUnparseState
  27. def charPos: Long

    Permalink
  28. 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
  29. def clone(): AnyRef

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

    Permalink
    Definition Classes
    ParseOrUnparseState
  31. def currentLocation: DataLocation

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

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

    Permalink
  35. var dataProc: Maybe[DataProcessor]

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

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  37. final def decoder: BitsCharsetDecoder

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  38. var diagnostics: List[Diagnostic]

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  39. def discriminator: Boolean

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Logging
  56. def hasInfoset: Boolean

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

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

    Permalink
    Definition Classes
    UStateParseOrUnparseState
  59. final def inspectMaybe: Maybe[InfosetAccessor]

    Permalink
    Definition Classes
    Cursor
  60. final def isFixedWidthEncoding: Boolean

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

    Permalink
    Definition Classes
    Any
  62. final def jByteOrder: ByteOrder

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

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

    Permalink
    Definition Classes
    Logging
  65. lazy val logID: String

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

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

    Permalink
    Definition Classes
    Logging
  68. final def maybeCharWidthInBits: MaybeInt

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

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

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

    Permalink
    Definition Classes
    ParseOrUnparseState → FormatInfo
  72. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Definition Classes
    AnyRef
  76. 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
  77. final def processor: Processor

    Permalink
    Definition Classes
    SetProcessorMixin
  78. def processorStatus: ProcessorResult

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  79. final def replacingDecoder: BitsCharsetDecoder

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    ThrowsSDE
  89. def schemaFileLocation: SchemaFileLocation

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

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

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

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

    Permalink
    Definition Classes
    SetProcessorMixin
  94. 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
  95. 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
  96. def setVariableMap(newMap: VariableMap): Unit

    Permalink
    Definition Classes
    ParseOrUnparseState
  97. 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
  98. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  99. def thisElement: DIElement

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

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

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

    Permalink
    Definition Classes
    EncoderDecoderMixin
  103. val tunable: DaffodilTunables

    Permalink
    Definition Classes
    ParseOrUnparseState
  104. lazy val unparseResult: UnparseResult

    Permalink
  105. def validationError(msg: String, args: Any*): Unit

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

    Permalink
    Definition Classes
    ParseOrUnparseState
  107. def validationStatus: Boolean

    Permalink
    Definition Classes
    ParseOrUnparseStateState
  108. var variableBox: VariableBox

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

    Permalink

    Variable map provides access to variable bindings.

    Variable map provides access to variable bindings.

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Logging

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