-
- すべてのスーパー・インタフェース:
Comparable<Object>
,Doc
,ProgramElementDoc
,Type
- 既知のすべてのサブインタフェース:
AnnotationTypeDoc
非推奨です。このパッケージの宣言は、パッケージjdk.javadoc.doclet
の宣言で置き換えられました。 詳細は、そのパッケージのマニュアルの「移行ガイド」を参照してください。
@Deprecated public interface ClassDoc extends ProgramElementDoc, Type
特定のJavaクラスまたはインタフェースを表し、クラス、クラスのコメントとタグ、およびクラスのメンバーに関する情報へのアクセスを提供します。 ClassDocは、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()
非推奨。このクラスで実装されているインタフェース、またはこのインタフェースで拡張されているインタフェースを返します。Type[]
interfaceTypes()
非推奨。このクラスで実装されているインタフェース、またはこのインタフェースで拡張されているインタフェースを返します。boolean
isAbstract()
非推奨。このクラスがabstractクラスの場合は、trueを返します。boolean
isExternalizable()
非推奨。このクラスがjava.io.Externalizable
を実装する場合、またはインタフェースが拡張する場合、trueを返します。boolean
isSerializable()
非推奨。このクラスが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.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.ProgramElementDocから継承されたメソッド
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
-
インタフェース com.sun.javadoc.Typeから継承されたメソッド
asAnnotatedType, asAnnotationTypeDoc, asClassDoc, asParameterizedType, asTypeVariable, asWildcardType, dimension, getElementType, isPrimitive, qualifiedTypeName, simpleTypeName, toString, typeName
-
-
-
-
メソッドの詳細
-
isAbstract
boolean isAbstract()
非推奨。このクラスがabstractクラスの場合は、trueを返します。 すべてのインタフェースでtrueを返します。- 戻り値:
- このクラスが抽象クラスの場合はtrue。 すべてのインタフェースでtrueを返します。
-
isSerializable
boolean isSerializable()
非推奨。このクラスがjava.io.Serializable
を実装する場合、またはインタフェースが拡張する場合、trueを返します。java.io.Externalizable
はjava.io.Serializable
を拡張するため、ExternalizableオブジェクトはSerializableでもあります。- 戻り値:
java.io.Serializable
をこのクラスが実装またはインタフェースが拡張する場合はtrue。
-
isExternalizable
boolean isExternalizable()
非推奨。このクラスがjava.io.Externalizable
を実装する場合、またはインタフェースが拡張する場合、trueを返します。- 戻り値:
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を返します。- 戻り値:
- 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()
非推奨。このクラスで実装されているインタフェース、またはこのインタフェースで拡張されているインタフェースを返します。 継承されたインタフェースではなく、直接宣言されたインタフェースだけが含まれます。 インタフェースがない場合は、空の配列を返します。このメソッドは、特定のジェネリック型の構造に対応できません。
interfaceTypes
メソッドを代わりに使用してください。- 戻り値:
- インタフェースを表すClassDocオブジェクトの配列。
- 関連項目:
interfaceTypes()
-
interfaceTypes
Type[] interfaceTypes()
非推奨。このクラスで実装されているインタフェース、またはこのインタフェースで拡張されているインタフェースを返します。 継承されたインタフェースではなく、直接宣言されたインタフェースだけが含まれます。 インタフェースがない場合は、空の配列を返します。- 戻り値:
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を返します。- パラメータ:
className
- Stringとして検索するクラス名を指定します。- 戻り値:
- 見つかった場合はClassDoc、見つからない場合はnull。
-
importedClasses
@Deprecated ClassDoc[] importedClasses()
非推奨です。 インポート宣言は、ここで公開する必要のない実装にかかわる詳細です。 また、importedとして宣言されたすべてのクラスが、シングルタイプインポート宣言を通じてインポートされるわけではありません。importedとして宣言されたクラスとインタフェースのリストを取得します。 このような宣言を『Java™言語仕様』では「シングルタイプインポート宣言」と呼びます。- 戻り値:
- importedとして宣言されたクラスを表すClassDocの配列。
-
importedPackages
@Deprecated PackageDoc[] importedPackages()
非推奨です。 インポート宣言は、ここで公開する必要のない実装にかかわる詳細です。 また、このメソッドの戻り値の型は、すべてのオンデマンド・タイプ・インポート宣言が返されるのを許可しません。importedとして宣言されたパッケージのリストを取得します。 このような宣言を『Java™言語仕様』では「オンデマンド・タイプ・インポート宣言」と呼びます。- 戻り値:
- importedとして宣言されたパッケージを表すPackageDocの配列。
-
-