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

インタフェースSerialFieldTag

  • すべてのスーパー・インタフェース:
    Comparable<Object>, Tag
    @Deprecated(since="9",
            forRemoval=true)
public interface SerialFieldTag
extends Tag, Comparable<Object>
    非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
    このパッケージの宣言は、パッケージ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

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 抽象メソッド 非推奨のメソッド 
      修飾子と型 メソッド 説明
      int compareTo​(Object obj)
      非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
      このオブジェクトと指定されたオブジェクトの順序を比較します。
      String description()
      非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
      フィールドのコメントを返します。
      String fieldName()
      非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
      Serializableフィールドの名前を返します。
      String fieldType()
      非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
      フィールドの型を表す文字列を返します。
      ClassDoc fieldTypeDoc()
      非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
      フィールド型のClassDocを返します。

    • メソッドの詳細

      • fieldName

        String fieldName()
        非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
        Serializableフィールドの名前を返します。
        戻り値:
        シリアライズ可能なフィールド名。

      • fieldType

        String fieldType()
        非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
        フィールドの型を表す文字列を返します。
        戻り値:
        フィールド・タイプ文字列。

      • fieldTypeDoc

        ClassDoc fieldTypeDoc()
        非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
        フィールド型のClassDocを返します。
        戻り値:
        フィールド型のClassDocがcontainingClassコンテキストから可視でない場合は、null。

      • description

        String description()
        非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
        フィールドのコメントを返します。 serialFieldのコメントがない場合は、対応するFieldDocのjavadocコメントを返します。
        戻り値:
        フィールドのコメント。 serialFieldのコメントがない場合は、対応するFieldDocのjavadocコメントを返します。

      • compareTo

        int compareTo​(Object obj)
        非推奨、削除予定: このAPI要素は将来のバージョンで削除予定です。
        このオブジェクトと指定されたオブジェクトの順序を比較します。 このオブジェクトが指定されたオブジェクトよりも小さい場合は、負の整数、このオブジェクトと指定されたオブジェクトが等しい場合は、ゼロ、このオブジェクトが指定されたオブジェクトよりも大きい場合は、正の整数が返されます。

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

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