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

インタフェースPackageDoc

  • すべてのスーパー・インタフェース:
    Comparable<Object>, Doc
    @Deprecated(since="9",
            forRemoval=true)
public interface PackageDoc
extends Doc
    削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
    このパッケージの宣言は、パッケージjdk.javadoc.docletの宣言に置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
    特定のJavaパッケージを表します。 これにより、パッケージ、パッケージのコメントとタグ、およびパッケージ内のクラスに関する情報にアクセスできます。

    結果にオブジェクトが含まれていない場合、戻り値の型が配列であるメソッドはすべて、空の配列(nullではない)を返します。

    導入されたバージョン:
    1.2

    • メソッドのサマリー

      修飾子と型 メソッド 説明
      ClassDoc[] allClasses()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      パッケージのすべての組み込みクラスおよびインタフェースを取得します。
      ClassDoc[] allClasses​(boolean filter)
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      パッケージに含まれるクラスとインタフェースのうち、指定されたアクセス修飾子のオプションに対してフィルタ処理されたすべてのクラスとインタフェースを取得します。
      AnnotationDesc[] annotations()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このパッケージの注釈を取得します。
      AnnotationTypeDoc[] annotationTypes()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このパッケージに含まれる注釈の種類を取得します。
      ClassDoc[] enums()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このパッケージに含まれるenum型を取得します。
      ClassDoc[] errors()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このパッケージに含まれるエラー・クラスを取得します。
      ClassDoc[] exceptions()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このパッケージに含まれる例外クラスを取得します。
      ClassDoc findClass​(String className)
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このパッケージから特定のクラスまたはインタフェースを検索します。
      ClassDoc[] interfaces()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このパッケージに含まれる、注釈の種類以外のインタフェースを取得します。
      ClassDoc[] ordinaryClasses()
      削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
      このパッケージの通常クラス(つまり、例外、エラー、列挙、インタフェース、および注釈の種類は除く)を取得します。

    • メソッドの詳細

      • allClasses

        ClassDoc[] allClasses​(boolean filter)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        パッケージに含まれるクラスとインタフェースのうち、指定されたアクセス修飾子のオプションに対してフィルタ処理されたすべてのクラスとインタフェースを取得します。
        パラメータ:
        filter - trueを指定すると、指定されたアクセス修飾子のオプションに従ってフィルタ処理する。 falseを指定すると、アクセス修飾子のオプションに関係なく、すべてのクラスおよびインタフェースを取得する。
        戻り値:
        このパッケージに含まれるフィルタ処理されたクラスおよびインタフェース
        導入されたバージョン:
        1.4

      • allClasses

        ClassDoc[] allClasses()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        パッケージのすべての組み込みクラスおよびインタフェースを取得します。 allClasses(true)と同じです。
        戻り値:
        このパッケージに含まれるすべてのクラスとインタフェース。

      • ordinaryClasses

        ClassDoc[] ordinaryClasses()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このパッケージの通常クラス(つまり、例外、エラー、列挙、インタフェース、および注釈の種類は除く)を取得します。
        戻り値:
        このパッケージに含まれる通常のクラス。

      • exceptions

        ClassDoc[] exceptions()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このパッケージに含まれる例外クラスを取得します。
        戻り値:
        このパッケージに含まれる例外クラス。

      • errors

        ClassDoc[] errors()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このパッケージに含まれるエラー・クラスを取得します。
        戻り値:
        このパッケージに含まれるエラー・クラス。

      • enums

        ClassDoc[] enums()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このパッケージに含まれるenum型を取得します。
        戻り値:
        このパッケージに含まれるenum型。
        導入されたバージョン:
        1.5

      • interfaces

        ClassDoc[] interfaces()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このパッケージに含まれる、注釈の種類以外のインタフェースを取得します。
        戻り値:
        このパッケージに含まれるインタフェース。

      • annotationTypes

        AnnotationTypeDoc[] annotationTypes()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このパッケージに含まれる注釈の種類を取得します。
        戻り値:
        このパッケージに含まれる注釈の種類。
        導入されたバージョン:
        1.5

      • annotations

        AnnotationDesc[] annotations()
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このパッケージの注釈を取得します。 注釈がない場合は、空の配列を返します。
        戻り値:
        このパッケージの注釈。
        導入されたバージョン:
        1.5

      • findClass

        ClassDoc findClass​(String className)
        削除予定のため非推奨: このAPI要素は、将来のバージョンで削除される可能性があります。
        このパッケージから特定のクラスまたはインタフェースを検索します。
        パラメータ:
        className - 参照するクラスの名前を含むString。
        戻り値:
        見つかったクラスまたはインタフェースのClassDoc、そうでない場合はnull。