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 値を返します。

導入されたバージョン:

1.4

compareTo

public int compareTo(Object obj)

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

定義:

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

パラメータ:

obj - the object to be compared.

戻り値:

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

toString

public String toString()

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

オーバーライド:

クラス Object 内の toString

戻り値:

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