|
ドックレット API | ||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||
public interface ClassDoc
特定の Java クラスまたはインタフェースを表し、クラス、クラスのコメントとタグ、およびクラスのメンバに関する情報へのアクセスを提供します。ClassDoc は、javadoc の実行で処理された場合だけ存在します。クラスへの参照は、javadoc の実行でクラスが処理されたかどうかにかかわらず、Type を使って参照されます (可能な場合は、Type を ClassDoc に変換可能)。
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 |
| メソッドの詳細 |
|---|
boolean isAbstract()
boolean isSerializable()
java.io.Serializable を実装する場合、またはインタフェースが java.io.Serializable を拡張する場合は true を返します。
java.io.Externalizable は java.io.Serializable を拡張するため、Externalizable オブジェクトは Serializable でもあります。
boolean isExternalizable()
java.io.Externalizable を実装する場合、またはインタフェースが java.io.Externalizable を拡張する場合は true を返します。
MethodDoc[] serializationMethods()
FieldDoc[] serializableFields()
serial タグでドキュメント化されたデフォルトフィールドのリストか、serialPersistentField メンバの FieldDoc を 1 つ返します。serialPersistentField の ObjectStreamField 配列の要素により定義された Serializable フィールドごとに serialField タグがあります。
FieldDoc オブジェクトの配列definesSerializableFields(),
SerialFieldTagboolean definesSerializableFields()
serialPersistentFields で明示的に定義されている場合は、true を返します。
serializableFields(),
SerialFieldTagClassDoc superclass()
このメソッドは特定の汎用型の構造要素に対応できません。代わりに、superclassType メソッドを使用する必要があります。
superclassType()Type superclassType()
ClassDoc または ParametrizedType により表されます。
boolean subclassOf(ClassDoc cd)
java.lang.Object を除くすべてのクラスについて false を返します (互換性の理由から、この想定されていない動作を維持する必要がある)。
cd - 対象となるスーパークラス
ClassDoc[] interfaces()
このメソッドは特定の汎用型の構造要素に対応できません。代わりに、interfaceTypes を使用する必要があります。
interfaceTypes()Type[] interfaceTypes()
ClassDoc または ParametrizedType により個々に表されたインタフェースの配列TypeVariable[] typeParameters()
ParamTag[] typeParamTags()
FieldDoc[] fields()
FieldDoc[] fields(boolean filter)
filter - 指定されたアクセス修飾子オプションに従ってフィルタ処理するには、true を指定する。アクセス修飾子オプションに関係なくすべてのフィールドを含めるには、false を指定する
FieldDoc[] enumConstants()
MethodDoc[] methods()
methods(true) と同じです。
MethodDoc[] methods(boolean filter)
filter - 指定されたアクセス修飾子オプションに従ってフィルタ処理するには、true を指定する。アクセス修飾子オプションに関係なくすべてのメソッドを含めるには、false を指定する
ConstructorDoc[] constructors()
ConstructorDoc[] constructors(boolean filter)
filter - 指定されたアクセス修飾子オプションに従ってフィルタ処理するには、true を指定する。アクセス修飾子オプションに関係なくすべてのコンストラクタを含めるには、false を指定する
ClassDoc[] innerClasses()
nestedClasses() と名前が付けられています。匿名およびローカルのクラスまたはインタフェースは含まれません。
ClassDoc[] innerClasses(boolean filter)
filter - 指定されたアクセス修飾子オプションに従ってフィルタ処理するには、true を指定する。アクセス修飾子オプションに関係なくすべての入れ子のクラスを含めるには、false を指定する
ClassDoc findClass(String className)
@Deprecated ClassDoc[] importedClasses()
@Deprecated PackageDoc[] importedPackages()
|
ドックレット API | ||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||