org.eclipse.xtend.lib.macro.services

Interface AnnotationReferenceBuildContext

@Beta
public interface AnnotationReferenceBuildContext

Services provided during an annotation reference initialization.

Since:

2.6

Author:

Anton Kosyakov

This interface is not intended to be implemented by clients.

This interface is not intended to be implemented by clients.

Method Summary

Methods

Modifier and Type	Method and Description
void	set(java.lang.String name, java.lang.Object value) Sets the annotation property of the given name Depending of the respective annotation type element, the following values are permitted: Short or short[] Integer or int[] Long or long[] Float or float[] Double or double[] Boolean or boolean[] TypeReference or TypeReference[] - for elements of type Class
void	setAnnotationValue(java.lang.String name, AnnotationReference... value) Sets the given value for the given annotation element name.
void	setBooleanValue(java.lang.String name, boolean... value) Sets the given value for the given annotation element name.
void	setByteValue(java.lang.String name, byte... value) Sets the given value for the given annotation element name.
void	setCharValue(java.lang.String name, char... value) Sets the given value for the given annotation element name.
void	setClassValue(java.lang.String name, TypeReference... value) Sets the given value for the given annotation element name.
void	setDoubleValue(java.lang.String name, double... value) Sets the given value for the given annotation element name.
void	setEnumValue(java.lang.String name, EnumerationValueDeclaration... value) Sets the given value for the given annotation element name.
void	setFloatValue(java.lang.String name, float... value) Sets the given value for the given annotation element name.
void	setIntValue(java.lang.String name, int... value) Sets the given value for the given annotation element name.
void	setLongValue(java.lang.String name, long... value) Sets the given value for the given annotation element name.
void	setShortValue(java.lang.String name, short... value) Sets the given value for the given annotation element name.
void	setStringValue(java.lang.String name, java.lang.String... value) Sets the given value for the given annotation element name.

Method Detail

set

void set(java.lang.String name,
       java.lang.Object value)

Sets the annotation property of the given name Depending of the respective annotation type element, the following values are permitted:

• Short or short[]
• Integer or int[]
• Long or long[]
• Float or float[]
• Double or double[]
• Boolean or boolean[]
• TypeReference or TypeReference[] - for elements of type Class
• AnnotationReference or AnnotationReference[] - for elements of an annotation type
• EnumerationValueDeclaration or EnumerationValueDeclaration[] - for elements of an enum type
• Expression - for any element type that matches the given expression's type
• null - will remove any existing value for the given element name

Parameters:

name - a valid name of a property of the annotation type.

value - an annotation value or null if the annotation value should be removed.

Throws:

java.lang.IllegalArgumentException - if the value is not valid. See explanation above or if the name does not identify a method in the referenced annotation type.

setIntValue

void setIntValue(java.lang.String name,
               int... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setLongValue

void setLongValue(java.lang.String name,
                long... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setShortValue

void setShortValue(java.lang.String name,
                 short... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setDoubleValue

void setDoubleValue(java.lang.String name,
                  double... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setFloatValue

void setFloatValue(java.lang.String name,
                 float... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setByteValue

void setByteValue(java.lang.String name,
                byte... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setBooleanValue

void setBooleanValue(java.lang.String name,
                   boolean... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setCharValue

void setCharValue(java.lang.String name,
                char... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setStringValue

void setStringValue(java.lang.String name,
                  java.lang.String... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array without any null entries

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setClassValue

void setClassValue(java.lang.String name,
                 TypeReference... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array without any null entries

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setEnumValue

void setEnumValue(java.lang.String name,
                EnumerationValueDeclaration... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array without any null entries

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.

setAnnotationValue

void setAnnotationValue(java.lang.String name,
                      AnnotationReference... value)

Sets the given value for the given annotation element name.

Parameters:

name - a valid name of a property of the annotation type.

value - a non-null value array without any null entries

Throws:

java.lang.IllegalArgumentException - if the name does not point to a valid member of the referenced annotation type.