org.jboss.logging.processor.apt

Class ParameterFactory.AptParameter

java.lang.Object

org.jboss.logging.processor.apt.AbstractMessageObjectType

org.jboss.logging.processor.apt.ParameterFactory.AptParameter

All Implemented Interfaces:

java.lang.Comparable<Parameter>, MessageObject, MessageObjectType, Parameter

Enclosing class:

ParameterFactory

private static class ParameterFactory.AptParameter
extends AbstractMessageObjectType
implements Parameter

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.logging.processor.model.Parameter

Parameter.ParameterType

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	formatterClass
private boolean	isVarArgs
private javax.lang.model.element.VariableElement	param
private java.lang.Class<?>	paramClass
private Parameter.ParameterType	parameterType
private Pos	pos
private java.lang.String	qualifiedType
private Transform	transform

Fields inherited from class org.jboss.logging.processor.apt.AbstractMessageObjectType

elements, typeMirror, types

Constructor Summary

Constructors

Constructor and Description
AptParameter(javax.lang.model.util.Elements elements, javax.lang.model.util.Types types, java.lang.String qualifiedType, javax.lang.model.element.VariableElement param, java.lang.String formatterClass, boolean isVarArgs) Only allow construction from within the parent class.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Parameter other)
boolean	equals(java.lang.Object obj)
java.lang.String	formatterClass() The formatter class, or null if there is none.
int	hashCode()
boolean	isArray() Returns true if the type is an array, otherwise false.
boolean	isPrimitive() Returns true if the type is a primitive type, otherwise false.
boolean	isVarArgs() Returns true if the parameter is a var args parameter, otherwise false.
java.lang.String	name() The variable name of the parameter.
java.lang.Class<?>	paramClass() Returns the class if the parameter is annotated with Param.
Parameter.ParameterType	parameterType() Returns the parameter type of the parameter.
Pos	pos() The position annotation if this the Parameter.parameterType() is Parameter.ParameterType.POS.
javax.lang.model.element.VariableElement	reference() The object used to extract information for the message logger or message bundle, if applicable.
java.lang.String	targetName() Returns the name of the target field or method.
java.lang.String	toString()
Transform	transform() The transform type if this the Parameter.parameterType() is Parameter.ParameterType.TRANSFORM.
java.lang.String	type() Returns the qualified type name of the object.

Methods inherited from class org.jboss.logging.processor.apt.AbstractMessageObjectType

isAssignableFrom, isSameAs, isSubtypeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jboss.logging.processor.model.MessageObjectType

isAssignableFrom, isSameAs, isSubtypeOf

Field Detail

param

private final javax.lang.model.element.VariableElement param

qualifiedType

private final java.lang.String qualifiedType

formatterClass

private final java.lang.String formatterClass

paramClass

private final java.lang.Class<?> paramClass

isVarArgs

private final boolean isVarArgs

parameterType

private final Parameter.ParameterType parameterType

transform

private final Transform transform

pos

private final Pos pos

Constructor Detail

AptParameter

AptParameter(javax.lang.model.util.Elements elements,
             javax.lang.model.util.Types types,
             java.lang.String qualifiedType,
             javax.lang.model.element.VariableElement param,
             java.lang.String formatterClass,
             boolean isVarArgs)

Only allow construction from within the parent class.

Parameters:

elements - the element utilities from the annotation processor.

types - the type utilities from the annotation processor.

qualifiedType - the qualified type name of the parameter.

param - the parameter.

formatterClass - the formatter class, or null if none

isVarArgs - true if this is a vararg parameter, otherwise false.

Method Detail

type

public java.lang.String type()

Description copied from interface: MessageObjectType

Returns the qualified type name of the object.

Equivalent to Object.class.getName()

Specified by:

type in interface MessageObjectType

Specified by:

type in interface Parameter

Overrides:

type in class AbstractMessageObjectType

Returns:

the qualified class name.

formatterClass

public java.lang.String formatterClass()

Description copied from interface: Parameter

The formatter class, or null if there is none.

Specified by:

formatterClass in interface Parameter

Returns:

the formatter class

name

public java.lang.String name()

Description copied from interface: Parameter

The variable name of the parameter.

Specified by:

name in interface MessageObject

Specified by:

name in interface Parameter

Returns:

the variable name of the parameter.

isArray

public boolean isArray()

Description copied from interface: Parameter

Returns true if the type is an array, otherwise false.

Specified by:

isArray in interface Parameter

Returns:

true if an array, otherwise false

isPrimitive

public boolean isPrimitive()

Description copied from interface: Parameter

Returns true if the type is a primitive type, otherwise false.

Specified by:

isPrimitive in interface Parameter

Returns:

true if primitive type, otherwise false

isVarArgs

public boolean isVarArgs()

Description copied from interface: Parameter

Returns true if the parameter is a var args parameter, otherwise false.

Specified by:

isVarArgs in interface Parameter

Returns:

true if var args parameter, otherwise false.

parameterType

public Parameter.ParameterType parameterType()

Description copied from interface: Parameter

Returns the parameter type of the parameter.

Specified by:

parameterType in interface Parameter

Returns:

the parameter type of the parameter.

paramClass

public java.lang.Class<?> paramClass()

Description copied from interface: Parameter

Returns the class if the parameter is annotated with Param. If the annotation is not present, null is returned.

Specified by:

paramClass in interface Parameter

Returns:

the parameter class or null.

targetName

public java.lang.String targetName()

Description copied from interface: Parameter

Returns the name of the target field or method. For example if the Parameter.parameterType() returns Parameter.ParameterType.FIELD, the target name is the name of the field to set on the return type. If no target name is defined an empty String is returned.

Specified by:

targetName in interface Parameter

Returns:

the target field name, method name or an empty string.

transform

public Transform transform()

Description copied from interface: Parameter

The transform type if this the Parameter.parameterType() is Parameter.ParameterType.TRANSFORM.

Specified by:

transform in interface Parameter

Returns:

the transform annotation or null if not a transform parameter

pos

public Pos pos()

Description copied from interface: Parameter

The position annotation if this the Parameter.parameterType() is Parameter.ParameterType.POS.

This works the same way the formatter positional characters work.

      String.format("Numeric value %1$d (%1$x)");

      @Message(""Numeric value %d (%x)"")
      void logNumericValue(@Pos(1) int value);
 

Specified by:

pos in interface Parameter

Returns:

the position annotation or null if not a position parameter

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(Parameter other)

Specified by:

compareTo in interface java.lang.Comparable<Parameter>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

reference

public javax.lang.model.element.VariableElement reference()

Description copied from interface: MessageObject

The object used to extract information for the message logger or message bundle, if applicable. The reference is not used for the implementation and is provided for convenience.

For example, in an annotation processor implementation a ExecutableElement might be returned.

Specified by:

reference in interface MessageObject

Returns:

the reference object used to extract information.