java.lang.Object
- com.sun.source.util.DocTreeScanner<R,P>

すべての実装されたインタフェース:

DocTreeVisitor<R,P>

直系の既知のサブクラス:

DocTreePathScanner
```
public class DocTreeScanner<R,P>
extends Object
implements DocTreeVisitor<R,P>
```
すべての子ツリー・ノードを巡回するTreeVisitorです。特定の型のノードを巡回するには、対応するvisitXYZメソッドを単にオーバーライドします。独自のメソッド内では、super.visitXYZを呼び出して、下位ノードを巡回します。
visitXYZメソッドのデフォルトの実装では、次の結果になります。
- 訪問するノードに子がない場合、結果はnullになります。
- 巡回対象のノードが1つの子を持つ場合、その子でscanを呼び出した結果と同じになります。子は、単一のノードでも、ノードのリストでもかまいません。
- 巡回対象のノードが複数の子を持つ場合、それぞれの子で順番にscanを呼び出し、2番目以降の各スキャンの結果を、それまでの累積的な結果と結合することで結果が得られます。これは、reduce(R, R)メソッドによる結果と同様です。それぞれの子は、単一のノードでも、ノードのリストでもかまいません。 reduceメソッドのデフォルトの動作では、visitXYZメソッドの結果は、最後にスキャンされた子の結果になります。
ツリー内のエラー・ノードの数をカウントする例を次に示します。
```
   class CountErrors extends DocTreeScanner<Integer,Void> {
      @Override
      public Integer visitErroneous(ErroneousTree node, Void p) {
          return 1;
      }
      @Override
      public Integer reduce(Integer r1, Integer r2) {
          return (r1 == null ? 0 : r1) + (r2 == null ? 0 : r2);
      }
   }
 
```
導入されたバージョン:

1.8

コンストラクタのサマリー

コンストラクタ
コンストラクタ説明

DocTreeScanner()

メソッドのサマリー

すべてのメソッドインスタンス・メソッド具象メソッド
修飾子と型	メソッド	説明
`R`	`reduce(R r1, R r2)`	2つの結果を1つの結合された結果にします。
`R`	`scan(DocTree node, P p)`	単一ノードをスキャンします。
`R`	`scan(Iterable<? extends DocTree> nodes, P p)`	一連のノードをスキャンします。
`R`	`visitAttribute(AttributeTree node, P p)`	AttributeTreeノードにアクセスします。
`R`	`visitAuthor(AuthorTree node, P p)`	AuthorTreeノードにアクセスします。
`R`	`visitComment(CommentTree node, P p)`	CommentTreeノードにアクセスします。
`R`	`visitDeprecated(DeprecatedTree node, P p)`	DeprecatedTreeノードにアクセスします。
`R`	`visitDocComment(DocCommentTree node, P p)`	DocCommentTreeノードにアクセスします。
`R`	`visitDocRoot(DocRootTree node, P p)`	DocRootTreeノードにアクセスします。
`R`	`visitDocType(DocTypeTree node, P p)`	DocTypeTreeノードにアクセスします。
`R`	`visitEndElement(EndElementTree node, P p)`	EndElementTreeノードにアクセスします。
`R`	`visitEntity(EntityTree node, P p)`	EntityTreeノードにアクセスします。
`R`	`visitErroneous(ErroneousTree node, P p)`	ErroneousTreeノードにアクセスします。
`R`	`visitHidden(HiddenTree node, P p)`	HiddenTreeノードにアクセスします。
`R`	`visitIdentifier(IdentifierTree node, P p)`	IdentifierTreeノードにアクセスします。
`R`	`visitIndex(IndexTree node, P p)`	IndexTreeノードにアクセスします。
`R`	`visitInheritDoc(InheritDocTree node, P p)`	InheritDocTreeノードにアクセスします。
`R`	`visitLink(LinkTree node, P p)`	LinkTreeノードにアクセスします。
`R`	`visitLiteral(LiteralTree node, P p)`	LiteralTreeノードにアクセスします。
`R`	`visitOther(DocTree node, P p)`	不明なタイプのDocTreeノードにアクセスします。
`R`	`visitParam(ParamTree node, P p)`	ParamTreeノードにアクセスします。
`R`	`visitProvides(ProvidesTree node, P p)`	ProvidesTreeノードにアクセスします。
`R`	`visitReference(ReferenceTree node, P p)`	ReferenceTreeノードにアクセスします。
`R`	`visitReturn(ReturnTree node, P p)`	ReturnTreeノードにアクセスします。
`R`	`visitSee(SeeTree node, P p)`	SeeTreeノードにアクセスします。
`R`	`visitSerial(SerialTree node, P p)`	SerialTreeノードにアクセスします。
`R`	`visitSerialData(SerialDataTree node, P p)`	SerialDataTreeノードにアクセスします。
`R`	`visitSerialField(SerialFieldTree node, P p)`	SerialFieldTreeノードにアクセスします。
`R`	`visitSince(SinceTree node, P p)`	SinceTreeノードにアクセスします。
`R`	`visitStartElement(StartElementTree node, P p)`	StartElementTreeノードにアクセスします。
`R`	`visitSummary(SummaryTree node, P p)`	SummaryTreeノードにアクセスします。
`R`	`visitText(TextTree node, P p)`	TextTreeノードにアクセスします。
`R`	`visitThrows(ThrowsTree node, P p)`	ThrowsTreeノードにアクセスします。
`R`	`visitUnknownBlockTag(UnknownBlockTagTree node, P p)`	UnknownBlockTagTreeノードにアクセスします。
`R`	`visitUnknownInlineTag(UnknownInlineTagTree node, P p)`	UnknownInlineTagTreeノードにアクセスします。
`R`	`visitUses(UsesTree node, P p)`	UsesTreeノードにアクセスします。
`R`	`visitValue(ValueTree node, P p)`	ValueTreeノードにアクセスします。
`R`	`visitVersion(VersionTree node, P p)`	VersionTreeTreeノードにアクセスします。

