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

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

public interface PackageDoc
extends Doc

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

導入されたバージョン:
JDK1.2

メソッドの概要
 ClassDoc[] allClasses()
          パッケージ内のすべてのクラス (例外クラスとエラークラスを含む) を取得します。
 ClassDoc[] allClasses(boolean filter)
          すべてのクラス (例外クラスとエラークラスを含む) とインタフェースを取得します。
 ClassDoc[] errors()
          このパッケージに含まれるエラークラスを取得します。
 ClassDoc[] exceptions()
          このパッケージに含まれる例外クラスを取得します。
 ClassDoc findClass(String className)
          このパッケージから特定のクラスを検索します。
 ClassDoc[] interfaces()
          このパッケージに含まれるインタフェースを取得します。
 ClassDoc[] ordinaryClasses()
          このパッケージに含まれる通常のクラス (例外クラスとエラークラスを除く) を取得します。
 
インタフェース com.sun.javadoc.Doc から継承したメソッド
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags
 

メソッドの詳細

allClasses

public ClassDoc[] allClasses(boolean filter)
すべてのクラス (例外クラスとエラークラスを含む) とインタフェースを取得します。

戻り値:
このパッケージに含まれるすべてのクラスとインタフェース。ただし、filter に true が指定された場合はクラスだけが返される
導入されたバージョン:
J2SE1.4.

allClasses

public ClassDoc[] allClasses()
パッケージ内のすべてのクラス (例外クラスとエラークラスを含む) を取得します。このメソッドは、allClasses(true) と等価です。

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

ordinaryClasses

public ClassDoc[] ordinaryClasses()
このパッケージに含まれる通常のクラス (例外クラスとエラークラスを除く) を取得します。

戻り値:
このパッケージに含まれるクラス

exceptions

public ClassDoc[] exceptions()
このパッケージに含まれる例外クラスを取得します。

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

errors

public ClassDoc[] errors()
このパッケージに含まれるエラークラスを取得します。

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

interfaces

public ClassDoc[] interfaces()
このパッケージに含まれるインタフェースを取得します。

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

findClass

public ClassDoc findClass(String className)
このパッケージから特定のクラスを検索します。

戻り値:
見つかったクラスの ClassDoc。見つからなかった場合は、null


バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.