モジュール java.base

パッケージ java.io

クラスObjectStreamField

java.lang.Object

java.io.ObjectStreamField

すべての実装されたインタフェース:

Comparable<Object>

public class ObjectStreamField extends Object implements Comparable<Object>

直列化可能クラスからの直列化可能フィールドの記述です。 ObjectStreamFieldの配列は、クラスの直列化可能フィールドを宣言するために使用されます。

導入されたバージョン:

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インスタンスが表す直列化可能フィールドが共有されているかどうかを示す、boolean値を返します。
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がfalseの場合、表現されたフィールドの値はデフォルトの方法で直列化および直列化復元されます。このフィールドがプリミティブでない場合、オブジェクトの値の直列化と直列化復元は、writeObjectとreadObjectを呼び出して書き込みおよび読込みを行った場合と同様に行われます。 unsharedがtrueの場合、表現されたフィールドの値の直列化と直列化復元は、writeUnsharedとreadUnsharedを呼び出して書き込みおよび読込みを行った場合と同様に行われます。

パラメータ:

name - フィールド名

type - フィールドの型

unshared - falseの場合、writeObjectおよびreadObjectと同じ方法でフィールドの値が読み書きされる。trueの場合、writeUnsharedおよびreadUnsharedと同じ方法で読み書きされる

導入されたバージョン:

1.4

メソッドの詳細

getName

public String getName()

このフィールドの名前を取得します。

戻り値:

直列化可能フィールドの名前を表すString

getType

public Class<?> getType()

フィールドの型を取得します。 型がプリミティブでなく、このObjectStreamFieldが直列化復元されたObjectStreamClassインスタンスから取得された場合は、Object.classが返されます。 そうでない場合は、フィールドの型に対する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を返します。

戻り値:

このフィールドがプリミティブ型に対応する場合に限りtrue

isUnshared

public boolean isUnshared()

このObjectStreamFieldインスタンスが表す直列化可能フィールドが共有されているかどうかを示す、boolean値を返します。

戻り値:

このフィールドが共有されない場合はtrue

導入されたバージョン:

1.4

compareTo

public int compareTo(Object obj)

このフィールドを別のObjectStreamFieldと比較します。 このフィールドが小さい場合は -1、等しい場合は0、大きい場合は1を返します。 プリミティブ型は、オブジェクトの型より「小さい」です。 等しい場合は、フィールド名が比較されます。

定義:

compareTo、インタフェースComparable<Object>

パラメータ:

obj -比較対象のオブジェクト。

戻り値:

このオブジェクトが指定されたオブジェクトより小さい場合は負の整数、等しい場合はゼロ、大きい場合は正の整数

toString

public String toString()

このフィールドを記述する文字列を返します。

オーバーライド:

toString、クラスObject

戻り値:

このオブジェクトの文字列表現