com.sun.source.util

クラスTrees

java.lang.Object

com.sun.source.util.Trees

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

DocTrees

@Exported
public abstract class Trees
extends Object

JSR 199、JSR 269、およびTree APIをブリッジします。

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

コンストラクタ

コンストラクタと説明
Trees()

メソッドのサマリー

修飾子と型	メソッドと説明
abstract String	getDocComment(TreePath path) 指定されたTreePathによって識別されるTreeノードのドキュメンテーション・コメント(存在する場合)を取得します。
abstract Element	getElement(TreePath path) 指定されたTreePathによって識別されるTreeノードのElementを取得します。
abstract TypeMirror	getLub(CatchTree tree) catch節で宣言された例外パラメータのlubを取得します。
abstract TypeMirror	getOriginalType(ErrorType errorType) ErrorTypeオブジェクトの元の型を取得します。
abstract TreePath	getPath(CompilationUnitTree unit, Tree node) 指定されたコンパイル・ユニット内のツリー・ノードへのパスを取得します。
abstract TreePath	getPath(Element e) 指定されたElementのTreePathノードを取得します。
abstract TreePath	getPath(Element e, AnnotationMirror a) 指定されたElement上のAnnotationMirrorのTreePathノードを取得します。
abstract TreePath	getPath(Element e, AnnotationMirror a, AnnotationValue v) 指定されたElement上のAnnotationMirrorのAnnotationValueのTreePathノードを取得します。
abstract Scope	getScope(TreePath path) 指定されたTreePathによって識別されるTreeノードのScopeを取得します。
abstract SourcePositions	getSourcePositions() ソース位置を取得するためのユーティリティ・オブジェクトを取得します。
abstract Tree	getTree(Element element) 指定されたElementのTreeノードを取得します。
abstract Tree	getTree(Element e, AnnotationMirror a) 指定されたElement上のAnnotationMirrorのTreeノードを取得します。
abstract Tree	getTree(Element e, AnnotationMirror a, AnnotationValue v) 指定されたElement上のAnnotationMirrorのAnnotationValueのTreeノードを取得します。
abstract MethodTree	getTree(ExecutableElement method) 指定されたExecutableElementのMethodTreeノードを取得します。
abstract ClassTree	getTree(TypeElement element) 指定されたTypeElementのClassTreeノードを取得します。
abstract TypeMirror	getTypeMirror(TreePath path) 指定されたTreePathによって識別されるTreeノードのTypeMirrorを取得します。
static Trees	instance(JavaCompiler.CompilationTask task) 指定されたCompilationTaskのTreesオブジェクトを取得します。
static Trees	instance(ProcessingEnvironment env) 指定されたProcessingEnvironmentのTreesオブジェクトを取得します。
abstract boolean	isAccessible(Scope scope, Element member, DeclaredType type) 指定されたスコープ内で、指定された要素が、指定された型のメンバーとしてアクセス可能であるかどうかを判定します。
abstract boolean	isAccessible(Scope scope, TypeElement type) 指定されたスコープ内で、指定された型にアクセス可能であるかどうかを判定します。
abstract void	printMessage(Diagnostic.Kind kind, CharSequence msg, Tree t, CompilationUnitTree root) 指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します

クラス java.lang.Objectから継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

Trees

public Trees()

メソッドの詳細

instance

public static Trees instance(JavaCompiler.CompilationTask task)

指定されたCompilationTaskのTreesオブジェクトを取得します。

パラメータ:

task - Treesオブジェクトを取得するコンパイル・タスク

例外:

IllegalArgumentException - タスクがTrees APIをサポートしていない場合。

instance

public static Trees instance(ProcessingEnvironment env)

指定されたProcessingEnvironmentのTreesオブジェクトを取得します。

パラメータ:

env - Treesオブジェクトを取得する処理環境

例外:

IllegalArgumentException - envがTrees APIをサポートしていない場合。

getSourcePositions

public abstract SourcePositions getSourcePositions()

ソース位置を取得するためのユーティリティ・オブジェクトを取得します。

getTree

public abstract Tree getTree(Element element)

指定されたElementのTreeノードを取得します。ノードが見つからない場合はnullを返します。

getTree

public abstract ClassTree getTree(TypeElement element)

指定されたTypeElementのClassTreeノードを取得します。ノードが見つからない場合はnullを返します。