クラスjava.langで宣言されたメソッド。オブジェクト
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - DocTreeScanner
```
public DocTreeScanner()
```
- メソッドの詳細
  - scan
```
public R scan(DocTree node,
              P p)
```
    単一ノードをスキャンします。
    
    パラメータ:
    
    node - スキャンされるノード
    
    p - ビジット・メソッドに渡されるパラメータ値
    
    戻り値:
    
    訪問メソッドからの結果値
  - scan
```
public R scan(Iterable<? extends DocTree> nodes,
              P p)
```
    一連のノードをスキャンします。
    
    パラメータ:
    
    nodes - スキャンされるノード
    
    p - 各ノードのビジット・メソッドに渡されるパラメータ値
    
    戻り値:
    
    ビジット・メソッドからの結合された戻り値。値は、reduceメソッドを使用して結合されます。
  - reduce
```
public R reduce(R r1,
                R r2)
```
    2つの結果を1つの結合された結果にします。デフォルトの実装では、1番目のパラメータを返します。メソッドの一般的な規約によれば、メソッドはどのようなアクションを実行してもかまいません。
    
    パラメータ:
    
    r1 - 結合される最初の値
    
    r2 - 結合する値の2番目
    
    戻り値:
    
    2つのパラメータを結合した結果
  - visitAttribute
