モジュール jdk.javadoc
パッケージ com.sun.javadoc

インタフェースSerialFieldTag

  • すべてのスーパー・インタフェース:
    Comparable<Object>, Tag
    @Deprecated
public interface SerialFieldTag
extends Tag, Comparable<Object>
    非推奨。
    このパッケージの宣言は、パッケージjdk.javadoc.docletの宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
    ObjectStreamFieldによって定義されるSerializableフィールドのドキュメントを作成します。 
     The class parses and stores the three serialField tag parameters:

 - field name
 - field type name
      (fully-qualified or visible from the current import context)
 - description of the valid values for the field
    このタグは、特別なメンバーであるserialPersistentFieldsに対するjavadocの中でだけ使用できます。
    関連項目:
    ObjectStreamField

    • メソッドの詳細

      • fieldName

        String fieldName()
        非推奨。
        Serializableフィールドの名前を返します。
        戻り値:
        直列化可能なフィールド名。

      • fieldType

        String fieldType()
        非推奨。
        フィールドの型を表す文字列を返します。
        戻り値:
        フィールド型文字列。

      • fieldTypeDoc

        ClassDoc fieldTypeDoc()
        非推奨。
        フィールド型のClassDocを返します。
        戻り値:
        フィールド型のClassDocがcontainingClassコンテキストから可視でない場合は、null。

      • description

        String description()
        非推奨。
        フィールドのコメントを返します。 serialFieldのコメントがない場合は、対応するFieldDocのjavadocコメントを返します。
        戻り値:
        フィールド・コメント。 serialFieldのコメントがない場合は、対応するFieldDocのjavadocコメントを返します。

      • compareTo

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

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

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