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

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

Comparable<Object>, Doc

public interface PackageDoc
extends Doc

特定の Java パッケージを表します。PackageDoc を使用することで、パッケージ、パッケージのコメントとタグ、およびパッケージ内のクラスに関する情報にアクセスできます。

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

導入されたバージョン:

1.2

メソッドの概要

ClassDoc[]	allClasses() パッケージのすべての組み込みクラスおよびインタフェースを取得します。
ClassDoc[]	allClasses(boolean filter) パッケージに含まれるクラスとインタフェースのうち、指定されたアクセス修飾子のオプションに対してフィルタ処理されたすべてのクラスとインタフェースを取得します。
AnnotationDesc[]	annotations() このパッケージの注釈を取得します。
AnnotationTypeDoc[]	annotationTypes() このパッケージに含まれる注釈の種類を取得します。
ClassDoc[]	enums() このパッケージに含まれる enum 型を取得します。
ClassDoc[]	errors() このパッケージに含まれるエラークラスを取得します。
ClassDoc[]	exceptions() このパッケージに含まれる例外クラスを取得します。
ClassDoc	findClass(String className) このパッケージから特定のクラスまたはインタフェースを検索します。
ClassDoc[]	interfaces() このパッケージに含まれる、注釈の種類以外のインタフェースを取得します。
ClassDoc[]	ordinaryClasses() このパッケージの通常クラス (つまり、例外、エラー、列挙、インタフェース、および注釈の種類は除く) を取得します。

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

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags

メソッドの詳細

allClasses

ClassDoc[] allClasses(boolean filter)

パッケージに含まれるクラスとインタフェースのうち、指定されたアクセス修飾子のオプションに対してフィルタ処理されたすべてのクラスとインタフェースを取得します。

パラメータ:

filter - true を指定すると、指定されたアクセス修飾子のオプションに従ってフィルタ処理する。 false を指定すると、アクセス修飾子のオプションに関係なく、すべてのクラスおよびインタフェースを取得する

戻り値:

このパッケージに含まれるフィルタ処理されたクラスおよびインタフェース

導入されたバージョン:

1.4

allClasses

ClassDoc[] allClasses()

パッケージのすべての組み込みクラスおよびインタフェースを取得します。allClasses(true) と同じです。

戻り値:

このパッケージに含まれるすべてのクラスとインタフェース

ordinaryClasses

ClassDoc[] ordinaryClasses()

このパッケージの通常クラス (つまり、例外、エラー、列挙、インタフェース、および注釈の種類は除く) を取得します。

戻り値:

このパッケージに含まれる通常のクラス

exceptions

ClassDoc[] exceptions()

このパッケージに含まれる例外クラスを取得します。

戻り値:

このパッケージに含まれる例外クラス

errors

ClassDoc[] errors()

このパッケージに含まれるエラークラスを取得します。

戻り値:

このパッケージに含まれるエラークラス

enums

ClassDoc[] enums()

このパッケージに含まれる enum 型を取得します。

戻り値:

このパッケージに含まれる enum 型

導入されたバージョン:

1.5

interfaces

ClassDoc[] interfaces()

このパッケージに含まれる、注釈の種類以外のインタフェースを取得します。

戻り値:

このパッケージに含まれるインタフェース

annotationTypes

AnnotationTypeDoc[] annotationTypes()

このパッケージに含まれる注釈の種類を取得します。

戻り値:

このパッケージに含まれる注釈の種類

導入されたバージョン:

1.5

annotations

AnnotationDesc[] annotations()

このパッケージの注釈を取得します。注釈がない場合は、空の配列を返します。

戻り値:

このパッケージの注釈

導入されたバージョン:

1.5

findClass

ClassDoc findClass(String className)

このパッケージから特定のクラスまたはインタフェースを検索します。

戻り値:

見つかったクラスまたはインタフェースの ClassDoc、そうでない場合は null