Doclet API: インタフェース Doc

パッケージ

クラス

階層ツリー

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 内部クラス | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

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

すべてのスーパーインタフェース:: java.lang.Comparable, java.io.Serializable

既知のサブインタフェースの一覧:: ClassDoc, ConstructorDoc, ExecutableMemberDoc, FieldDoc, MemberDoc, MethodDoc, PackageDoc, ProgramElementDoc, RootDoc

public interface Doc
extends java.io.Serializable, java.lang.Comparable

すべての Doc クラスの抽象基底クラスです。Doc 項目は、コメントが付けられており、今回の javadoc の実行で処理された Java 言語の構成要素 (クラス、パッケージ、メソッドなど) を表します。すべての Doc 項目は一意であり、したがって == で比較することができます。

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

メソッドの概要

java.lang.String commentText()
          この Doc 項目のコメントテキストを返します。

int compareTo(java.lang.Object obj)
          このオブジェクトと指定されたオブジェクトの順序を比較します。

Tag[] firstSentenceTags()
          コメントの最初の文をタグとして返します。

java.lang.String getRawCommentText()
          未処理のコメントテキスト全体を返します。

Tag[] inlineTags()
          コメントをタグとして返します。

boolean isClass()
          この Doc 項目がクラスかどうかを検査します。

boolean isConstructor()
          この Doc 項目がコンストラクタかどうかを検査します。

boolean isError()
          この Doc 項目がエラークラスかどうかを検査します。

boolean isException()
          この Doc 項目が例外クラスかどうかを検査します。

boolean isField()
          この Doc 項目がフィールドかどうかを検査します。

boolean isIncluded()
          この Doc がアクティブセットに含まれる場合は、true を返します。

boolean isInterface()
          この Doc 項目がインタフェースかどうかを検査します。

boolean isMethod()
          この Doc 項目が通常のメソッド (たとえば、コンストラクタではない) かどうかを検査します。

boolean isOrdinaryClass()
          この Doc 項目が通常のクラス (たとえば、インタフェース、例外クラス、エラークラスではない) かどうかを検査します。

java.lang.String name()
          この Doc 項目の名前を返します。

SeeTag[] seeTags()
          この Doc 項目に含まれる @see タグを返します。

void setRawCommentText(java.lang.String rawDocumentation)
          未処理のコメントテキスト全体を設定します。

Tag[] tags()
          この Doc 項目に含まれるすべてのタグを返します。

Tag[] tags(java.lang.String tagname)
          この Doc 項目に含まれるタグのうち、指定された種類のタグを返します。

メソッドの詳細

commentText

public java.lang.String commentText()

この Doc 項目のコメントテキストを返します。タグは削除されます。

seeTags

public SeeTag[] seeTags()

この Doc 項目に含まれる @see タグを返します。

戻り値:: すべての @see タグを含んだ SeeTag の配列

inlineTags

public Tag[] inlineTags()

コメントをタグとして返します。通常のタグではなく、インラインタグ ({@link reference} タグ) が含まれます。プレーンテキストの各セクションは、種類「Text」の Tag として表されます。インラインタグは、種類「link」の SeeTag として表されます。

戻り値:: コメントを表す Tag の配列

firstSentenceTags

public Tag[] firstSentenceTags()

コメントの最初の文をタグとして返します。通常のタグではなく、インラインタグ ({@link reference} タグ) が含まれます。プレーンテキストの各セクションは、種類「Text」の Tag として表されます。インラインタグは、種類「link」の SeeTag として表されます。ロケールが英語の場合、最初の文は Java 言語仕様 (最初のバージョン) に記述されている規則によって決定されます。"この文は、後ろに空白文字、タブ、または行末記号が続く最初のピリオド、または最初のタグラインで終了します。" さらに、行は段落およびセクションの終わりを示す <p>、</p>、<h1>、<h2>、<h3>、<h4>、<h5>、<h6>、<hr>、<pre>、</pre> などの HTML タグで終了します。ロケールが英語でない場合、文の終わりは java.text.BreakIterator.getSentenceInstance(Locale) によって決定されます。

戻り値:: コメントの最初の文を表す Tag の配列

getRawCommentText

public java.lang.String getRawCommentText()

未処理のコメントテキスト全体を返します。タグもテキストとして含められます。主に、内部化などの格納および取り出し処理に使用されます。

setRawCommentText

public void setRawCommentText(java.lang.String rawDocumentation)

未処理のコメントテキスト全体を設定します。タグもテキストとして含められます。主に、内部化などの格納および取り出し処理に使用されます。

name

public java.lang.String name()

この Doc 項目の名前を返します。

戻り値:: Doc 項目の名前

compareTo

public int compareTo(java.lang.Object obj)

このオブジェクトと指定されたオブジェクトの順序を比較します。このオブジェクトが指定されたオブジェクトよりも小さい場合は負の整数、このオブジェクトと指定されたオブジェクトが等しい場合はゼロ、このオブジェクトが指定されたオブジェクトよりも大きい場合は正の整数が返されます。

Doc 項目が java.lang.Comparable となるようにするために使用します。

定義:: インタフェース java.lang.Comparable 内の compareTo

パラメータ:: o - 比較対象のオブジェクト
戻り値:: このオブジェクトが指定されたオブジェクトよりも小さい場合は負の整数、このオブジェクトと指定されたオブジェクトが等しい場合はゼロ、このオブジェクトが指定されたオブジェクトよりも大きい場合は正の整数
例外:: ClassCastException - 指定されたオブジェクトの型が、このオブジェクトと比較できない型の場合

isField

public boolean isField()

この Doc 項目がフィールドかどうかを検査します。オーバーライドされるまで false になります。

戻り値:: この Doc 項目がフィールドの場合は、true

isMethod

public boolean isMethod()

この Doc 項目が通常のメソッド (たとえば、コンストラクタではない) かどうかを検査します。オーバーライドされるまで false になります。

戻り値:: この Doc 項目がメソッドの場合は、true、それ以外 (コンストラクタ、フィールド、クラスなど) の場合は、false

isConstructor

public boolean isConstructor()

この Doc 項目がコンストラクタかどうかを検査します。オーバーライドされるまで false になります。

戻り値:: この Doc 項目がコンストラクタの場合は、true

isInterface

public boolean isInterface()

この Doc 項目がインタフェースかどうかを検査します。オーバーライドされるまで false になります。

戻り値:: この Doc 項目がインタフェースの場合は、true

isException

public boolean isException()

この Doc 項目が例外クラスかどうかを検査します。オーバーライドされるまで false になります。

戻り値:: この Doc 項目が例外クラスの場合は、true

isError

public boolean isError()

この Doc 項目がエラークラスかどうかを検査します。オーバーライドされるまで false になります。

戻り値:: この Doc 項目がエラークラスの場合は、true

isOrdinaryClass

public boolean isOrdinaryClass()

この Doc 項目が通常のクラス (たとえば、インタフェース、例外クラス、エラークラスではない) かどうかを検査します。オーバーライドされるまで false になります。

戻り値:: この Doc 項目がクラスの場合は、true

isClass

public boolean isClass()

この Doc 項目がクラスかどうかを検査します。注: インタフェースはクラスではありません。オーバーライドされるまで false になります。

戻り値:: この Doc 項目がクラスの場合は、true

isIncluded

public boolean isIncluded()

この Doc がアクティブセットに含まれる場合は、true を返します。