Trait

fm.serializer

Input

Related Doc: package serializer

Permalink

trait Input extends FieldInput with CollectionInput with NestedInput with RawInput

Generic Input trait to be implemented by Serialization Implementations

See the docs for Output for the distinction between RAW, NESTED, and FIELD Input/Output. The only difference for Input is that there aren't readNestedXXX() methods. Instead the way fields for objects are read is:

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Input
  2. RawInput
  3. CollectionInput
  4. FieldInput
  5. NestedInput
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def allowStringMap: Boolean

    Permalink
    Definition Classes
    RawInput
  2. abstract def hasAnotherElement: Boolean

    Permalink

    Is there another element to read in the collection?

    Is there another element to read in the collection?

    Definition Classes
    CollectionInput
  3. abstract def lastFieldName(): String

    Permalink

    The last field name that was read (if any)

    The last field name that was read (if any)

    Definition Classes
    FieldInput
  4. abstract def lastFieldNumber(): Int

    Permalink

    The last field number that was read (if any)

    The last field number that was read (if any)

    Definition Classes
    FieldInput
  5. abstract def nextValueIsNull: Boolean

    Permalink

    Returns true if the next value is known to be null otherwise false if the value is not null or is unknown.

    Returns true if the next value is known to be null otherwise false if the value is not null or is unknown. This means that even if the next value ends up being null this can return false.

    Note: If the next value is null then this method should consume that input

    Definition Classes
    RawInput
  6. abstract def readFieldName(): String

    Permalink

    If dynamic string maps are supported then this should be implemented otherwise this can just throw an exception.

    If dynamic string maps are supported then this should be implemented otherwise this can just throw an exception.

    null should be returns on the end of an object/message

    Definition Classes
    FieldInput
  7. abstract def readFieldNumber(nameToNumMap: FieldNameToNumberLookup): Int

    Permalink

    This is for reading fields of an object.

    This is for reading fields of an object.

    Return the field number for the next readable field. Returns 0 if we've reached the end of the object/message

    Definition Classes
    FieldInput
  8. abstract def readNestedBigDecimal(): BigDecimal

    Permalink
    Definition Classes
    NestedInput
  9. abstract def readNestedBigInteger(): BigInteger

    Permalink
    Definition Classes
    NestedInput
  10. abstract def readNestedBool(): Boolean

    Permalink
    Definition Classes
    NestedInput
  11. abstract def readNestedByteArray(): Array[Byte]

    Permalink
    Definition Classes
    NestedInput
  12. abstract def readNestedCollection[T](f: (CollectionInput) ⇒ T): T

    Permalink
    Definition Classes
    NestedInput
  13. abstract def readNestedDouble(): Double

    Permalink
    Definition Classes
    NestedInput
  14. abstract def readNestedFixedInt(): Int

    Permalink
    Definition Classes
    NestedInput
  15. abstract def readNestedFixedLong(): Long

    Permalink
    Definition Classes
    NestedInput
  16. abstract def readNestedFloat(): Float

    Permalink
    Definition Classes
    NestedInput
  17. abstract def readNestedInt(): Int

    Permalink
    Definition Classes
    NestedInput
  18. abstract def readNestedLong(): Long

    Permalink
    Definition Classes
    NestedInput
  19. abstract def readNestedObject[T](f: (FieldInput) ⇒ T): T

    Permalink
    Definition Classes
    NestedInput
  20. abstract def readNestedSignedInt(): Int

    Permalink
    Definition Classes
    NestedInput
  21. abstract def readNestedSignedLong(): Long

    Permalink
    Definition Classes
    NestedInput
  22. abstract def readNestedString(): String

    Permalink
    Definition Classes
    NestedInput
  23. abstract def readNestedUnsignedInt(): Int

    Permalink
    Definition Classes
    NestedInput
  24. abstract def readNestedUnsignedLong(): Long

    Permalink
    Definition Classes
    NestedInput
  25. abstract def readRawBigDecimal(): BigDecimal

    Permalink
    Definition Classes
    RawInput
  26. abstract def readRawBigInteger(): BigInteger

    Permalink
    Definition Classes
    RawInput
  27. abstract def readRawBool(): Boolean

    Permalink
    Definition Classes
    RawInput
  28. abstract def readRawByteArray(): Array[Byte]

    Permalink
    Definition Classes
    RawInput
  29. abstract def readRawCollection[T](f: (CollectionInput) ⇒ T): T

    Permalink
    Definition Classes
    RawInput
  30. abstract def readRawDouble(): Double

    Permalink
    Definition Classes
    RawInput
  31. abstract def readRawFixedInt(): Int

    Permalink
    Definition Classes
    RawInput
  32. abstract def readRawFixedLong(): Long

    Permalink
    Definition Classes
    RawInput
  33. abstract def readRawFloat(): Float

    Permalink
    Definition Classes
    RawInput
  34. abstract def readRawInt(): Int

    Permalink
    Definition Classes
    RawInput
  35. abstract def readRawLong(): Long

    Permalink
    Definition Classes
    RawInput
  36. abstract def readRawObject[T](f: (FieldInput) ⇒ T): T

    Permalink
    Definition Classes
    RawInput
  37. abstract def readRawSignedInt(): Int

    Permalink
    Definition Classes
    RawInput
  38. abstract def readRawSignedLong(): Long

    Permalink
    Definition Classes
    RawInput
  39. abstract def readRawString(): String

    Permalink
    Definition Classes
    RawInput
  40. abstract def readRawUnsignedInt(): Int

    Permalink
    Definition Classes
    RawInput
  41. abstract def readRawUnsignedLong(): Long

    Permalink
    Definition Classes
    RawInput
  42. abstract def skipUnknownField(): Unit

    Permalink

    Skip an unknown field value.

    Skip an unknown field value.

    If after calling readFieldNumber(...) we don't know how to handle the resulting field number then this method can be called to skip the value of the field after which we can call readFieldNumber(...) again.

    Definition Classes
    FieldInput

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  14. def reportUnsetField[T](number: Int, name: String, hasUserDefinedDefaultValue: Boolean, deserializer: Deserializer[T]): Unit

    Permalink

    This is for reporting that fields for an object were not read and whether or not they had a user-defined default value.

    This is for reporting that fields for an object were not read and whether or not they had a user-defined default value.

    number

    The field number

    name

    The field name. Note: This can be null.

    hasUserDefinedDefaultValue

    Whether or not there was a user defined default value (e.g. val foo: Int = 123)

    deserializer

    The deserializer for the field. Note: This can be null.

    Definition Classes
    FieldInput
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(): Unit

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

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from RawInput

Inherited from CollectionInput

Inherited from FieldInput

Inherited from NestedInput

Inherited from AnyRef

Inherited from Any

Ungrouped