Class

org.apache.daffodil.processors.charset

NBitsWidth_BitsCharsetDecoder

Related Doc: package charset

Permalink

final class NBitsWidth_BitsCharsetDecoder extends BitsCharsetDecoder with NBitsWidth_BitsEncoderDecoderMixin

You have to initialize one of these for a specific ByteBuffer because the encoding is N-bits wide, so we need additional state beyond just the byte position and limit that a ByteBuffer provides in order to properly sequence through the data.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NBitsWidth_BitsCharsetDecoder
  2. NBitsWidth_BitsEncoderDecoderMixin
  3. BitsCharsetDecoder
  4. IsResetMixin
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new NBitsWidth_BitsCharsetDecoder(cs: NBitsWidth_BitsCharset)

    Permalink

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. object ProxyJavaCharset extends Charset

    Permalink

    Hyjack a JavaCharset to drive our code.

    Hyjack a JavaCharset to drive our code.

    We want to avoid re-implementing all the error handling and flush/end logic.

    Attributes
    protected
    Definition Classes
    NBitsWidth_BitsEncoderDecoderMixin
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def attemptToDecodeOneYesPriorYesSpaceNoData(in: ByteBuffer, out: CharBuffer): Maybe[CoderResult]

    Permalink
  7. def attemptToDecodeOneYesPriorYesSpaceYesData(in: ByteBuffer, out: CharBuffer): Maybe[CoderResult]

    Permalink
  8. def attemptToDecodeOneYesPriorYesSpaceYesFrag(in: ByteBuffer, out: CharBuffer): Maybe[CoderResult]

    Permalink
  9. def averageBitsPerChar(): Float

    Permalink
  10. def averageBytesPerChar(): Float

    Permalink
  11. def averageCharsPerBit(): Float

    Permalink
  12. def averageCharsPerByte(): Float

    Permalink
  13. final def bitWidthOfACodeUnit: Int

    Permalink
  14. def bitsCharset: NBitsWidth_BitsCharset

    Permalink
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. val cs: NBitsWidth_BitsCharset

    Permalink
    Attributes
    protected
    Definition Classes
    NBitsWidth_BitsCharsetDecoderNBitsWidth_BitsEncoderDecoderMixin
  17. def decode(in: ByteBuffer, out: CharBuffer, endOfInput: Boolean): CoderResult

    Permalink
  18. final def decode(in: ByteBuffer): CharBuffer

    Permalink
    Definition Classes
    BitsCharsetDecoder
  19. final def decodeLoop(in: ByteBuffer, out: CharBuffer): CoderResult

    Permalink
  20. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def flush(out: CharBuffer): CoderResult

    Permalink
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def getFinalByteBitLimitOffset0b(): MaybeULong

    Permalink
    Attributes
    protected
  26. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def isMandatoryAlignmentNeeded(): Boolean

    Permalink
  29. final def isReset: Boolean

    Permalink

    True if the decoder has not decoded anything since the last reset call.

    True if the decoder has not decoded anything since the last reset call. False if decodeLoop has been called.

    Use to control things that we only want to check once per reset of the decoder.

    Definition Classes
    IsResetMixin
  30. final def isReset_=(v: Boolean): Unit

    Permalink

    Allow assignment to isReset only in derived classes

    Allow assignment to isReset only in derived classes

    Attributes
    protected
    Definition Classes
    IsResetMixin
  31. def malformedInputAction(): CodingErrorAction

    Permalink
  32. def maxBitsPerChar(): Float

    Permalink
  33. def maxBytesPerChar(): Float

    Permalink
  34. def maxCharsPerBit(): Float

    Permalink
  35. def maxCharsPerByte(): Float

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

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

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

    Permalink
    Definition Classes
    AnyRef
  39. def onMalformedInput(action: CodingErrorAction): NBitsWidth_BitsCharsetDecoder

    Permalink
  40. def onUnmappableCharacter(action: CodingErrorAction): NBitsWidth_BitsCharsetDecoder

    Permalink
  41. def replaceWith(newReplacement: String): NBitsWidth_BitsCharsetDecoder

    Permalink
  42. def replacement(): String

    Permalink
  43. final def requiredBitOrder: BitOrder

    Permalink
  44. def reset(): NBitsWidth_BitsCharsetDecoder

    Permalink
  45. final def resetStartBit(): Unit

    Permalink
    Attributes
    protected
  46. final def setFinalByteBitLimitOffset0b(bitLimitOffset0b: MaybeULong): Unit

    Permalink

    If set, then it means there IS one more byte (at least) at the end of the ByteBuffer which holds the fragment byte.

    If set, then it means there IS one more byte (at least) at the end of the ByteBuffer which holds the fragment byte. This final byte is past the limit of the ByteBuffer.

    Definition Classes
    NBitsWidth_BitsCharsetDecoderBitsCharsetDecoder
  47. final def setInitialBitOffset(bitOffset0to7: Int): Unit

    Permalink

    Bit-oriented decoders have to be passed a standard byteBuffer and CharBuffer via the normal Java decodeLoop API.

    Bit-oriented decoders have to be passed a standard byteBuffer and CharBuffer via the normal Java decodeLoop API. However, as we are bit oriented, there's the possibility that there is a fragment of a byte at the end, and there can be an offset within the first byte for the start.

    So to get that information over to the decoder, given that the decodeLoop API doesn't pass it, we have setters.

    So a decoder is stateful. They're always stateful, so this isn't changing that. We're just adding yet more state.

    Definition Classes
    NBitsWidth_BitsCharsetDecoderBitsCharsetDecoder
  48. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  49. final def takeStartBitOffset(): Int

    Permalink

    Calling this returns the startBitOffset0b, but also sets flags so that it won't be processed again.

    Calling this returns the startBitOffset0b, but also sets flags so that it won't be processed again. It's a once-only thing until a reset.

    Attributes
    protected
  50. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  51. def unmappableCharacterAction(): CodingErrorAction

    Permalink
  52. final def wait(): Unit

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

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

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

Inherited from BitsCharsetDecoder

Inherited from IsResetMixin

Inherited from AnyRef

Inherited from Any

Ungrouped