org.seasar.aptina.commons.util
クラス ElementUtils

java.lang.Object
  org.seasar.aptina.commons.util.ElementUtils

public class ElementUtils
extends Object

Element を扱うユーティリティです．

作成者:

koichik

メソッドの概要

static AnnotationMirror	getAnnotationMirror(Element element, Class<? extends Annotation> annotationClass) Element に付けられた指定の AnnotationMirror を返します．
static AnnotationMirror	getAnnotationMirror(Element element, String annotationClassName) Element に付けられた指定の AnnotationMirror を返します．
static ExecutableElement	getConstructorElement(TypeElement typeElement) 型エレメントに定義されたデフォルトコンストラクタの実行可能エレメントを返します．
static ExecutableElement	getConstructorElement(TypeElement typeElement, Class<?>... parameterTypes) 型エレメントに定義されたコンストラクタの実行可能エレメントを返します．
static ExecutableElement	getConstructorElement(TypeElement typeElement, String... parameterTypeNames) 型エレメントに定義されたコンストラクタの実行可能エレメントを返します．
static VariableElement	getFieldElement(TypeElement typeElement, Field field) 型エレメントに定義されたフィールドの変数エレメントを返します．
static VariableElement	getFieldElement(TypeElement typeElement, String fieldName) 型エレメントに定義されたフィールドの変数エレメントを返します．
static ExecutableElement	getMethodElement(TypeElement typeElement, String methodName) 型エレメントに定義されたメソッドの実行可能エレメントを返します．
static ExecutableElement	getMethodElement(TypeElement typeElement, String methodName, Class<?>... parameterTypes) 型エレメントに定義されたメソッドの実行可能エレメントを返します．
static ExecutableElement	getMethodElement(TypeElement typeElement, String methodName, String... parameterTypeNames) 型エレメントに定義されたメソッドの実行可能エレメントを返します．
static TypeElement	getTypeElement(Elements elementUtils, Class<?> clazz) クラスに対応する TypeElement を返します．
static TypeElement	getTypeElement(Elements elementUtils, String className) クラス名に対応する TypeElement を返します．
static boolean	isSameTypes(Class<?>[] parameterTypes, List<? extends VariableElement> variableElements) 引数型の配列とVariableElementのリストの， それぞれの要素の型名が等しければ true を返します．
static boolean	isSameTypes(String[] typeNames, List<? extends VariableElement> variableElements) 型名の配列とVariableElementのリストの， それぞれの要素の型名が等しければ true を返します．
static List<String>	toSimpleNameList(List<? extends Element> elements) Element.getSimpleName() が返す名前の List を返します．
static String	toStringOfTypeParameterDecl(List<? extends TypeParameterElement> typeParameters) 型引数宣言の完全な文字列表現を返します．
static String	toStringOfTypeParameterNames(List<? extends TypeParameterElement> typeParameters) 型引数宣言の変数名の文字列表現を返します．

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

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

メソッドの詳細

getTypeElement

public static TypeElement getTypeElement(Elements elementUtils,
                                         Class<?> clazz)

クラスに対応する TypeElement を返します．

コンパイルのコンテキスト外でこのメソッドが返す TypeElement およびその Element.getEnclosedElements() が返す Element から， Elements.getDocComment(Element) を使って Javadoc コメントを取得することはできません．

パラメータ:

elementUtils - Elements

clazz - クラス

戻り値:

クラスに対応するTypeElement， 存在しない場合は null

getTypeElement

public static TypeElement getTypeElement(Elements elementUtils,
                                         String className)

クラス名に対応する TypeElement を返します．

コンパイルのコンテキスト外でこのメソッドが返す TypeElement およびその Element.getEnclosedElements() が返す Element から， Elements.getDocComment(Element) を使って Javadoc コメントを取得することはできません．

パラメータ:

elementUtils - Elements

className - クラスの完全限定名

戻り値:

クラスに対応するTypeElement， 存在しない場合は null

getFieldElement

public static VariableElement getFieldElement(TypeElement typeElement,
                                              Field field)

型エレメントに定義されたフィールドの変数エレメントを返します．

パラメータ:

typeElement - 型エレメント

field - フィールド

戻り値:

型エレメントに定義されたフィールドの変数エレメント． 存在しない場合は null

getFieldElement

public static VariableElement getFieldElement(TypeElement typeElement,
                                              String fieldName)

型エレメントに定義されたフィールドの変数エレメントを返します．

パラメータ:

typeElement - 型エレメント

fieldName - フィールド名

戻り値:

型エレメントに定義されたフィールドの変数エレメント． 存在しない場合は null

getConstructorElement

public static ExecutableElement getConstructorElement(TypeElement typeElement)

型エレメントに定義されたデフォルトコンストラクタの実行可能エレメントを返します．

パラメータ:

typeElement - 型エレメント

戻り値:

型エレメントに定義されたデフォルトコンストラクタの実行可能エレメント． 存在しない場合は null

