Класс ObjectStreamField

java.lang.Object
- java.io.ObjectStreamField

Все реализованные интерфейсы:: Comparable<Object>

public class ObjectStreamField
extends Object
implements Comparable<Object>

Описание поля класса, реализующего интерфейс Serializable. Массив ObjectStreamFields используется для объявления сериализуемых полей класса.

С тех пор:: 1.2
См. также:: ObjectStreamClass

Краткое описание конструкторов

Конструктор	Описание
`ObjectStreamField(String name, Class<?> type)`	Создает сериализуемое поле заданного типа.
`ObjectStreamField(String name, Class<?> type, boolean unshared)`	Создает объект ObjectStreamField, представляющий сериализуемое поле с заданным именем и типом.

Краткое описание методов

Модификатор и тип	Метод	Описание
`int`	`compareTo(Object obj)`	Сравнивает это поле с другим `ObjectStreamField`.
`String`	`getName()`	Получить имя этого поля.
`int`	`getOffset()`	Смещение поля внутри данных экземпляра.
`Class<?>`	`getType()`	Получить тип поля.
`char`	`getTypeCode()`	Возвращает кодировку символов типа поля.
`String`	`getTypeString()`	Возвращает подпись типа JVM.
`boolean`	`isPrimitive()`	Возвращает true, если это поле имеет примитивный тип.
`boolean`	`isUnshared()`	Возвращает логическое значение, указывающее, является ли сериализуемое поле, представленное этим экземпляром ObjectStreamField, несвязанным.
`protected void`	`setOffset(int offset)`	Смещение внутри данных экземпляра.
`String`	`toString()`	Возвращает строку, описывающую это поле.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание конструкторов

ObjectStreamField

public ObjectStreamField(String name,
                         Class<?> type)

Создает сериализуемое поле заданного типа. Это поле должно быть задокументировано с использованием тэга serialField.

Параметры:: name - имя сериализуемого поля; type - объект Class сериализуемого поля

ObjectStreamField

public ObjectStreamField(String name,
                         Class<?> type,
                         boolean unshared)

Создает объект ObjectStreamField, представляющий сериализуемое поле с заданным именем и типом. Если unshared ложно, значения представленного поля сериализуются и десериализуются стандартным способом — если поле не примитивное, значения объектов сериализуются и десериализуются так, как если бы они были записаны и считаны с помощью вызовов writeObject и readObject. Если unshared истинно, значения представленного поля сериализуются и десериализуются так, как если бы они были записаны и считаны с помощью вызовов writeUnshared и readUnshared.

Параметры:: name - имя поля; type - тип поля; unshared - если ложно, значения поля записываются/считываются так же, как writeObject/readObject; если истинно, записываются/считываются так же, как writeUnshared/readUnshared
С тех пор:: 1.4

Подробное описание методов

getName

public String getName()

Получить имя этого поля.

Возвращает:: строка, представляющая имя сериализуемого поля

getType

public Class<?> getType()

Получить тип поля. Если тип не примитивный, и этот ObjectStreamField был получен из десериализованного экземпляра ObjectStreamClass, то Object.class возвращается. В противном случае возвращается объект Class для типа поля.

Возвращает:: объект, представляющий тип сериализуемого поля

getTypeCode

public char getTypeCode()

Возвращает кодировку символов типа поля. Кодировка следующая:

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

Возвращает:: код типа сериализуемого поля

getTypeString

public String getTypeString()

Возвращает подпись типа JVM.

Возвращает:: null, если это поле имеет примитивный тип.

getOffset

public int getOffset()

Смещение поля внутри данных экземпляра.

Возвращает:: смещение этого поля
См. также:: setOffset(int)

setOffset

protected void setOffset(int offset)

Смещение внутри данных экземпляра.

Параметры:: offset - смещение поля
См. также:: getOffset()

isPrimitive

public boolean isPrimitive()

Возвращает true, если это поле имеет примитивный тип.

Возвращает:: истинно тогда и только тогда, когда это поле соответствует примитивному типу

isUnshared

public boolean isUnshared()

Возвращает логическое значение, указывающее, является ли сериализуемое поле, представленное этим экземпляром ObjectStreamField, несвязанным.

Возвращает:: true если это поле несвязанное
С тех пор:: 1.4

compareTo

public int compareTo(Object obj)

Сравнивает это поле с другим ObjectStreamField. Возвращает -1, если это меньше, 0, если равно, 1, если больше. Типы, которые являются примитивными, «меньше», чем типы объектов. Если равны, сравниваются имена полей.

Задано в:: compareTo в интерфейсе Comparable<Object>
Параметры:: obj - объект для сравнения.
Возвращает:: отрицательное целое число, ноль или положительное целое число, если этот объект меньше, равен или больше указанного объекта.

toString

public String toString()

Возвращает строку, описывающую это поле.

Переопределяет:: toString в классе Object
Возвращает:: строковое представление объекта.