getTree

public abstract MethodTree getTree(ExecutableElement method)

指定されたExecutableElementのMethodTreeノードを取得します。ノードが見つからない場合はnullを返します。

getTree

public abstract Tree getTree(Element e,
                             AnnotationMirror a)

指定されたElement上のAnnotationMirrorのTreeノードを取得します。ノードが見つからない場合はnullを返します。

getTree

public abstract Tree getTree(Element e,
                             AnnotationMirror a,
                             AnnotationValue v)

指定されたElement上のAnnotationMirrorのAnnotationValueのTreeノードを取得します。ノードが見つからない場合はnullを返します。

getPath

public abstract TreePath getPath(CompilationUnitTree unit,
                                 Tree node)

指定されたコンパイル・ユニット内のツリー・ノードへのパスを取得します。

getPath

public abstract TreePath getPath(Element e)

指定されたElementのTreePathノードを取得します。ノードが見つからない場合はnullを返します。

getPath

public abstract TreePath getPath(Element e,
                                 AnnotationMirror a)

指定されたElement上のAnnotationMirrorのTreePathノードを取得します。ノードが見つからない場合はnullを返します。

getPath

public abstract TreePath getPath(Element e,
                                 AnnotationMirror a,
                                 AnnotationValue v)

指定されたElement上のAnnotationMirrorのAnnotationValueのTreePathノードを取得します。ノードが見つからない場合はnullを返します。

getElement

public abstract Element getElement(TreePath path)

指定されたTreePathによって識別されるTreeノードのElementを取得します。要素が無効な場合はnullを返します。

例外:

IllegalArgumentException - TreePathが、関連付けられたElementを持つ可能性があるTreeノードを識別しない場合。

getTypeMirror

public abstract TypeMirror getTypeMirror(TreePath path)

指定されたTreePathによって識別されるTreeノードのTypeMirrorを取得します。TypeMirrorが無効な場合はnullを返します。

例外:

IllegalArgumentException - TreePathが、関連付けられたTypeMirrorを持つ可能性があるTreeノードを識別しない場合。

getScope

public abstract Scope getScope(TreePath path)

指定されたTreePathによって識別されるTreeノードのScopeを取得します。Scopeが無効な場合はnullを返します。

getDocComment

public abstract String getDocComment(TreePath path)

指定されたTreePathによって識別されるTreeノードのドキュメンテーション・コメント(存在する場合)を取得します。ドキュメンテーション・コメントが見つからなかった場合はnullを返します。

関連項目:

DocTrees.getDocCommentTree(TreePath)

isAccessible

public abstract boolean isAccessible(Scope scope,
                                     TypeElement type)

指定されたスコープ内で、指定された型にアクセス可能であるかどうかを判定します。

パラメータ:

scope - チェック対象のスコープ

type - チェック対象の型

戻り値:

typeがアクセス可能な場合はtrue

isAccessible

public abstract boolean isAccessible(Scope scope,
                                     Element member,
                                     DeclaredType type)

指定されたスコープ内で、指定された要素が、指定された型のメンバーとしてアクセス可能であるかどうかを判定します。

パラメータ:

scope - チェック対象のスコープ

member - チェック対象のメンバー

type - メンバーがアクセス可能かどうかを判定する型

戻り値:

typeのmemberがアクセス可能な場合はtrue

getOriginalType

public abstract TypeMirror getOriginalType(ErrorType errorType)

ErrorTypeオブジェクトの元の型を取得します。

パラメータ:

errorType - 元の型を取得するerrorType。

戻り値:

元の型に対応するjavax.lang.model.type.TypeMirror、ErrorTypeで置き換えられる。

printMessage

public abstract void printMessage(Diagnostic.Kind kind,
                                  CharSequence msg,
                                  Tree t,
                                  CompilationUnitTree root)

指定されたコンパイル単位内のツリーの位置に、指定された種類のメッセージを出力します

パラメータ:

kind - メッセージの種類

msg - メッセージ、ない場合は空の文字列

t - 位置のヒントとして使用するツリー

root - ツリーを格納するコンパイル・ユニット

getLub

public abstract TypeMirror getLub(CatchTree tree)

catch節で宣言された例外パラメータのlubを取得します。

パラメータ:

tree - catch節のツリー

戻り値:

例外パラメータのlub