Added in API level 1

ObjectStreamField

open class ObjectStreamField : Comparable<Any!>

kotlin.Any
↳	java.io.ObjectStreamField

A description of a Serializable field from a Serializable class. An array of ObjectStreamFields is used to declare the Serializable fields of a class.

Summary

Public constructors
`ObjectStreamField(name: String!, type: Class<*>!)` Create a Serializable field with the specified type.
`ObjectStreamField(name: String!, type: Class<*>!, unshared: Boolean)` Creates an ObjectStreamField representing a serializable field with the given name and type.

Public methods
open Int	`compareTo(other: Any!)` Compare this field with another `ObjectStreamField`.
open String!	`getName()` Get the name of this field.
open Int	`getOffset()` Offset of field within instance data.
open Class<*>!	`getType()` Get the type of the field.
open Char	`getTypeCode()` Returns character encoding of field type.
open String!	`getTypeString()` Return the JVM type signature.
open Boolean	`isPrimitive()` Return true if this field has a primitive type.
open Boolean	`isUnshared()` Returns boolean value indicating whether or not the serializable field represented by this ObjectStreamField instance is unshared.
open String	`toString()` Return a string that describes this field.

Protected methods
open Unit	`setOffset(offset: Int)` Offset within instance data.

Public constructors

ObjectStreamField

Added in API level 1

ObjectStreamField(
    name: String!, 
    type: Class<*>!)

Create a Serializable field with the specified type. This field should be documented with a serialField tag.

Parameters
`name`	String!: the name of the serializable field
`type`	Class<*>!: the `Class` object of the serializable field

ObjectStreamField

Added in API level 1

ObjectStreamField(
    name: String!, 
    type: Class<*>!, 
    unshared: Boolean)

Creates an ObjectStreamField representing a serializable field with the given name and type. If unshared is false, values of the represented field are serialized and deserialized in the default manner--if the field is non-primitive, object values are serialized and deserialized as if they had been written and read by calls to writeObject and readObject. If unshared is true, values of the represented field are serialized and deserialized as if they had been written and read by calls to writeUnshared and readUnshared.

Parameters
`name`	String!: field name
`type`	Class<*>!: field type
`unshared`	Boolean: if false, write/read field values in the same manner as writeObject/readObject; if true, write/read in the same manner as writeUnshared/readUnshared

Public methods

compareTo

Added in API level 1

open fun compareTo(other: Any!): Int

Compare this field with another ObjectStreamField. Return -1 if this is smaller, 0 if equal, 1 if greater. Types that are primitives are "smaller" than object types. If equal, the field names are compared.

Parameters
`o`	the object to be compared.

Return
`Int`	a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Exceptions
`java.lang.NullPointerException`	if the specified object is null
`java.lang.ClassCastException`	if the specified object's type prevents it from being compared to this object.

getName

Added in API level 1

open fun getName(): String!

Get the name of this field.

Return
`String!`	a `String` representing the name of the serializable field

getOffset

Added in API level 1

open fun getOffset(): Int

Offset of field within instance data.

Return
`Int`	the offset of this field

See Also

#setOffset

getType

Added in API level 1

open fun getType(): Class<*>!

Get the type of the field. If the type is non-primitive and this ObjectStreamField was obtained from a deserialized ObjectStreamClass instance, then Object.class is returned. Otherwise, the Class object for the type of the field is returned.

Return
`Class<*>!`	a `Class` object representing the type of the serializable field

getTypeCode

Added in API level 1

open fun getTypeCode(): Char

Returns character encoding of field type. The encoding is as follows:

B            byte
  C            char
  D            double
  F            float
  I            int
  J            long
  L            class or interface
  S            short
  Z            boolean
  [            array

Return
`Char`	the typecode of the serializable field

getTypeString

Added in API level 1

open fun getTypeString(): String!

Return the JVM type signature.

Return
`String!`	null if this field has a primitive type.

isPrimitive

Added in API level 1

open fun isPrimitive(): Boolean

Return true if this field has a primitive type.

Return
`Boolean`	true if and only if this field corresponds to a primitive type

isUnshared

Added in API level 1

open fun isUnshared(): Boolean

Returns boolean value indicating whether or not the serializable field represented by this ObjectStreamField instance is unshared.

Return
`Boolean`	`true` if this field is unshared

toString

Added in API level 1

open fun toString(): String

Return a string that describes this field.

Return
`String`	a string representation of the object.

Protected methods

setOffset

Added in API level 1

protected open fun setOffset(offset: Int): Unit

Offset within instance data.

Parameters
`offset`	Int: the offset of the field

See Also

#getOffset