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

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

Comparable<Object>, Doc, ProgramElementDoc, Type

既知のサブインタフェースの一覧:

AnnotationTypeDoc

public interface ClassDoc
extends ProgramElementDoc, Type

特定の Java クラスまたはインタフェースを表し、クラス、クラスのコメントとタグ、およびクラスのメンバーに関する情報へのアクセスを提供します。ClassDoc は、javadoc の実行で処理された場合だけ存在します。クラスへの参照は、javadoc の実行でクラスが処理されたかどうかにかかわらず、Type を使って参照されます (可能な場合は、Type を ClassDoc に変換可能)。

導入されたバージョン:

1.2

関連項目:

Type

メソッドの概要

ConstructorDoc[]	constructors() このクラスの組み込みコンストラクタを返します。
ConstructorDoc[]	constructors(boolean filter) 指定されたアクセス修飾子オプションに従ってフィルタ処理された、このクラス内のコンストラクタを返します。
boolean	definesSerializableFields() Serializable フィールドが特別なクラスメンバー serialPersistentFields で明示的に定義されている場合は、true を返します。
FieldDoc[]	enumConstants() これが enum 型の場合は、enum 定数を返します。
FieldDoc[]	fields() このクラスまたはインタフェースの組み込みフィールドを返します。
FieldDoc[]	fields(boolean filter) 指定されたアクセス修飾子オプションに従ってフィルタ処理された、このクラスまたはインタフェースのフィールドを返します。
ClassDoc	findClass(String className) このクラス doc のコンテキスト内で、特定のクラスまたはインタフェースを検索します。
ClassDoc[]	importedClasses() 推奨されていません。 インポート宣言は、ここで公開する必要のない実装にかかわる詳細です。また、imported として宣言されたすべてのクラスが、シングルタイプインポート宣言を通じてインポートされるわけではありません。
PackageDoc[]	importedPackages() 推奨されていません。 インポート宣言は、ここで公開する必要のない実装にかかわる詳細です。また、このメソッドの戻り値の型は、すべてのオンデマンドタイプインポート宣言が返されるのを許可しません。
ClassDoc[]	innerClasses() このクラスまたはインタフェース内に組み込みの入れ子にされたクラスとインタフェースを返します。
ClassDoc[]	innerClasses(boolean filter) 指定されたアクセス修飾子オプションに従ってフィルタ処理された、このクラスまたはインタフェース内の入れ子になったクラスおよびインタフェースを返します。
ClassDoc[]	interfaces() このクラスで実装されているインタフェース、またはこのインタフェースで extends 節により拡張されているインタフェースを返します。
Type[]	interfaceTypes() このクラスで実装されているインタフェース、またはこのインタフェースで extends 節により拡張されているインタフェースを返します。
boolean	isAbstract() このクラスが abstract クラスの場合は、true を返します。
boolean	isExternalizable() このクラスが java.io.Externalizable を実装する場合、またはインタフェースが java.io.Externalizable を拡張する場合は true を返します。
boolean	isSerializable() このクラスが java.io.Serializable を実装する場合、またはインタフェースが java.io.Serializable を拡張する場合は true を返します。
MethodDoc[]	methods() このクラスまたはインタフェースの組み込みメソッドを返します。
MethodDoc[]	methods(boolean filter) 指定されたアクセス修飾子オプションに従ってフィルタ処理された、このクラスまたはインタフェースのメソッドを返します。
FieldDoc[]	serializableFields() このクラスまたはインタフェースの Serializable フィールドを返します。
MethodDoc[]	serializationMethods() このクラスまたはインタフェースの直列化メソッドを返します。
boolean	subclassOf(ClassDoc cd) このクラスが指定されたクラスのサブクラスかどうかを調べます。
ClassDoc	superclass() このクラスのスーパークラスを返します。
Type	superclassType() このクラスのスーパークラスを返します。
TypeVariable[]	typeParameters() このクラスまたはインタフェースの仮型パラメータを返します。
ParamTag[]	typeParamTags() このクラスまたはインタフェースの型パラメータタグを返します。

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

annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName

インタフェース 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

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

asAnnotationTypeDoc, asClassDoc, asParameterizedType, asTypeVariable, asWildcardType, dimension, isPrimitive, qualifiedTypeName, simpleTypeName, toString, typeName

メソッドの詳細

isAbstract

boolean isAbstract()

このクラスが abstract クラスの場合は、true を返します。すべてのインタフェースで true を返します。

isSerializable

boolean isSerializable()

このクラスが java.io.Serializable を実装する場合、またはインタフェースが java.io.Serializable を拡張する場合は true を返します。 java.io.Externalizable は java.io.Serializable を拡張するため、Externalizable オブジェクトは Serializable でもあります。

