Input

Represents an abstract source from which a value may be deserialized (read). Each of the read methods tries to read a value of specified type and may throw an exception (usually ReadFailure) when reading is not successful.

An Input value should be assumed to be stateful. If any of the readX methods have already been called, the Input instance can no longer be used and MUST be discarded.

In order to ignore the value kept in this Input, skip() MUST be called.

In summary: every Input MUST be fully exhausted by either calling one of the read methods which returns successful value or by calling skip(). Also, ListInput and ObjectInput instances returned from this Input must also be fully exhausted on their own.

Linear Supertypes

Any

Known Subclasses

FieldInput, JsonStringFieldInput, JsonStringInput, ObjectInputAsInput, SimpleValueFieldInput, SimpleValueInput, StreamFieldInput, StreamInput

Abstract Value Members

abstract def getClass(): Class[_]

Definition Classes
Any
abstract def isNull: Boolean
abstract def readBigDecimal(): BigDecimal
abstract def readBigInt(): BigInt
abstract def readBinary(): Array[Byte]
abstract def readBoolean(): Boolean
abstract def readDouble(): Double
abstract def readInt(): Int
abstract def readList(): ListInput
abstract def readLong(): Long
abstract def readNull(): Null
abstract def readObject(): ObjectInput
abstract def readString(): String
abstract def skip(): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
Any
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def equals(arg0: Any): Boolean

Definition Classes
Any
def hashCode(): Int

Definition Classes
Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def legacyOptionEncoding: Boolean

This ugly workaround has been introduced when standard Option encoding changed from zero-or-one element list encoding to unwrapped-or-null encoding which effectively disallowed serializing null and Some(null).
This ugly workaround has been introduced when standard Option encoding changed from zero-or-one element list encoding to unwrapped-or-null encoding which effectively disallowed serializing null and Some(null). If some Input implementation still wants to use the list encoding, it may do it by overriding this method and returning true.
def readByte(): Byte
def readChar(): Char
def readFloat(): Float
def readShort(): Short
def readTimestamp(): Long
def readUnit(): Unit
def toString(): String

Definition Classes
Any

Related Doc: package serialization

trait Input extends Any

Abstract Value Members

abstract def getClass(): Class[_]

abstract def isNull: Boolean

abstract def readBigDecimal(): BigDecimal

abstract def readBigInt(): BigInt

abstract def readBinary(): Array[Byte]

abstract def readBoolean(): Boolean

abstract def readDouble(): Double

abstract def readInt(): Int

abstract def readList(): ListInput

abstract def readLong(): Long

abstract def readNull(): Null

abstract def readObject(): ObjectInput

abstract def readString(): String

abstract def skip(): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def equals(arg0: Any): Boolean

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def legacyOptionEncoding: Boolean

def readByte(): Byte

def readChar(): Char

def readFloat(): Float

def readShort(): Short

def readTimestamp(): Long

def readUnit(): Unit

def toString(): String

Inherited from Any

Ungrouped