public interface Doc extends Comparable<Object>
修飾子と型 | メソッドと説明 |
---|---|
String |
commentText()
このDoc項目のコメント・テキストを返します。
|
int |
compareTo(Object obj)
このdocオブジェクトと指定されたオブジェクトの順序を比較します。
|
Tag[] |
firstSentenceTags()
コメントの最初の文をタグの配列として返します。
|
String |
getRawCommentText()
コメントのテキスト全体を未処理のまま返します。
|
Tag[] |
inlineTags()
コメントをタグの配列として返します。
|
boolean |
isAnnotationType()
このDoc項目が注釈型かどうかを示します。
|
boolean |
isAnnotationTypeElement()
このDoc項目が注釈型の要素かどうかを示します。
|
boolean |
isClass()
このDoc項目がインタフェースまたは注釈型ではなく、クラス型かどうかを示します。
|
boolean |
isConstructor()
このDoc項目がコンストラクタかどうかを示します。
|
boolean |
isEnum()
このDoc項目がenum型かどうかを示します。
|
boolean |
isEnumConstant()
このDoc項目がenum定数かどうかを示します。
|
boolean |
isError()
このDoc項目がエラー・クラスかどうかを示します。
|
boolean |
isException()
このDoc項目が例外クラスかどうかを示します。
|
boolean |
isField()
このDoc項目がフィールド(ただし、enum定数ではない)かどうかを示します。
|
boolean |
isIncluded()
このDoc項目が結果セットに組み込まれる場合、trueを返します。
|
boolean |
isInterface()
このDoc項目がインタフェース(ただし、注釈型ではない)かどうかを示します。
|
boolean |
isMethod()
このDoc項目がメソッド(ただし、コンストラクタまたは注釈型の要素ではない)かどうかを示します。
|
boolean |
isOrdinaryClass()
このDoc項目が通常のクラスかどうかを示します。
|
String |
name()
このDoc項目の非修飾名を返します。
|
SourcePosition |
position()
対応する宣言の最初の行のソース位置を返します。ソース位置にアクセスできない場合はnullを返します。
|
SeeTag[] |
seeTags()
このDoc項目に含まれるsee alsoタグを返します。
|
void |
setRawCommentText(String rawDocumentation)
コメントのテキスト全体を未処理のまま設定します。
|
Tag[] |
tags()
このDoc項目に含まれるすべてのタグを返します。
|
Tag[] |
tags(String tagname)
このDoc項目に含まれる指定された種類のタグを返します。
|
String commentText()
Tag[] tags(String tagname)
tagname
- 検索対象のタグ種の名前。SeeTag[] seeTags()
Tag[] inlineTags()
Tag
として表されます。インライン・タグは、種類「@see」および名前「@link」のSeeTag
として表されます。Tag
の配列Tag[] firstSentenceTags()
Tag
として表されます。インライン・タグは、種類「@see」および名前「@link」のSeeTag
として表されます。
ロケールが英語の場合、最初の文はJava言語仕様(最初のバージョン)に記述されている規則によって決定されます。"この文は、直後にスペース、タブ、または改行が続く最初のピリオド、または最初のタグ・ラインで終了します。"さらに、行はブロックHTMLタグで終了します。<p> </p> <h1> <h2> <h3> <h4> <h5> <h6> <hr> <pre>または</pre>。ロケールの言語が英語でない場合、文の終わりはBreakIterator.getSentenceInstance(Locale)
によって決定されます。
Tag
の配列String getRawCommentText()
void setRawCommentText(String rawDocumentation)
String name()
int compareTo(Object obj)
このメソッドは、Comparable
インタフェースを満たします。
compareTo
、インタフェース: Comparable<Object>
obj
- 比較対象のObject
。ClassCastException
- 指定されたオブジェクトの型が、このオブジェクトと比較できない型の場合。boolean isField()
boolean isEnumConstant()
boolean isConstructor()
boolean isMethod()
boolean isAnnotationTypeElement()
boolean isInterface()
boolean isException()
boolean isError()
boolean isEnum()
boolean isAnnotationType()
boolean isOrdinaryClass()
boolean isClass()
boolean isIncluded()
SourcePosition position()
バグまたは機能を送信
Java は米国ならびにその他の国における Oracle Corporation およびその関連企業の商標または登録商標です。
Copyright © 1993, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.