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

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

public interface Doc
extends Comparable

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

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

メソッドの概要
 String commentText()
          この Doc 項目のコメントテキストを返します。
 int compareTo(Object obj)
          このオブジェクトと指定されたオブジェクトの順序を比較します。
 Tag[] firstSentenceTags()
          コメントの最初の文をタグとして返します。
 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 項目が通常のクラス (インタフェース、例外、あるいはエラー以外のクラス) かどうかを示します。
 String name()
          この Doc 項目の非修飾名を返します。
 SourcePosition position()
          ドキュメント化されたエンティティのソース位置を返します。
 SeeTag[] seeTags()
          この Doc 項目に含まれる @see タグを返します。
 void setRawCommentText(String rawDocumentation)
          コメントのテキスト全体を未処理のまま設定します。
 Tag[] tags()
          この Doc 項目に含まれるすべてのタグを返します。
 Tag[] tags(String tagname)
          この Doc 項目に含まれるタグのうち、指定された種類のタグを返します。
 

メソッドの詳細

commentText

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


tags

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

戻り値:
この Doc 項目に含まれるすべてのタグを含んだ Tag の配列

tags

public Tag[] tags(String tagname)
この Doc 項目に含まれるタグのうち、指定された種類のタグを返します。 たとえば、「tagname」に「@serial」という値がある場合、「@serial」型のこの Doc 項目内のすべてのタグが返されます。

パラメータ:
tagname - 検索対象のタグ種の名前
戻り値:
kind() が tagname に一致するすべてのタグを含んだ Tag の配列

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 タグで終了します。ロケールの言語が英語でない場合、文の終わりは Tag java.text.BreakIterator#getSentenceInstance(Locale) java.text.BreakIterator.getSentenceInstance(Locale)} によって決定されます。

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

getRawCommentText

public String getRawCommentText()
コメントのテキスト全体を未処理のまま返します。タグはテキストとして含まれます。このメソッドは主に、内部化などの格納・取得操作で使われます。


setRawCommentText

public void setRawCommentText(String rawDocumentation)
コメントのテキスト全体を未処理のまま設定します。タグはテキストとして含まれます。このメソッドは主に、内部化などの格納・取得操作で使われます。


name

public String name()
この Doc 項目の非修飾名を返します。

戻り値:
名前

compareTo

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

このメソッドにより、Doc 項目を java.lang.Comparable として扱えるようになります。

定義:
インタフェース Comparable 内の compareTo
戻り値:
このオブジェクトが指定されたオブジェクトよりも小さい場合は負の整数。このオブジェクトと指定されたオブジェクトが等しい場合はゼロ。このオブジェクトが指定されたオブジェクトよりも大きい場合は正の整数
例外:
ClassCastException - 指定されたオブジェクトの型が、このオブジェクトと比較できない型の場合

isField

public boolean isField()
この Doc 項目がフィールドかどうかを示します。オーバーライドされない限り、常に false を返します。

戻り値:
フィールドを表す場合は true

isMethod

public boolean isMethod()
この Doc 項目が単純なメソッド (つまりコンストラクタ以外のメソッド) かどうかを示します。オーバーライドされない限り、常に false を返します。

戻り値:
単純なメソッドを表す場合は true、そうでない場合 (コンストラクタ、フィールド、クラスなどの場合) は false

isConstructor

public boolean isConstructor()
この Doc 項目がコンストラクタかどうかを示します。オーバーライドされない限り、常に false を返します。

戻り値:
コンストラクタを表す場合は true

isInterface

public boolean isInterface()
この Doc 項目がインタフェースかどうかを示します。オーバーライドされない限り、常に false を返します。

戻り値:
インタフェースを表す場合は true

isException

public boolean isException()
この Doc 項目が例外クラスかどうかを示します。オーバーライドされない限り、常に false を返します。

戻り値:
例外を表す場合は true

isError

public boolean isError()
この Doc 項目がエラークラスかどうかを示します。オーバーライドされない限り、常に false を返します。

戻り値:
エラーを表す場合は true

isOrdinaryClass

public boolean isOrdinaryClass()
この Doc 項目が通常のクラス (インタフェース、例外、あるいはエラー以外のクラス) かどうかを示します。オーバーライドされない限り、常に false を返します。

戻り値:
クラスを表す場合は true

isClass

public boolean isClass()
この Doc 項目がクラスかどうかを示します。ただし、インタフェースはクラスではありません。オーバーライドされない限り、常に false を返します。

戻り値:
クラスを表す場合は true

isIncluded

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


position

public SourcePosition position()
ドキュメント化されたエンティティのソース位置を返します。ただし、そのような位置にアクセスできない場合は null を返します。



バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.