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

すべてのスーパーインタフェース:

java.lang.Comparable, java.io.Serializable, Tag

public interface SerialFieldTag

extends Tag, java.lang.Comparable

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

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

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

 

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

関連項目:

ObjectStreamField

メソッドの概要

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

インタフェース com.sun.javadoc.Tag から継承したメソッド

firstSentenceTags, inlineTags, kind, name, text, toString

メソッドの詳細

fieldName

public java.lang.String fieldName()

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

fieldType

public java.lang.String fieldType()

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

fieldTypeDoc

public ClassDoc fieldTypeDoc()

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

description

public java.lang.String description()

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

compareTo

public int compareTo(java.lang.Object obj)

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

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

定義:

インタフェース java.lang.Comparable 内の compareTo

パラメータ:

obj - 比較対象の Object

戻り値:

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

例外:

ClassCastException - 指定されたオブジェクトの型が、このオブジェクトと比較できない型の場合

導入されたバージョン:

JDK1.2