SerialFieldTag (ドックレット API)

クラス

使用

ヘルプ

ドックレット API

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.sun.javadoc
インタフェース SerialFieldTag

ObjectStreamField によって定義される Serializable フィールドのドキュメントを作成します。

 このクラスは、次に示す serialField タグの 3 つのパラメータを解析し、格納します。

 - フィールド名
 - フィールドの型名
      (完全指定されたものか、現在のインポートコンテキストから可視のもの)
 - フィールドの有効な値に関する説明

このタグは、特別なメンバーである serialPersistentFields に対する javadoc の中でだけ使用できます。

メソッドの概要
`int`	`compareTo(Object obj)` このオブジェクトと指定されたオブジェクトの順序を比較します。
`String`	`description()` フィールドのコメントを返します。
`String`	`fieldName()` Serializable フィールドの名前を返します。
`String`	`fieldType()` フィールドの型を表す文字列を返します。
`ClassDoc`	`fieldTypeDoc()` フィールド型の ClassDoc を返します。

インタフェース com.sun.javadoc.Tag から継承されたメソッド
`firstSentenceTags, holder, inlineTags, kind, name, position, text, toString`

メソッドの詳細

String fieldName()

Serializable フィールドの名前を返します。

String fieldType()

フィールドの型を表す文字列を返します。

ClassDoc fieldTypeDoc()

フィールド型の ClassDoc を返します。

String description()

フィールドのコメントを返します。serialField のコメントがない場合は、対応する FieldDoc の javadoc コメントを返します。

int compareTo(Object obj)

このオブジェクトと指定されたオブジェクトの順序を比較します。このオブジェクトが指定されたオブジェクトよりも小さい場合は、負の整数、このオブジェクトと指定されたオブジェクトが等しい場合は、ゼロ、このオブジェクトが指定されたオブジェクトよりも大きい場合は、正の整数が返されます。

SerialFieldTag の項目が java.lang.Comparable となるようにするために使用します。

パラメータ:: obj - 比較対象の Object
戻り値:: このオブジェクトが指定されたオブジェクトよりも小さい場合は負の整数。このオブジェクトと指定されたオブジェクトが等しい場合はゼロ。このオブジェクトが指定されたオブジェクトよりも大きい場合は正の整数
例外:: ClassCastException - 指定されたオブジェクトの型が、このオブジェクトと比較できない型の場合
導入されたバージョン:: 1.2