org.jboss.logging.processor.util

Class ElementHelper

java.lang.Object

org.jboss.logging.processor.util.ElementHelper

public final class ElementHelper
extends Object

An utility class to work with element.

Author:

Kevin Pollet - SERLI - (kevin.pollet@serli.com), James R. Perkins

Method Summary

Methods

Modifier and Type	Method and Description
static Collection<javax.lang.model.element.ExecutableElement>	findByName(Collection<javax.lang.model.element.ExecutableElement> methods, javax.lang.model.element.Name methodName) Returns a collection of methods with the same name.
static Collection<javax.lang.model.element.ExecutableElement>	findByName(Collection<javax.lang.model.element.ExecutableElement> methods, javax.lang.model.element.Name methodName, int paramCount) Returns a collection of methods with the same name.
static String	getPrimaryClassNamePrefix(javax.lang.model.element.TypeElement element) Returns the primary class simple name prefix for an element who represents a MessageBundle or MessageLogger interface.
static boolean	hasCause(Collection<? extends javax.lang.model.element.VariableElement> params) Checks to see if there is a cause parameter.
static boolean	inheritsMessage(Collection<javax.lang.model.element.ExecutableElement> methods, javax.lang.model.element.ExecutableElement method) Checks to see if the method has or inherits a Annotations.message() annotation.
static boolean	isAnnotatedWith(javax.lang.model.element.Element element, Class<? extends Annotation> clazz) Check if an element is annotated with the given annotation.
static boolean	isAssignableFrom(Class<?> type, javax.lang.model.element.TypeElement typeElement) Checks to see if the type is assignable from the type element.
static boolean	isAssignableFrom(Class<?> type, javax.lang.model.type.TypeMirror typeMirror) Checks to see if the type is assignable from the type mirror.
static boolean	isAssignableFrom(javax.lang.model.element.TypeElement typeElement, Class<?> type) Checks to see if the type element is assignable from the type.
static boolean	isAssignableFrom(javax.lang.model.type.TypeMirror typeMirror, Class<?> type) Checks to see id the type mirror is assignable from the type.
static boolean	isOverloaded(Collection<javax.lang.model.element.ExecutableElement> methods, javax.lang.model.element.ExecutableElement method) Checks to see if the method is overloaded.
static int	parameterCount(Collection<? extends javax.lang.model.element.VariableElement> params) Returns the number of parameters excluding the Annotations.cause() parameter and any Annotations.param() parameters if found.
static String	typeToString(Class<?> type) Converts a class type to a string recognizable by the Elements.getTypeElement(CharSequence).
static String	typeToString(String qualifiedType) Converts a qualified type name to a string recognizable by the Elements.getTypeElement(CharSequence).

Methods inherited from class java.lang.Object

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

Method Detail

isAnnotatedWith

public static boolean isAnnotatedWith(javax.lang.model.element.Element element,
                      Class<? extends Annotation> clazz)

Check if an element is annotated with the given annotation.

Parameters:

element - the element to look for the annotation on.

clazz - the annotation class

Returns:

true if the element is annotated, false otherwise

Throws:

NullPointerException - if element parameter is null

getPrimaryClassNamePrefix

public static String getPrimaryClassNamePrefix(javax.lang.model.element.TypeElement element)

Returns the primary class simple name prefix for an element who represents a MessageBundle or MessageLogger interface.

Parameters:

element - the element

Returns:

the translation file name prefix

Throws:

NullPointerException - if element is null

IllegalArgumentException - if element is not an interface

findByName

public static Collection<javax.lang.model.element.ExecutableElement> findByName(Collection<javax.lang.model.element.ExecutableElement> methods,
                                                                javax.lang.model.element.Name methodName)

Returns a collection of methods with the same name.

Parameters:

methods - the methods to process.

methodName - the method name to find.

Returns:

a collection of methods with the same name.

findByName

public static Collection<javax.lang.model.element.ExecutableElement> findByName(Collection<javax.lang.model.element.ExecutableElement> methods,
                                                                javax.lang.model.element.Name methodName,
                                                                int paramCount)

Returns a collection of methods with the same name.

Parameters:

methods - the methods to process.

methodName - the method name to find.

paramCount - the number of parameters the method must have.

Returns:

a collection of methods with the same name.

hasCause

public static boolean hasCause(Collection<? extends javax.lang.model.element.VariableElement> params)

Checks to see if there is a cause parameter.

Parameters:

params - the parameters to check.

Returns:

true if there is a cause, otherwise false.

parameterCount

public static int parameterCount(Collection<? extends javax.lang.model.element.VariableElement> params)

Returns the number of parameters excluding the Annotations.cause() parameter and any Annotations.param() parameters if found.

Parameters:

params - the parameters to get the count for.

Returns:

the number of parameters.

inheritsMessage

public static boolean inheritsMessage(Collection<javax.lang.model.element.ExecutableElement> methods,
                      javax.lang.model.element.ExecutableElement method)

Checks to see if the method has or inherits a Annotations.message() annotation.

Parameters:

methods - the method to search.

method - the method to check.

Returns:

true if the method has or inherits a message annotation, otherwise false.

isOverloaded

public static boolean isOverloaded(Collection<javax.lang.model.element.ExecutableElement> methods,
                   javax.lang.model.element.ExecutableElement method)

Checks to see if the method is overloaded. An overloaded method has a different parameter count based on the format parameters only. Parameters annotated with Annotations.cause() or Annotations.param() are not counted.

Parameters:

methods - the method to search.

method - the method to check.

Returns:

true if the method is overloaded, otherwise false.

isAssignableFrom

public static boolean isAssignableFrom(javax.lang.model.element.TypeElement typeElement,
                       Class<?> type)

Checks to see if the type element is assignable from the type.

Parameters:

typeElement - the type element to check.

type - the type to check.

Returns:

true if the type element is assignable from the type, otherwise false.

isAssignableFrom

public static boolean isAssignableFrom(javax.lang.model.type.TypeMirror typeMirror,
                       Class<?> type)

Checks to see id the type mirror is assignable from the type.

Parameters:

typeMirror - the type mirror to check.

type - the type to check.

Returns:

true if the type mirror is assignable from the type, otherwise false.

isAssignableFrom

public static boolean isAssignableFrom(Class<?> type,
                       javax.lang.model.element.TypeElement typeElement)

Checks to see if the type is assignable from the type element.

Parameters:

type - the type to check.

typeElement - the type element to check.

Returns:

true if the type is assignable from the type element, otherwise false.

isAssignableFrom

public static boolean isAssignableFrom(Class<?> type,
                       javax.lang.model.type.TypeMirror typeMirror)

Checks to see if the type is assignable from the type mirror.

Parameters:

type - the type to check.

typeMirror - the type mirror to check.

Returns:

true if the type is assignable from the type mirror, otherwise false.

typeToString

public static String typeToString(Class<?> type)

Converts a class type to a string recognizable by the Elements.getTypeElement(CharSequence). Essentially replaces any $'s to . (dots).

Parameters:

type - the type to convert.

Returns:

the qualified name of the type.

typeToString

public static String typeToString(String qualifiedType)

Converts a qualified type name to a string recognizable by the Elements.getTypeElement(CharSequence). Essentially replaces any $'s to . (dots).

Parameters:

qualifiedType - the qualified type name.

Returns:

the qualified name of the type.