class HoconObjectInput extends ObjectInput with BaseHoconInput
- Alphabetic
- By Inheritance
- HoconObjectInput
- BaseHoconInput
- ObjectInput
- SequentialInput
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new HoconObjectInput(configObject: ConfigObject)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getNextNamedField(name: String): FieldInput
Tries to obtain FieldInput for field with specified name, either by using peekField (assuming format with random field access) or nextField (assuming format that preserves field order).
Tries to obtain FieldInput for field with specified name, either by using peekField (assuming format with random field access) or nextField (assuming format that preserves field order). A codec that uses this method must ensure that it reads fields in the same order as they were written using
writeField
on ObjectOutput.- Definition Classes
- ObjectInput
-
final
def
handleFailures[T](code: ⇒ T): T
- Attributes
- protected
- Definition Classes
- BaseHoconInput
-
def
hasNext: Boolean
- Definition Classes
- HoconObjectInput → SequentialInput
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
iterator[A](readFun: (Input) ⇒ A): Iterator[(String, A)]
- Definition Classes
- ObjectInput
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nextField(): FieldInput
Returns FieldInput that represents next field of this object.
Returns FieldInput that represents next field of this object. You MUST NOT call
nextField()
again until this FieldInput is fully read or skipped.Serialization format implemented by this
ObjectInput
must either preserve order of fields (as they are written by correspondingObjectOutput
) OR it must provide random field access capability.- If the serialization format is able to preserve object field order then nextField must return
object fields in exactly the same order as they were written by
ObjectOutput.writeField
. This is natural for most serialization formats backed by strings, raw character or byte sequences, e.g. JSON implemented by JsonStringOutput/ JsonStringInput. - If the serialization format is unable to preserve object field order (e.g. because it uses hash maps to represent objects) then it must instead support random, by-name field access by overriding peekField.
- Definition Classes
- HoconObjectInput → ObjectInput
- If the serialization format is able to preserve object field order then nextField must return
object fields in exactly the same order as they were written by
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
peekField(name: String): commons.Opt[FieldInput]
If serialization format implemented by
ObjectInput
does NOT preserve field order, then this method MUST be overridden to support random field access.If serialization format implemented by
ObjectInput
does NOT preserve field order, then this method MUST be overridden to support random field access. It should return non-empty Opt containing input for every field present in the object, regardless of field order assumed by nextField.Opt.Empty
is returned when field is absent or always when thisObjectInput
does not support random field access (in which case it must preserve field order instead). NOTE: calling peekField and using FieldInput returned by it MUST NOT change state of thisObjectInput
. Therefore, it cannot in any way influence results returned by nextField and hasNext. For example, if a FieldInput for particular field has already been accessed using peekField but has not yet been returned by nextField then it MUST be returned at some point in the future by nextField.- Definition Classes
- HoconObjectInput → ObjectInput
-
def
skipRemaining(): Unit
- Definition Classes
- ObjectInput → SequentialInput
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )