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

インタフェースDoc

  • すべてのスーパー・インタフェース:
    Comparable<Object>
    既知のすべてのサブインタフェース:
    AnnotationTypeDoc, AnnotationTypeElementDoc, ClassDoc, ConstructorDoc, ExecutableMemberDoc, FieldDoc, MemberDoc, MethodDoc, PackageDoc, ProgramElementDoc, RootDoc

    @Deprecated(since="9",
                forRemoval=true)
    public interface Doc
    extends Comparable<Object>
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    このパッケージの宣言は、パッケージjdk.javadoc.docletの宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
    コメントが付けられており、今回のjavadocの実行で処理されたJava言語構造要素(パッケージ、クラス、コンストラクタ、メソッド、フィールド)を表します。 すべてのDocオブジェクトは一意であり、したがって==で比較することができます。
    導入されたバージョン:
    1.2
    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 抽象メソッド 非推奨のメソッド 
      修飾子と型 メソッド 説明
      String commentText()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目のコメント・テキストを返します。
      int compareTo​(Object obj)
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このdocオブジェクトと指定されたオブジェクトの順序を比較します。
      Tag[] firstSentenceTags()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      コメントの最初の文をタグの配列として返します。
      String getRawCommentText()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      コメントのテキスト全体を未処理のまま返します。
      Tag[] inlineTags()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      コメントをタグの配列として返します。
      boolean isAnnotationType()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目が注釈型かどうかを示します。
      boolean isAnnotationTypeElement()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目が注釈型の要素かどうかを示します。
      boolean isClass()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目がインタフェースまたは注釈型ではなく、クラス型かどうかを示します。
      boolean isConstructor()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目がコンストラクタかどうかを示します。
      boolean isEnum()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目がenum型かどうかを示します。
      boolean isEnumConstant()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目がenum定数かどうかを示します。
      boolean isError()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目がエラー・クラスかどうかを示します。
      boolean isException()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目が例外クラスかどうかを示します。
      boolean isField()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目がフィールド(ただし、enum定数ではない)かどうかを示します。
      boolean isIncluded()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目が結果セットに組み込まれる場合、trueを返します。
      boolean isInterface()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目がインタフェース(ただし、注釈型ではない)かどうかを示します。
      boolean isMethod()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目がメソッド(ただし、コンストラクタまたは注釈型の要素ではない)かどうかを示します。
      boolean isOrdinaryClass()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目が通常のクラスかどうかを示します。
      String name()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目の非修飾名を返します。
      SourcePosition position()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      対応する宣言の最初の行のソース位置を返します。ソース位置にアクセスできない場合はnullを返します。
      SeeTag[] seeTags()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目に含まれるタグを返します。
      void setRawCommentText​(String rawDocumentation)
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      コメントのテキスト全体を未処理のまま設定します。
      Tag[] tags()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目に含まれるすべてのタグを返します。
      Tag[] tags​(String tagname)
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このDoc項目に含まれる指定された種類のタグを返します。
    • メソッドの詳細

      • commentText

        String commentText()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目のコメント・テキストを返します。 タグは削除されます。
        戻り値:
        このドキュメント・アイテムのコメントのテキスト。
      • tags

        Tag[] tags()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目に含まれるすべてのタグを返します。
        戻り値:
        このDoc項目に含まれるすべてのタグを含んだTagオブジェクトの配列。
      • tags

        Tag[] tags​(String tagname)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目に含まれる指定された種類のタグを返します。 たとえば、tagnameに@serialという値がある場合、@serial型のこのDoc項目内のすべてのタグが返されます。
        パラメータ:
        tagname - 検索対象のタグ種の名前。
        戻り値:
        kind()がtagnameに一致するすべてのタグを含んだTagの配列。
      • seeTags

        SeeTag[] seeTags()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目に含まれるタグを返します。
        戻り値:
        すべての@seeタグを含んだSeeTagの配列。
      • inlineTags

        Tag[] inlineTags()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        コメントをタグの配列として返します。 インライン・タグ({@link reference}タグ)を含みますが、ブロック・タグは含みません。 プレーン・テキストの各セクションは、種類TextのTagとして表されます。 インライン・タグは、種類@seeおよび名前@linkのSeeTagとして表されます。
        戻り値:
        コメントを表すTagの配列
      • firstSentenceTags

        Tag[] firstSentenceTags()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        コメントの最初の文をタグの配列として返します。 インライン・タグ({@link reference}タグ)を含みますが、ブロック・タグは含みません。 プレーン・テキストの各セクションは、種類TextのTagとして表されます。 インライン・タグは、種類@seeおよび名前@linkのSeeTagとして表されます。

        ロケールが英語の場合、最初の文はJava言語仕様(最初のバージョン)に記述されている規則によって決定されます。"この文は、直後にスペース、タブ、または改行が続く最初のピリオド、または最初のタグ・ラインで終了します。"さらに、行はブロックHTMLタグで終了します。<p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre>または</pre>。 ロケールの言語が英語でない場合、文の終わりはBreakIterator.getSentenceInstance(Locale)によって決定されます。

        戻り値:
        コメントの最初の文を表すTagの配列
      • getRawCommentText

        String getRawCommentText()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        コメントのテキスト全体を未処理のまま返します。 タグはテキストとして含まれます。 このメソッドは主に、内部化などの格納および取得操作で使われます。
        戻り値:
        コメントの完全な未処理のテキスト。
      • setRawCommentText

        void setRawCommentText​(String rawDocumentation)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        コメントのテキスト全体を未処理のまま設定します。 タグはテキストとして含まれます。 このメソッドは主に、内部化などの格納および取得操作で使われます。
        パラメータ:
        rawDocumentation - コメントの未処理のテキストがすべて含まれるString。
      • name

        String name()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目の非修飾名を返します。
        戻り値:
        名前
      • compareTo

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

        このメソッドは、Comparableインタフェースを満たします。

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

        boolean isField()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目がフィールド(ただし、enum定数ではない)かどうかを示します。
        戻り値:
        フィールドを表す場合はtrue
      • isEnumConstant

        boolean isEnumConstant()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目がenum定数かどうかを示します。
        戻り値:
        enum定数を表す場合はtrue
        導入されたバージョン:
        1.5
      • isConstructor

        boolean isConstructor()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目がコンストラクタかどうかを示します。
        戻り値:
        コンストラクタを表す場合はtrue
      • isMethod

        boolean isMethod()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目がメソッド(ただし、コンストラクタまたは注釈型の要素ではない)かどうかを示します。
        戻り値:
        メソッドを表す場合はtrue
      • isAnnotationTypeElement

        boolean isAnnotationTypeElement()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目が注釈型の要素かどうかを示します。
        戻り値:
        注釈型の要素を表す場合はtrue
        導入されたバージョン:
        1.5
      • isInterface

        boolean isInterface()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目がインタフェース(ただし、注釈型ではない)かどうかを示します。
        戻り値:
        インタフェースを表す場合はtrue
      • isException

        boolean isException()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目が例外クラスかどうかを示します。
        戻り値:
        例外を表す場合はtrue
      • isError

        boolean isError()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目がエラー・クラスかどうかを示します。
        戻り値:
        エラーを表す場合はtrue
      • isEnum

        boolean isEnum()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目がenum型かどうかを示します。
        戻り値:
        enum型を表す場合はtrue
        導入されたバージョン:
        1.5
      • isAnnotationType

        boolean isAnnotationType()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目が注釈型かどうかを示します。
        戻り値:
        注釈型を表す場合はtrue
        導入されたバージョン:
        1.5
      • isOrdinaryClass

        boolean isOrdinaryClass()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目が通常クラス (つまりインタフェース、注釈型、列挙、例外、またはエラー以外)かどうかを示します。
        戻り値:
        通常のクラスを表す場合はtrue
      • isClass

        boolean isClass()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目がインタフェースまたは注釈型ではなく、クラス型かどうかを示します。 これには、通常のクラス、enum、エラー、および例外が含まれます。
        戻り値:
        クラスを表す場合はtrue
      • isIncluded

        boolean isIncluded()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このDoc項目が結果セットに組み込まれる場合、trueを返します。
        戻り値:
        このDocアイテムが結果セット内のincludedである場合はtrue。
      • position

        SourcePosition position()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        対応する宣言の最初の行のソース位置を返します。ソース位置にアクセスできない場合はnullを返します。 デフォルトのコンストラクタは、ソース・ファイルでの位置を持たないので、nullを返します。
        戻り値:
        対応する宣言の最初の行のソース位置、または使用可能な位置がない場合はnull。 デフォルトのコンストラクタは、ソース・ファイルでの位置を持たないので、nullを返します。
        導入されたバージョン:
        1.4