getConstructorElement

public static ExecutableElement getConstructorElement(TypeElement typeElement,
                                                      Class<?>... parameterTypes)

型エレメントに定義されたコンストラクタの実行可能エレメントを返します．

引数型が型引数を持つ場合は getConstructorElement(TypeElement, String...) を使用してください．

パラメータ:

typeElement - 型エレメント

parameterTypes - 引数型の並び

戻り値:

型エレメントに定義されたコンストラクタの実行可能エレメント． 存在しない場合は null

getConstructorElement

public static ExecutableElement getConstructorElement(TypeElement typeElement,
                                                      String... parameterTypeNames)

型エレメントに定義されたコンストラクタの実行可能エレメントを返します．

引数がの型が配列の場合は， 要素型の名前の後に [] を連ねる形式と， [[LString; のような形式のどちらでも指定することができます．

引数型が型引数を持つ場合は "java.util.List<T>" のようにそのまま指定します．

パラメータ:

typeElement - 型エレメント

parameterTypeNames - 引数の型名の並び

戻り値:

型エレメントに定義されたコンストラクタの実行可能エレメント． 存在しない場合は null

getMethodElement

public static ExecutableElement getMethodElement(TypeElement typeElement,
                                                 String methodName)

型エレメントに定義されたメソッドの実行可能エレメントを返します．

パラメータ:

typeElement - 型エレメント

methodName - メソッド名

戻り値:

型エレメントに定義されたメソッドの実行可能エレメント．存在しない場合は null

getMethodElement

public static ExecutableElement getMethodElement(TypeElement typeElement,
                                                 String methodName,
                                                 Class<?>... parameterTypes)

型エレメントに定義されたメソッドの実行可能エレメントを返します．

引数型が型引数を持つ場合は getMethodElement(TypeElement, String, String...) を使用してください．

パラメータ:

typeElement - 型エレメント

methodName - メソッド名

parameterTypes - 引数型の並び

戻り値:

型エレメントに定義されたメソッドの実行可能エレメント． 存在しない場合は null

getMethodElement

public static ExecutableElement getMethodElement(TypeElement typeElement,
                                                 String methodName,
                                                 String... parameterTypeNames)

型エレメントに定義されたメソッドの実行可能エレメントを返します．

引数がの型が配列の場合は， 要素型の名前の後に [] を連ねる形式と， [[LString; のような形式のどちらでも指定することができます．

引数型が型引数を持つ場合は "java.util.List<T>" のようにそのまま指定します．

パラメータ:

typeElement - 型エレメント

methodName - メソッド名

parameterTypeNames - 引数の型名の並び

戻り値:

型エレメントに定義されたメソッドの実行可能エレメント． 存在しない場合は null

getAnnotationMirror

public static AnnotationMirror getAnnotationMirror(Element element,
                                                   Class<? extends Annotation> annotationClass)

Element に付けられた指定の AnnotationMirror を返します．

パラメータ:

element - 注釈の付けられた Element

annotationClass - アノテーションのクラス

戻り値:

Element に付けられた指定の AnnotationMirror

getAnnotationMirror

public static AnnotationMirror getAnnotationMirror(Element element,
                                                   String annotationClassName)

Element に付けられた指定の AnnotationMirror を返します．

パラメータ:

element - 注釈の付けられた Element

annotationClassName - アノテーションのクラス名

戻り値:

Element に付けられた指定の AnnotationMirror

isSameTypes

public static boolean isSameTypes(Class<?>[] parameterTypes,
                                  List<? extends VariableElement> variableElements)

引数型の配列とVariableElementのリストの， それぞれの要素の型名が等しければ true を返します．

パラメータ:

parameterTypes - 引数型の配列

variableElements -

戻り値:

二つのリストのそれぞれの要素の型がマッチすれば true

isSameTypes

public static boolean isSameTypes(String[] typeNames,
                                  List<? extends VariableElement> variableElements)

型名の配列とVariableElementのリストの， それぞれの要素の型名が等しければ true を返します．

パラメータ:

typeNames - 型名の配列

variableElements -

戻り値:

二つのリストのそれぞれの要素の型がマッチすれば true

toSimpleNameList

public static List<String> toSimpleNameList(List<? extends Element> elements)

Element.getSimpleName() が返す名前の List を返します．

パラメータ:

elements - Element の List

戻り値:

Element.getSimpleName() が返す名前の List

toStringOfTypeParameterDecl

public static String toStringOfTypeParameterDecl(List<? extends TypeParameterElement> typeParameters)

型引数宣言の完全な文字列表現を返します．

パラメータ:

typeParameters - 型引数の List

戻り値:

型引数宣言の完全な文字列表現

toStringOfTypeParameterNames

public static String toStringOfTypeParameterNames(List<? extends TypeParameterElement> typeParameters)

型引数宣言の変数名の文字列表現を返します．

パラメータ:

typeParameters - 型引数の List

戻り値:

型引数名の変数名の文字列表現