t

org.apache.daffodil.io

FormatInfo

trait FormatInfo extends AnyRef

Abstract interface to obtain format properties or values derived from properties.

This includes anything the I/O layer needs, which includes properties that can be runtime-valued expressions, or that depend on such.

By passing in an object that provides quick access to these, we avoid the need to have setters/getters that call setters that change state in the I/O layer.

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

Abstract Value Members

  1. abstract def binaryFloatRep: BinaryFloatRep

    Returns the BinaryFloatRep

  2. abstract def bitOrder: BitOrder

    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.

  3. abstract def byteOrder: ByteOrder

    Returns ByteOrder

  4. abstract def decoder: BitsCharsetDecoder

    Returns a charset decoder for this encoding

  5. abstract def encoder: BitsCharsetEncoder

    Returns a charset encoder for this encoding configured for the dfdl:encodingErrorPolicy.

    Returns a charset encoder for this encoding configured for the dfdl:encodingErrorPolicy. This is the same as either the reportingEncoder or the replacingEncoder.

  6. abstract def encodingErrorPolicy: EncodingErrorPolicy

    Provides the dfdl:encodingErrorPolicy as an EncodingErrorPolicy enum.

  7. abstract def encodingMandatoryAlignmentInBits: Int

    Returns 8 if the dfdl:encoding is given by a runtime-valued expression.

    Returns 8 if the dfdl:encoding is given by a runtime-valued expression. Returns 8 for all ICU-based encodings. Returns 1 to 7 (inclusive) for encodings 1 to 7 bits wide respectively.

  8. abstract def fillByte: Byte

    Returns the fillByte value.

    Returns the fillByte value.

    Note: This has to be obtained from the FormatInfo because the dfdl:fillByte property can be specified as a character, which depends then on the dfdl:encoding which can be computed via a runtime expression.

  9. abstract def maybeCharWidthInBits: MaybeInt

    Returns MaybeInt.Nope for variable-width encodings or no encoding defined.

    Returns MaybeInt.Nope for variable-width encodings or no encoding defined. Returns MaybeInt(n) for fixed width encodings.

  10. abstract def maybeUTF16Width: Maybe[UTF16Width]

    Returns Nope if dfdl:utf16Width is not defined.

    Returns Nope if dfdl:utf16Width is not defined. Returns One(w: UTF16Width) if it is defined.

  11. abstract def regexMatchBitPositionBuffer: LongBuffer
  12. abstract def regexMatchBuffer: CharBuffer

    Buffers used for regex matching

  13. abstract def tunable: DaffodilTunables

    Provides tunable values

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isFixedWidthEncoding: Boolean

    Returns true if encoding is fixed width meaning has the same number of bits in each character representation.

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped