com.helger.jcodemodel

Class JAnnotationUse

java.lang.Object

com.helger.jcodemodel.AbstractJAnnotationValue

com.helger.jcodemodel.AbstractJAnnotationValueOwned

com.helger.jcodemodel.JAnnotationUse

All Implemented Interfaces:

IJGenerable, IJOwned

public class JAnnotationUse
extends AbstractJAnnotationValueOwned

Represents an annotation on a program element.

Author:

Bhakti Mehta (bhakti.mehta@sun.com)

Nested Class Summary

Nested classes/interfaces inherited from class com.helger.jcodemodel.AbstractJAnnotationValueOwned

AbstractJAnnotationValueOwned.FullClassNameExpr, AbstractJAnnotationValueOwned.JEnumConstantExpr

Field Summary

Fields

Modifier and Type	Field and Description
static String	SPECIAL_KEY_VALUE The special parameter name that can be optimized away if used without any other parameter

Constructor Summary

Constructors

Constructor and Description
JAnnotationUse(AbstractJClass aAnnotationClass)

Method Summary

Modifier and Type	Method and Description
JAnnotationUse	annotationParam(String name, AbstractJClass value) Adds a member value pair to this annotation For adding class values as param
JAnnotationUse	annotationParam(String name, Class<? extends Annotation> value) Adds a member value pair to this annotation For adding class values as param
void	generate(JFormatter f)
AbstractJClass	getAnnotationClass()
Map<String,AbstractJAnnotationValue>	getAnnotationMembers()
JAnnotationStringValue	getConstantParam(String sName)
IJExpression	getConstantParamValue(String sName)
AbstractJAnnotationValue	getParam(String sName)
<T> T	getParam(String sName, Class<T> klass) Return annotation argument represented as required type.
boolean	hasAnnotationMembers()
JCodeModel	owner() Gets the owner code model object.
JAnnotationUse	param(String name, AbstractJType type) Adds a member value pair to this annotation based on the type represented by the given AbstractJType
JAnnotationUse	param(String sName, boolean value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, byte value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, char value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, Class<?> value) Adds a member value pair to this annotation This can be used for e.g to specify @XmlCollectionItem(type=Integer.class); For adding a value of Class<?
JAnnotationUse	param(String name, double value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, Enum<?> value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, float value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, IJExpression value) Adds a member value pair to this annotation.
JAnnotationUse	param(String name, int value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, JEnumConstant value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, long value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, short value) Adds a member value pair to this annotation
JAnnotationUse	param(String name, String value) Adds a member value pair to this annotation
JAnnotationArrayMember	paramArray(String sName) Adds a member value pair which is of type array to this annotation
JAnnotationUse	paramArray(String name, AbstractJType... values)
JAnnotationUse	paramArray(String name, boolean... values)
JAnnotationUse	paramArray(String name, byte... values)
JAnnotationUse	paramArray(String name, char... values)
JAnnotationUse	paramArray(String name, Class<?>... values)
JAnnotationUse	paramArray(String name, double... values)
JAnnotationUse	paramArray(String name, Enum<?>... values)
JAnnotationUse	paramArray(String name, float... values)
JAnnotationUse	paramArray(String name, IJExpression... values)
JAnnotationUse	paramArray(String name, int... values)
JAnnotationUse	paramArray(String name, JEnumConstant... values)
JAnnotationUse	paramArray(String name, long... values)
JAnnotationUse	paramArray(String name, short... values)
JAnnotationUse	paramArray(String name, String... values)
int	size()

Methods inherited from class com.helger.jcodemodel.AbstractJAnnotationValueOwned

wrap, wrap

Methods inherited from class com.helger.jcodemodel.AbstractJAnnotationValue

wrap, wrap, wrap, wrap, wrap, wrap, wrap, wrap, wrap, wrap, wrap, wrap

Methods inherited from class java.lang.Object

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

Field Detail

SPECIAL_KEY_VALUE

public static final String SPECIAL_KEY_VALUE

The special parameter name that can be optimized away if used without any other parameter

See Also:

Constant Field Values

Constructor Detail

JAnnotationUse

public JAnnotationUse(@Nonnull
                      AbstractJClass aAnnotationClass)

Method Detail

getAnnotationClass

@Nonnull
public AbstractJClass getAnnotationClass()

owner

@Nonnull
public JCodeModel owner()

Description copied from interface: IJOwned

Gets the owner code model object.

Returns:

The owner and never null.

getAnnotationMembers

@Nonnull
public Map<String,AbstractJAnnotationValue> getAnnotationMembers()

hasAnnotationMembers

public boolean hasAnnotationMembers()

getParam

@Nullable
public AbstractJAnnotationValue getParam(@Nullable
                                                    String sName)

getParam

@Nullable
public <T> T getParam(@Nonnull
                                 String sName,
                                 @Nonnull
                                 Class<T> klass)
                          throws ClassCastException

Return annotation argument represented as required type. Return type is chosen to conform to given klass argument.

For example, you can have annotation parameter named 'value' of type String.

You can write getParam("value", String.class) to get raw string-value. You can write getParam("value", AbstractJAnnotationValue.class) to get AbstractJAnnotationValue for this argument.

Arrays are supported as a result type.

Type Parameters:

T - return type

Parameters:

sName - annotation parameter name

klass - type to use as a return type

Returns:

annotation argument represented as required type

Throws:

ClassCastException

getConstantParam

@Nullable
public JAnnotationStringValue getConstantParam(@Nullable
                                                          String sName)

getConstantParamValue

@Nullable
public IJExpression getConstantParamValue(@Nullable
                                                     String sName)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String sName,
                                      boolean value)

Adds a member value pair to this annotation

Parameters:

sName - The simple name for this annotation

value - The boolean value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           boolean... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      byte value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The byte member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           byte... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      char value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The char member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           char... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      double value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The double member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           double... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      float value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The float member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           float... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      long value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The long member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           long... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      short value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The short member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           short... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      int value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The int member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           int... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      String value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The String member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           String... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      @Nonnull
                                      Enum<?> value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The enum class which is member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           Enum<?>... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      @Nonnull
                                      JEnumConstant value)

Adds a member value pair to this annotation

Parameters:

name - The simple name for this annotation

value - The JEnumConstant which is member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           JEnumConstant... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      @Nonnull
                                      Class<?> value)

Adds a member value pair to this annotation This can be used for e.g to specify

 @XmlCollectionItem(type=Integer.class);
 

For adding a value of Class<? extends Annotation> annotationParam(String, Class)

Parameters:

name - The simple name for this annotation param

value - The class type of the param

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           Class<?>... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      @Nonnull
                                      AbstractJType type)

Adds a member value pair to this annotation based on the type represented by the given AbstractJType

Parameters:

name - The simple name for this annotation param

type - the AbstractJType representing the actual type

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           AbstractJType... values)

param

@Nonnull
public JAnnotationUse param(@Nonnull
                                      String name,
                                      @Nonnull
                                      IJExpression value)

Adds a member value pair to this annotation.

Parameters:

name - The simple name for this annotation

value - The IJExpression which provides the content value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

paramArray

@Nonnull
public JAnnotationUse paramArray(@Nonnull
                                           String name,
                                           @Nonnull
                                           IJExpression... values)

paramArray

@Nonnull
public JAnnotationArrayMember paramArray(@Nonnull
                                                   String sName)

Adds a member value pair which is of type array to this annotation

Parameters:

sName - The simple name for this annotation

Returns:

The JAnnotationArrayMember. For adding array values

See Also:

JAnnotationArrayMember

annotationParam

@Nonnull
public JAnnotationUse annotationParam(@Nonnull
                                                String name,
                                                @Nonnull
                                                Class<? extends Annotation> value)

Adds a member value pair to this annotation For adding class values as param

Parameters:

name - The simple name for this annotation

value - The annotation class which is member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

See Also:

param(String, Class)

annotationParam

@Nonnull
public JAnnotationUse annotationParam(@Nonnull
                                                String name,
                                                @Nonnull
                                                AbstractJClass value)

Adds a member value pair to this annotation For adding class values as param

Parameters:

name - The simple name for this annotation

value - The annotation class which is member value for this annotation

Returns:

The JAnnotationUse. More member value pairs can be added to it using the same or the overloaded methods.

See Also:

param(String, Class)

size

@Nonnegative
public int size()

generate

public void generate(JFormatter f)