isExternalizable

boolean isExternalizable()

このクラスが java.io.Externalizable を実装する場合、またはインタフェースが java.io.Externalizable を拡張する場合は true を返します。

serializationMethods

MethodDoc[] serializationMethods()

このクラスまたはインタフェースの直列化メソッドを返します。

戻り値:

このクラスまたはインタフェースの直列化メソッドを表す MethodDoc オブジェクトの配列

serializableFields

FieldDoc[] serializableFields()

このクラスまたはインタフェースの Serializable フィールドを返します。

serial タグでドキュメント化されたデフォルトフィールドのリストか、serialPersistentField メンバーの FieldDoc を 1 つ返します。serialPersistentField の ObjectStreamField 配列の要素により定義された Serializable フィールドごとに serialField タグがあります。

戻り値:

このクラスまたはインタフェースの Serializable フィールドの FieldDoc オブジェクトの配列

関連項目:

definesSerializableFields(), SerialFieldTag

definesSerializableFields

boolean definesSerializableFields()

Serializable フィールドが特別なクラスメンバー serialPersistentFields で明示的に定義されている場合は、true を返します。

関連項目:

serializableFields(), SerialFieldTag

superclass

ClassDoc superclass()

このクラスのスーパークラスを返します。これがインタフェースの場合は、null を返します。

このメソッドは特定の総称型の構造要素に対応できません。代わりに、superclassType メソッドを使用する必要があります。

戻り値:

このクラスのスーパークラスの ClassDoc。スーパークラスがない場合は、null

関連項目:

superclassType()

superclassType

Type superclassType()

このクラスのスーパークラスを返します。これがインタフェースの場合は、null を返します。スーパークラスは、ClassDoc または ParametrizedType により表されます。

戻り値:

このクラスのスーパークラス、スーパークラスがない場合は、null

導入されたバージョン:

1.5

subclassOf

boolean subclassOf(ClassDoc cd)

このクラスが指定されたクラスのサブクラスかどうかを調べます。これがインタフェースの場合、java.lang.Object を除くすべてのクラスについて false を返します (互換性の理由から、この想定されていない動作を維持する必要がある)。

パラメータ:

cd - 対象となるスーパークラス

戻り値:

cd がこのクラスのスーパークラスの場合は、true

interfaces

ClassDoc[] interfaces()

このクラスで実装されているインタフェース、またはこのインタフェースで extends 節により拡張されているインタフェースを返します。継承されたインタフェースではなく、直接宣言されたインタフェースだけが含まれます。インタフェースがない場合は、空の配列を返します。

このメソッドは特定の総称型の構造要素に対応できません。代わりに、interfaceTypes メソッドを使用する必要があります。

戻り値:

インタフェースを表す ClassDoc オブジェクトの配列

関連項目:

interfaceTypes()

interfaceTypes

Type[] interfaceTypes()

このクラスで実装されているインタフェース、またはこのインタフェースで extends 節により拡張されているインタフェースを返します。継承されたインタフェースではなく、直接宣言されたインタフェースだけが含まれます。インタフェースがない場合は、空の配列を返します。

戻り値:

ClassDoc または ParametrizedType により個々に表されたインタフェースの配列

導入されたバージョン:

1.5

typeParameters

TypeVariable[] typeParameters()

このクラスまたはインタフェースの仮型パラメータを返します。注釈がない場合は、空の配列を返します。

戻り値:

このクラスまたはインタフェースの仮型パラメータ

導入されたバージョン:

1.5

typeParamTags

ParamTag[] typeParamTags()

このクラスまたはインタフェースの型パラメータタグを返します。注釈がない場合は、空の配列を返します。

戻り値:

このクラスまたはインタフェースの型パラメータタグ

導入されたバージョン:

1.5

fields

FieldDoc[] fields()

このクラスまたはインタフェースの組み込みフィールドを返します。これが enum 型の場合、enum 定数を除きます。

戻り値:

このクラスまたはインタフェースの組み込みフィールドを表す FieldDoc オブジェクトの配列

fields

FieldDoc[] fields(boolean filter)

指定されたアクセス修飾子オプションに従ってフィルタ処理された、このクラスまたはインタフェースのフィールドを返します。これが enum 型の場合、enum 定数を除きます。

パラメータ:

filter - 指定されたアクセス修飾子オプションに従ってフィルタ処理するには、true を指定する。アクセス修飾子オプションに関係なくすべてのフィールドを含めるには、false を指定する

戻り値:

このクラスまたはインタフェースの組み込みフィールドを表す FieldDoc オブジェクトの配列

enumConstants

FieldDoc[] enumConstants()

これが enum 型の場合は、enum 定数を返します。enum 定数がない場合、またはこれが enum 型でない場合は、空の配列を返します。