```
public R visitAttribute(AttributeTree node,
                        P p)
```
    AttributeTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitAttribute
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitAuthor
```
public R visitAuthor(AuthorTree node,
                     P p)
```
    AuthorTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitAuthor
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitComment
```
public R visitComment(CommentTree node,
                      P p)
```
    CommentTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitComment
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitDeprecated
```
public R visitDeprecated(DeprecatedTree node,
                         P p)
```
    DeprecatedTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitDeprecated
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitDocComment
```
public R visitDocComment(DocCommentTree node,
                         P p)
```
    DocCommentTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitDocComment
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitDocRoot
```
public R visitDocRoot(DocRootTree node,
                      P p)
```
    DocRootTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitDocRoot
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitDocType
```
public R visitDocType(DocTypeTree node,
                      P p)
```
    DocTypeTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitDocType
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitEndElement
```
public R visitEndElement(EndElementTree node,
                         P p)
```
    EndElementTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitEndElement
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitEntity
```
public R visitEntity(EntityTree node,
                     P p)
```
    EntityTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitEntity
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitErroneous
```
public R visitErroneous(ErroneousTree node,
                        P p)
```
    ErroneousTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitErroneous
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitHidden
```
public R visitHidden(HiddenTree node,
                     P p)
```
    HiddenTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitHidden
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitIdentifier
```
public R visitIdentifier(IdentifierTree node,
                         P p)
```
    IdentifierTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitIdentifier
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitIndex
```
public R visitIndex(IndexTree node,
                    P p)
```
    IndexTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitIndex
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitInheritDoc
```
public R visitInheritDoc(InheritDocTree node,
                         P p)
```
    InheritDocTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitInheritDoc
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitLink
```
public R visitLink(LinkTree node,
                   P p)
```
    LinkTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitLink
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitLiteral
```
public R visitLiteral(LiteralTree node,
                      P p)
```
    LiteralTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitLiteral
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitParam
```
public R visitParam(ParamTree node,
                    P p)
```
    ParamTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitParam
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitProvides
```
public R visitProvides(ProvidesTree node,
                       P p)
```
    ProvidesTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitProvides
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitReference
```
public R visitReference(ReferenceTree node,
                        P p)
```
    ReferenceTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitReference
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitReturn
```
public R visitReturn(ReturnTree node,
                     P p)
```
    ReturnTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitReturn
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitSee
```
public R visitSee(SeeTree node,
                  P p)
```
    SeeTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitSee
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitSerial
```
public R visitSerial(SerialTree node,
                     P p)
```
    SerialTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitSerial
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitSerialData
```
public R visitSerialData(SerialDataTree node,
                         P p)
```
    SerialDataTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitSerialData
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitSerialField
```
public R visitSerialField(SerialFieldTree node,
                          P p)
```
    SerialFieldTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitSerialField
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitSince
```
public R visitSince(SinceTree node,
                    P p)
```
    SinceTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitSince
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitStartElement
```
public R visitStartElement(StartElementTree node,
                           P p)
```
    StartElementTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitStartElement
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitSummary
```
public R visitSummary(SummaryTree node,
                      P p)
```
    SummaryTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitSummary
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
    
    導入されたバージョン:
    
    10
  - visitText
```
public R visitText(TextTree node,
                   P p)
```
    TextTreeノードにアクセスします。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitText
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitThrows
```
public R visitThrows(ThrowsTree node,
                     P p)
```
    ThrowsTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitThrows
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitUnknownBlockTag
```
public R visitUnknownBlockTag(UnknownBlockTagTree node,
                              P p)
```
    UnknownBlockTagTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitUnknownBlockTag
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitUnknownInlineTag
```
public R visitUnknownInlineTag(UnknownInlineTagTree node,
                               P p)
```
    UnknownInlineTagTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitUnknownInlineTag
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitUses
```
public R visitUses(UsesTree node,
                   P p)
```
    UsesTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitUses
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitValue
```
public R visitValue(ValueTree node,
                    P p)
```
    ValueTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitValue
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitVersion
```
public R visitVersion(VersionTree node,
                      P p)
```
    VersionTreeTreeノードにアクセスします。この実装では、子を左から右にスキャンします。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitVersion
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果
  - visitOther
```
public R visitOther(DocTree node,
                    P p)
```
    不明なタイプのDocTreeノードにアクセスします。これは、一連のタグが展開され、新しい種類のノードがDocTree階層に追加された場合に発生する可能性があります。この実装ではnullが返されます。
    
    定義:
    
    インタフェースDocTreeVisitor<R,P>内のvisitOther
    
    パラメータ:
    
    node - 訪問中のノード
    
    p - パラメータ値
    
    戻り値:
    
    スキャン結果

クラスDocTreeScanner<R,​P>

コンストラクタのサマリー

メソッドのサマリー

クラスjava.langで宣言されたメソッド。オブジェクト

コンストラクタの詳細

DocTreeScanner

メソッドの詳細

scan

scan

reduce

visitAttribute

visitAuthor

visitComment

visitDeprecated

visitDocComment

visitDocRoot

visitDocType

visitEndElement

visitEntity

visitErroneous

visitHidden

visitIdentifier

visitIndex

visitInheritDoc

visitLink

visitLiteral

visitParam

visitProvides

visitReference

visitReturn

visitSee

visitSerial

visitSerialData

visitSerialField

visitSince

visitStartElement

visitSummary

visitText

visitThrows

visitUnknownBlockTag

visitUnknownInlineTag

visitUses

visitValue

visitVersion

visitOther

クラスDocTreeScanner<R,P>