Interface Parameter
-
- All Superinterfaces:
AnnotatedConstruct
,ClassType
,Comparable<Parameter>
,DelegatingElement
,Element
public interface Parameter extends Comparable<Parameter>, ClassType, DelegatingElement
- Author:
- James R. Perkins - 20.Feb.2011
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description String
formatterClass()
The formatter class, ornull
if there is none.boolean
isArray()
Returnstrue
if the type is an array, otherwisefalse
.default boolean
isFormatParameter()
Indicates whether or not the parameter is used a format parameter for the message.default boolean
isMessageMethod()
Indicates whether or not this parameter represents the message method.boolean
isPrimitive()
Returnstrue
if the type is a primitive type, otherwisefalse
.boolean
isVarArgs()
Returnstrue
if the parameter is a var args parameter, otherwisefalse
.String
name()
The variable name of the parameter.String
targetName()
Returns the name of the target field or method.-
Methods inherited from interface org.jboss.logging.processor.model.ClassType
isAssignableFrom, isSameAs, isSubtypeOf
-
Methods inherited from interface java.lang.Comparable
compareTo
-
Methods inherited from interface org.jboss.logging.processor.model.DelegatingElement
accept, asType, getAnnotation, getAnnotationMirrors, getAnnotationsByType, getDelegate, getEnclosedElements, getEnclosingElement, getKind, getModifiers, getSimpleName, isAnnotatedWith
-
-
-
-
Method Detail
-
name
String name()
The variable name of the parameter.- Returns:
- the variable name of the parameter.
-
isArray
boolean isArray()
Returnstrue
if the type is an array, otherwisefalse
.- Returns:
true
if an array, otherwisefalse
-
isPrimitive
boolean isPrimitive()
Returnstrue
if the type is a primitive type, otherwisefalse
.- Returns:
true
if primitive type, otherwisefalse
-
isVarArgs
boolean isVarArgs()
Returnstrue
if the parameter is a var args parameter, otherwisefalse
.- Returns:
true
if var args parameter, otherwisefalse
.
-
isFormatParameter
default boolean isFormatParameter()
Indicates whether or not the parameter is used a format parameter for the message.- Returns:
true
if this parameter that should used as a format parameter for the message
-
isMessageMethod
default boolean isMessageMethod()
Indicates whether or not this parameter represents the message method.- Returns:
true
if this is the message method parameter
-
formatterClass
String formatterClass()
The formatter class, ornull
if there is none.- Returns:
- the formatter class
-
targetName
String targetName()
Returns the name of the target field or method. For example if the parameter is annotated with@Field
the target name is the name of the field to set on thereturn type
. If no target name is defined an empty String is returned.- Returns:
- the target field name, method name or an empty string.
-
-