戻り値:

これが enum 型の場合は、enum 定数

methods

MethodDoc[] methods()

このクラスまたはインタフェースの組み込みメソッドを返します。このメソッドは、methods(true) と同じです。

戻り値:

このクラスまたはインタフェースの組み込みメソッドを表す MethodDoc オブジェクトの配列。コンストラクタまたは注釈型の要素は対象外

methods

MethodDoc[] methods(boolean filter)

指定されたアクセス修飾子オプションに従ってフィルタ処理された、このクラスまたはインタフェースのメソッドを返します。コンストラクタまたは注釈型の要素は対象外です。

パラメータ:

filter - 指定されたアクセス修飾子オプションに従ってフィルタ処理するには、true を指定する。アクセス修飾子オプションに関係なくすべてのメソッドを含めるには、false を指定する

戻り値:

このクラスまたはインタフェースの組み込みメソッドを表す MethodDoc オブジェクトの配列

constructors

ConstructorDoc[] constructors()

このクラスの組み込みコンストラクタを返します。ほかにコンストラクタがない場合は、引数を持たないデフォルトのコンストラクタを含む配列が返されます。これがインタフェースの場合は、空の配列を返します。

戻り値:

このクラスの組み込みコンストラクタを表す ConstructorDoc オブジェクトの配列

constructors

ConstructorDoc[] constructors(boolean filter)

指定されたアクセス修飾子オプションに従ってフィルタ処理された、このクラス内のコンストラクタを返します。ほかにコンストラクタがない場合は、引数を持たないデフォルトのコンストラクタを含む配列が返されます。

パラメータ:

filter - 指定されたアクセス修飾子オプションに従ってフィルタ処理するには、true を指定する。アクセス修飾子オプションに関係なくすべてのコンストラクタを含めるには、false を指定する

戻り値:

このクラスの組み込みコンストラクタを表す ConstructorDoc オブジェクトの配列

innerClasses

ClassDoc[] innerClasses()

このクラスまたはインタフェース内に組み込みの入れ子にされたクラスとインタフェースを返します。これには、静的な入れ子になったクラスと静的でない入れ子になったクラスの両方が含まれます。内部クラスは技術的に静的でないので、このメソッドは nestedClasses() と名前が付けられています。匿名およびローカルのクラスまたはインタフェースは含まれません。

戻り値:

このクラスまたはインタフェースで定義された組み込みクラスおよびインタフェースを表す ClassDoc オブジェクトの配列

innerClasses

ClassDoc[] innerClasses(boolean filter)

指定されたアクセス修飾子オプションに従ってフィルタ処理された、このクラスまたはインタフェース内の入れ子になったクラスおよびインタフェースを返します。これには、静的な入れ子になったクラスと静的でない入れ子になったクラスの両方が含まれます。これには、静的な入れ子および静的でない入れ子になったクラスは含まれますが、匿名クラスとローカルクラスは含まれません。

パラメータ:

filter - 指定されたアクセス修飾子オプションに従ってフィルタ処理するには、true を指定する。アクセス修飾子オプションに関係なくすべての入れ子のクラスを含めるには、false を指定する

戻り値:

このクラスまたはインタフェースで定義された組み込みクラスおよびインタフェースを表す ClassDoc オブジェクトのフィルタ処理された配列

findClass

ClassDoc findClass(String className)

このクラス doc のコンテキスト内で、特定のクラスまたはインタフェースを検索します。検索は、1. 修飾名、2. このクラスまたはインタフェースで入れ子になったもの、3. このパッケージ、4. インポートされたクラス、5. インポートされたパッケージの順で行われます。クラスが見つかった場合はその ClassDoc を返し、見つからなかった場合は null を返します。

importedClasses

@Deprecated
ClassDoc[] importedClasses()

推奨されていません。 インポート宣言は、ここで公開する必要のない実装にかかわる詳細です。また、imported として宣言されたすべてのクラスが、シングルタイプインポート宣言を通じてインポートされるわけではありません。

imported として宣言されたクラスとインタフェースのリストを取得します。このような宣言を Java 言語仕様では「シングルタイプインポート宣言」と呼びます。

戻り値:

imported として宣言されたクラスを表す ClassDoc の配列

importedPackages

@Deprecated
PackageDoc[] importedPackages()

推奨されていません。 インポート宣言は、ここで公開する必要のない実装にかかわる詳細です。また、このメソッドの戻り値の型は、すべてのオンデマンドタイプインポート宣言が返されるのを許可しません。

imported として宣言されたパッケージのリストを取得します。このような宣言を Java 言語仕様では「オンデマンドタイプインポート宣言」と呼びます。

戻り値:

imported として宣言されたパッケージを表す PackageDoc の配列