パッケージ
クラス
階層ツリー
インデックス
ヘルプ
前 次
フレームあり
フレームなし
A
C
D
E
F
G
I
K
L
M
N
O
P
Q
R
S
T
V
A
allClasses()
- interface com.sun.javadoc.
PackageDoc
におけるメソッド
すべてのクラス (例外クラスとエラークラスを含む) とインタフェースを取得します。
asClassDoc()
- interface com.sun.javadoc.
Type
におけるメソッド
この型をクラスとして返します。
C
ClassDoc
- interface com.sun.javadoc.
ClassDoc
.
特定の Java クラスを表し、クラス、クラスのコメントとタグ、およびクラスのメンバに関する情報へのアクセスを提供します。
classes()
- interface com.sun.javadoc.
RootDoc
におけるメソッド
ドキュメント生成されるクラスとインタフェースを返します。
classNamed(String)
- interface com.sun.javadoc.
RootDoc
におけるメソッド
指定されたクラス名またはインタフェース名に対応する ClassDoc を返します。
com.sun.javadoc
- package com.sun.javadoc
ドックレット API は、javadoc の出力のカスタマイズに使用します。
commentText()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目のコメントテキストを返します。
compareTo(Object)
- interface com.sun.javadoc.
Doc
におけるメソッド
このオブジェクトと指定されたオブジェクトの順序を比較します。
compareTo(Object)
- interface com.sun.javadoc.
SerialFieldTag
におけるメソッド
このオブジェクトと指定されたオブジェクトの順序を比較します。
ConstructorDoc
- interface com.sun.javadoc.
ConstructorDoc
.
特定の Java クラスの特定のコンストラクタを表します。
constructors()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラス中のコンストラクタを返します。
containingClass()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
このプログラム要素を含んでいるクラスを取得します。
containingPackage()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
このプログラム要素を含んでいるパッケージを取得します。
D
definesSerializableFields()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
Serializable フィールドが特別なクラスメンバ
serialPersistentFields
で明示的に定義されている場合は、true を返します。
description()
- interface com.sun.javadoc.
SerialFieldTag
におけるメソッド
フィールドのコメントを返します。
dimension()
- interface com.sun.javadoc.
Type
におけるメソッド
型の次元情報を文字列で返します。
Doc
- interface com.sun.javadoc.
Doc
.
すべての Doc クラスの抽象基底クラスです。
DocErrorReporter
- interface com.sun.javadoc.
DocErrorReporter
.
エラー、警告、および通知の表示機能を提供するインタフェースです。
Doclet
- class com.sun.javadoc.
Doclet
.
このクラスは、ドックレットに含まれるエントリポイントメソッドのドキュメントを生成します。
Doclet()
- class com.sun.javadoc.
Doclet
のコンストラクタ
E
errors()
- interface com.sun.javadoc.
PackageDoc
におけるメソッド
このパッケージに含まれるエラークラスを取得します。
exception()
- interface com.sun.javadoc.
ThrowsTag
におけるメソッド
例外を ClassDoc として返します。
exceptionComment()
- interface com.sun.javadoc.
ThrowsTag
におけるメソッド
例外のコメントを返します。
exceptionName()
- interface com.sun.javadoc.
ThrowsTag
におけるメソッド
例外の名前を返します。
exceptions()
- interface com.sun.javadoc.
PackageDoc
におけるメソッド
このパッケージに含まれる例外クラスを取得します。
ExecutableMemberDoc
- interface com.sun.javadoc.
ExecutableMemberDoc
.
特定の Java クラスの特定のメソッドまたはコンストラクタを表します。
F
FieldDoc
- interface com.sun.javadoc.
FieldDoc
.
特定の Java クラス内の特定のフィールドを表します。
fieldName()
- interface com.sun.javadoc.
SerialFieldTag
におけるメソッド
Serializable フィールドの名前を返します。
fields()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
クラス中のフィールドを返します。
fieldType()
- interface com.sun.javadoc.
SerialFieldTag
におけるメソッド
フィールドの型を表す文字列を返します。
fieldTypeDoc()
- interface com.sun.javadoc.
SerialFieldTag
におけるメソッド
フィールド型の ClassDoc を返します。
findClass(String)
- interface com.sun.javadoc.
PackageDoc
におけるメソッド
このパッケージから特定のクラスを検索します。
findClass(String)
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスのコンテキスト内で、特定のクラスを検索します。
firstSentenceTags()
- interface com.sun.javadoc.
Doc
におけるメソッド
コメントの最初の文をタグとして返します。
firstSentenceTags()
- interface com.sun.javadoc.
Tag
におけるメソッド
コメントの最初の文をタグとして返します。
flatSignature()
- interface com.sun.javadoc.
ExecutableMemberDoc
におけるメソッド
フラットシグニチャーを取得します。
G
getRawCommentText()
- interface com.sun.javadoc.
Doc
におけるメソッド
未処理のコメントテキスト全体を返します。
I
importedClasses()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
imported として宣言されたクラスのリストを取得します。
importedPackages()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
imported として宣言されたパッケージのリストを取得します。
inlineTags()
- interface com.sun.javadoc.
Doc
におけるメソッド
コメントをタグとして返します。
inlineTags()
- interface com.sun.javadoc.
Tag
におけるメソッド
タグ @link が埋め込まれたドキュメンテーションコメントに対して、Tag を含むテキストと SeeTag で構成される Tag の配列を返します。
innerClasses()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスの内部クラスを返します。
interfaces()
- interface com.sun.javadoc.
PackageDoc
におけるメソッド
このパッケージに含まれるインタフェースを取得します。
interfaces()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスで実装されているインタフェース、またはこのインタフェースで extends 節により拡張されているインタフェースを返します。
isAbstract()
- interface com.sun.javadoc.
MethodDoc
におけるメソッド
このメソッドが抽象メソッドの場合は、true を返します。
isAbstract()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスが abstract クラスの場合は、true を返します。
isClass()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目がクラスかどうかを検査します。
isConstructor()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目がコンストラクタかどうかを検査します。
isError()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目がエラークラスかどうかを検査します。
isException()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目が例外クラスかどうかを検査します。
isExternalizable()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスで
java.io.Externalizable
を実装している場合は、true を返します。
isField()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目がフィールドかどうかを検査します。
isFinal()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
このプログラム要素が final 指定されている場合は、true を返します。
isIncluded()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc がアクティブセットに含まれる場合は、true を返します。
isInterface()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目がインタフェースかどうかを検査します。
isMethod()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目が通常のメソッド (たとえば、コンストラクタではない) かどうかを検査します。
isNative()
- interface com.sun.javadoc.
ExecutableMemberDoc
におけるメソッド
このメソッドがネイティブメソッドの場合は、true を返します。
isOrdinaryClass()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目が通常のクラス (たとえば、インタフェース、例外クラス、エラークラスではない) かどうかを検査します。
isPackagePrivate()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
このプログラム要素がパッケージ内で有効な要素である場合は、true を返します。
isPrivate()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
このプログラム要素が private 指定されている場合は、true を返します。
isProtected()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
このプログラム要素が protected 指定されている場合は、true を返します。
isPublic()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
このプログラム要素が public 指定されている場合は、true を返します。
isSerializable()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスで
java.io.Serializable
を実装している場合は、true を返します。
isStatic()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
このプログラム要素が static 指定されている場合は、true を返します。
isSynchronized()
- interface com.sun.javadoc.
ExecutableMemberDoc
におけるメソッド
このメソッドが synchronized 指定されている場合は、true を返します。
isSynthetic()
- interface com.sun.javadoc.
MemberDoc
におけるメソッド
このメンバがコンパイラによって合成されている場合は、true を返します。
isTransient()
- interface com.sun.javadoc.
FieldDoc
におけるメソッド
このフィールドが transient 指定されている場合は、true を返します。
isVolatile()
- interface com.sun.javadoc.
FieldDoc
におけるメソッド
このフィールドが volatile 指定されている場合は、true を返します。
K
kind()
- interface com.sun.javadoc.
Tag
におけるメソッド
このタグの種類を返します。
L
label()
- interface com.sun.javadoc.
SeeTag
におけるメソッド
このメソッドは、see タグのラベルを返します。
M
MemberDoc
- interface com.sun.javadoc.
MemberDoc
.
特定の Java クラスの特定のメンバ (フィールド、コンストラクタ、メソッドのどれか) を表します。
MethodDoc
- interface com.sun.javadoc.
MethodDoc
.
特定の Java クラスの特定のメソッドを表します。
methods()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
クラス中のメソッドを返します。
modifiers()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
修飾子の文字列を取得します。
modifierSpecifier()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
修飾子を指定する整数を取得します。
N
name()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目の名前を返します。
name()
- interface com.sun.javadoc.
Tag
におけるメソッド
このタグの名前を返します。
name()
- interface com.sun.javadoc.
Parameter
におけるメソッド
このパラメータのローカル名を取得します。
O
optionLength(String)
- class com.sun.javadoc.
Doclet
における static メソッド
ドックレットに追加されたオプションをチェックします。
options()
- interface com.sun.javadoc.
RootDoc
におけるメソッド
コマンド行オプションを返します。
ordinaryClasses()
- interface com.sun.javadoc.
PackageDoc
におけるメソッド
このパッケージに含まれる通常のクラス (例外クラスとエラークラスを除く) を取得します。
overriddenClass()
- interface com.sun.javadoc.
MethodDoc
におけるメソッド
このメソッドをオーバーライドしているクラスを返します。
P
PackageDoc
- interface com.sun.javadoc.
PackageDoc
.
特定の Java パッケージを表します。
packageNamed(String)
- interface com.sun.javadoc.
RootDoc
におけるメソッド
指定されたパッケージ名に対応する PackageDoc を返します。
Parameter
- interface com.sun.javadoc.
Parameter
.
パラメータ情報 (パラメータの型と名前) です。
parameterComment()
- interface com.sun.javadoc.
ParamTag
におけるメソッド
パラメータのコメントを返します。
parameterName()
- interface com.sun.javadoc.
ParamTag
におけるメソッド
パラメータの名前を返します。
parameters()
- interface com.sun.javadoc.
ExecutableMemberDoc
におけるメソッド
引数情報を取得します。
ParamTag
- interface com.sun.javadoc.
ParamTag
.
特定のドキュメンテーションタグ @param を表します。
paramTags()
- interface com.sun.javadoc.
ExecutableMemberDoc
におけるメソッド
このメソッドに含まれる param タグを返します。
printError(String)
- interface com.sun.javadoc.
DocErrorReporter
におけるメソッド
エラーメッセージを表示し、エラー数をインクリメントします。
printNotice(String)
- interface com.sun.javadoc.
DocErrorReporter
におけるメソッド
メッセージを表示します。
printWarning(String)
- interface com.sun.javadoc.
DocErrorReporter
におけるメソッド
警告メッセージを表示し、警告数をインクリメントします。
ProgramElementDoc
- interface com.sun.javadoc.
ProgramElementDoc
.
Java プログラムの特定の要素 (クラス、インタフェース、フィールド、コンストラクタ、メソッドのどれか) を表します。
Q
qualifiedName()
- interface com.sun.javadoc.
ProgramElementDoc
におけるメソッド
完全修飾名を取得します。
qualifiedName()
- interface com.sun.javadoc.
ConstructorDoc
におけるメソッド
名前を取得します。
qualifiedTypeName()
- interface com.sun.javadoc.
Type
におけるメソッド
次元情報を除外した、型の修飾名を返します。
R
referencedClass()
- interface com.sun.javadoc.
SeeTag
におけるメソッド
このメソッドは、@see のクラス名の部分によって参照されるクラスを取得します。
referencedClassName()
- interface com.sun.javadoc.
SeeTag
におけるメソッド
このメソッドは、@see のクラス名の部分を取得します。
referencedMember()
- interface com.sun.javadoc.
SeeTag
におけるメソッド
このメソッドは、@see のプロトタイプ部分によって参照されるメンバを取得します。
referencedMemberName()
- interface com.sun.javadoc.
SeeTag
におけるメソッド
このメソッドは、@see のプロトタイプ部分によって参照されるメンバの名前を取得します。
referencedPackage()
- interface com.sun.javadoc.
SeeTag
におけるメソッド
このメソッドは、@see で参照されるパッケージを取得します。
returnType()
- interface com.sun.javadoc.
MethodDoc
におけるメソッド
戻り値の型を取得します。
RootDoc
- interface com.sun.javadoc.
RootDoc
.
このクラスには、javadoc の特定の実行時における情報 (特に、パッケージ、クラス、ユーザが指定したオプションなど) が格納されます。
S
SeeTag
- interface com.sun.javadoc.
SeeTag
.
ドキュメンテーションタグ @see を表します。
seeTags()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目に含まれる @see タグを返します。
SerialFieldTag
- interface com.sun.javadoc.
SerialFieldTag
.
ObjectStreamField によって定義される Serializable フィールドのドキュメントを作成します。
serialFieldTags()
- interface com.sun.javadoc.
FieldDoc
におけるメソッド
この FieldDoc 項目に含まれる serialField タグを返します。
serializableFields()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
クラスの Serializable フィールドを返します。
serializationMethods()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスの直列化メソッドを返します。
setRawCommentText(String)
- interface com.sun.javadoc.
Doc
におけるメソッド
未処理のコメントテキスト全体を設定します。
signature()
- interface com.sun.javadoc.
ExecutableMemberDoc
におけるメソッド
シグニチャーを取得します。
specifiedClasses()
- interface com.sun.javadoc.
RootDoc
におけるメソッド
コマンド行で指定されたクラスとインタフェースを返します。
specifiedPackages()
- interface com.sun.javadoc.
RootDoc
におけるメソッド
コマンド行で指定されたパッケージを返します。
start(RootDoc)
- class com.sun.javadoc.
Doclet
における static メソッド
ドキュメントを生成します。
subclassOf(ClassDoc)
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスが指定されたクラスのサブクラスかどうかを調べます。
superclass()
- interface com.sun.javadoc.
ClassDoc
におけるメソッド
このクラスのスーパークラスを返します。
T
Tag
- interface com.sun.javadoc.
Tag
.
特定のドキュメンテーションタグ (@since、@author、@version など) を表します。
tags()
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目に含まれるすべてのタグを返します。
tags(String)
- interface com.sun.javadoc.
Doc
におけるメソッド
この Doc 項目に含まれるタグのうち、指定された種類のタグを返します。
text()
- interface com.sun.javadoc.
Tag
におけるメソッド
このタグのテキスト (タグ名よりもあとの部分) を返します。
thrownExceptions()
- interface com.sun.javadoc.
ExecutableMemberDoc
におけるメソッド
このメソッドまたはコンストラクタがスローする例外を返します。
ThrowsTag
- interface com.sun.javadoc.
ThrowsTag
.
特定のドキュメンテーションタグ @throws または @exception を表します。
throwsTags()
- interface com.sun.javadoc.
ExecutableMemberDoc
におけるメソッド
このメソッドに含まれる throws タグを返します。
toString()
- interface com.sun.javadoc.
Tag
におけるメソッド
このオブジェクトを文字列に変換します。
toString()
- interface com.sun.javadoc.
Parameter
におけるメソッド
クラスの文字列表現を返します。
toString()
- interface com.sun.javadoc.
Type
におけるメソッド
型の文字列表現を返します。
Type
- interface com.sun.javadoc.
Type
.
Java の型を表します。
type()
- interface com.sun.javadoc.
FieldDoc
におけるメソッド
このフィールドの型を取得します。
type()
- interface com.sun.javadoc.
Parameter
におけるメソッド
このパラメータの型を取得します。
typeName()
- interface com.sun.javadoc.
Parameter
におけるメソッド
このパラメータの型名を取得します。
typeName()
- interface com.sun.javadoc.
Type
におけるメソッド
次元情報を除外した、型の非修飾名を返します。
V
validOptions(String[][], DocErrorReporter)
- class com.sun.javadoc.
Doclet
における static メソッド
オプションの引数が正しいかどうかをチェックします。
A
C
D
E
F
G
I
K
L
M
N
O
P
Q
R
S
T
V
パッケージ
クラス
階層ツリー
インデックス
ヘルプ
前 次
フレームあり
フレームなし