AnnotationValue (micronaut 1.2.5 API)

java.lang.Object
- io.micronaut.core.annotation.AnnotationValue<A>

Type Parameters:

A - The annotation type

All Implemented Interfaces:

AnnotationValueResolver, ValueResolver<CharSequence>
```
public class AnnotationValue<A extends Annotation>
extends Object
implements AnnotationValueResolver
```
A runtime representation of the an annotation and its values.
This class implements the AnnotationValueResolver interface and methods such as ValueResolver.get(CharSequence, Class) can be used to retrieve the values of annotation members.

If a member is not present then the methods of the class will attempt to resolve the default value for a given annotation member. In this sense the behaviour of this class is similar to how a implementation of Annotation behaves.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AnnotationValue(AnnotationValue<A> target, Map<String,Object> defaultValues, ConvertibleValues<Object> convertibleValues, Function<Object,Object> valueMapper)` Internal copy constructor.
	`AnnotationValue(String annotationName)`
	`AnnotationValue(String annotationName, ConvertibleValues<Object> convertibleValues)`
	`AnnotationValue(String annotationName, Map<CharSequence,Object> values)`
	`AnnotationValue(String annotationName, Map<CharSequence,Object> values, Map<String,Object> defaultValues)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<Boolean>`	`booleanValue(String member)` The boolean value of the given member.
`Optional<Boolean>`	`booleanValue(String member, Function<Object,Object> valueMapper)` The boolean value of the given member.
`static <T extends Annotation> AnnotationValueBuilder<T>`	`builder(Class<T> annotation)` Start building a new annotation for the given name.
`static <T extends Annotation> AnnotationValueBuilder<T>`	`builder(String annotationName)` Start building a new annotation for the given name.
`Optional<Class<?>>`	`classValue()` The value of the annotation as a Class.
`Optional<Class<?>>`	`classValue(String member)` The value of the given annotation member as a Class.
`<T> Optional<Class<? extends T>>`	`classValue(String member, Class<T> requiredType)` The value of the given annotation member as a Class.
`Optional<Class<?>>`	`classValue(String member, Function<Object,Object> valueMapper)` The value of the given annotation member as a Class.
`Class<?>[]`	`classValues(String member)` The value of the given annotation member as a Class.
`boolean`	`contains(String member)` Whether a particular member is present.
`OptionalDouble`	`doubleValue()` The double value of the given member.
`OptionalDouble`	`doubleValue(String member)` The double value of the given member.
`OptionalDouble`	`doubleValue(String member, Function<Object,Object> valueMapper)` The double value of the given member.
`<E extends Enum> Optional<E>`	`enumValue(String member, Class<E> enumType)` Return the enum value of the given member of the given enum type.
`<E extends Enum> Optional<E>`	`enumValue(String member, Class<E> enumType, Function<Object,Object> valueMapper)` Return the enum value of the given member of the given enum type.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`get(CharSequence member, ArgumentConversionContext<T> conversionContext)` Resolve the given property for the given name.
`<T extends Annotation> Optional<AnnotationValue<T>>`	`getAnnotation(String member, Class<T> type)` Gets a list of `AnnotationValue` for the given member.
`String`	`getAnnotationName()` The annotation name.
`<T extends Annotation> List<AnnotationValue<T>>`	`getAnnotations(String member)` Gets a list of `AnnotationValue` for the given member.
`<T extends Annotation> List<AnnotationValue<T>>`	`getAnnotations(String member, Class<T> type)` Gets a list of `AnnotationValue` for the given member.
`ConvertibleValues<Object>`	`getConvertibleValues()`
`Set<CharSequence>`	`getMemberNames()` Resolves the names of all the present annotation members.
`Map<String,String>`	`getProperties(String member)` Resolves a map of properties for a member that is an array of annotations that have members called "name" or "key" to represent the key and "value" to represent the value.
`Map<String,String>`	`getProperties(String member, String keyMember)` Resolve properties with a custom key member.
`<T> T`	`getRequiredValue(Class<T> type)` Get the value of the `value` member of the annotation.
`<T> T`	`getRequiredValue(String member, Class<T> type)` Get the value of the `value` member of the annotation.
`<T> Optional<T>`	`getValue(Argument<T> argument)` Get the value of the `value` member of the annotation.
`<T> Optional<T>`	`getValue(ArgumentConversionContext<T> conversionContext)` Get the value of the `value` member of the annotation.
`<T> Optional<T>`	`getValue(Class<T> type)` Get the value of the `value` member of the annotation.
`Map<CharSequence,Object>`	`getValues()`
`int`	`hashCode()`
`OptionalInt`	`intValue()` The integer value of the given member.
`OptionalInt`	`intValue(String member)` The integer value of the given member.
`OptionalInt`	`intValue(String member, Function<Object,Object> valueMapper)` The integer value of the given member.
`boolean`	`isFalse()`
`boolean`	`isFalse(String member)`
`boolean`	`isPresent(CharSequence member)` Is the given member present.
`boolean`	`isTrue()`
`boolean`	`isTrue(String member)`
`boolean`	`isTrue(String member, Function<Object,Object> valueMapper)`
`OptionalLong`	`longValue(String member)` The long value of the given member.
`OptionalLong`	`longValue(String member, Function<Object,Object> valueMapper)` The integer value of the given member.
`static Class<?>[]`	`resolveClassValues(Object value)` The classes class values for the given value.
`static String[]`	`resolveStringArray(String[] strs, Function<Object,Object> valueMapper)` The string[] values for the given value.
`static String[]`	`resolveStringValues(Object value, Function<Object,Object> valueMapper)` The string values for the given value.
`Optional<String>`	`stringValue()` The double value of the given member.
`Optional<String>`	`stringValue(String member)` The string value of the given member.
`Optional<String>`	`stringValue(String member, Function<Object,Object> valueMapper)` The string value of the given member.
`String[]`	`stringValues(String member)` The string value of the given member.
`String[]`	`stringValues(String member, Function<Object,Object> valueMapper)` The string values for the given member and mapper.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.core.annotation.AnnotationValueResolver
booleanValue, classValues, enumValue, longValue, stringValues

Methods inherited from interface io.micronaut.core.value.ValueResolver
get, get, get

Constructor Detail

AnnotationValue

public AnnotationValue(String annotationName,
                       Map<CharSequence,Object> values)

Parameters:: annotationName - The annotation name; values - The values

AnnotationValue

public AnnotationValue(String annotationName,
                       Map<CharSequence,Object> values,
                       Map<String,Object> defaultValues)

Parameters:: annotationName - The annotation name; values - The values; defaultValues - The default values

AnnotationValue
```
public AnnotationValue(String annotationName)
```
Parameters:

annotationName - The annotation name

AnnotationValue

public AnnotationValue(String annotationName,
                       ConvertibleValues<Object> convertibleValues)

Parameters:: annotationName - The annotation name; convertibleValues - The convertible values

AnnotationValue

@Internal
protected AnnotationValue(AnnotationValue<A> target,
                                    Map<String,Object> defaultValues,
                                    ConvertibleValues<Object> convertibleValues,
                                    Function<Object,Object> valueMapper)

Internal copy constructor.

Parameters:: target - The target; defaultValues - The default values; convertibleValues - The convertible values; valueMapper - The value mapper

Method Detail

getProperties
```
@Nonnull
public Map<String,String> getProperties(@Nonnull
                                                 String member)
```
Resolves a map of properties for a member that is an array of annotations that have members called "name" or "key" to represent the key and "value" to represent the value.
For example consider the following annotation definition:
```
@PropertySource({ @Property(name="one",value="1"), @Property(name="two", value="2")})
public class MyBean {
        ...
}
```
You can use this method to resolve the values of the PropertySource annotation such that the following assertion is true:
```
annotationValue.getProperties("value") == [one:1, two:2]
```
Parameters:

member - The member

Returns:

The properties as a immutable map.

getProperties

public Map<String,String> getProperties(@Nonnull
                                        String member,
                                        String keyMember)

Resolve properties with a custom key member.

Parameters:: member - The member to resolve the properties from; keyMember - The member of the sub annotation that represents the key.
Returns:: The properties.
See Also:: getProperties(String)

enumValue

public <E extends Enum> Optional<E> enumValue(@Nonnull
                                              String member,
                                              @Nonnull
                                              Class<E> enumType)

Return the enum value of the given member of the given enum type.

Specified by:: enumValue in interface AnnotationValueResolver
Type Parameters:: E - The enum type
Parameters:: member - The annotation member; enumType - The required type
Returns:: An Optional of the enum value

enumValue

public <E extends Enum> Optional<E> enumValue(@Nonnull
                                              String member,
                                              @Nonnull
                                              Class<E> enumType,
                                              Function<Object,Object> valueMapper)

Return the enum value of the given member of the given enum type.

Type Parameters:: E - The enum type
Parameters:: member - The annotation member; enumType - The required type; valueMapper - The value mapper
Returns:: An Optional of the enum value

classValue
```
@Nonnull
public Optional<Class<?>> classValue()
```
The value of the annotation as a Class.

Specified by:

classValue in interface AnnotationValueResolver

Returns:

An Optional class

classValue
```
public Optional<Class<?>> classValue(@Nonnull
                                     String member)
```
The value of the given annotation member as a Class.

Specified by:

classValue in interface AnnotationValueResolver

Parameters:

member - The annotation member

Returns:

An Optional class

classValue

public <T> Optional<Class<? extends T>> classValue(@Nonnull
                                                   String member,
                                                   @Nonnull
                                                   Class<T> requiredType)

The value of the given annotation member as a Class.

Specified by:: classValue in interface AnnotationValueResolver
Type Parameters:: T - The required type
Parameters:: member - The annotation member; requiredType - The required type
Returns:: An Optional class

classValue

public Optional<Class<?>> classValue(@Nonnull
                                     String member,
                                     @Nullable
                                     Function<Object,Object> valueMapper)

The value of the given annotation member as a Class.

Parameters:: member - The annotation member; valueMapper - The raw value mapper
Returns:: An Optional class

stringValues
```
@Nonnull
public String[] stringValues(@Nonnull
                                      String member)
```
Description copied from interface: AnnotationValueResolver

The string value of the given member.

Specified by:

stringValues in interface AnnotationValueResolver

Parameters:

member - The annotation member

Returns:

An OptionalInt

stringValues

public String[] stringValues(@Nonnull
                             String member,
                             Function<Object,Object> valueMapper)

The string values for the given member and mapper.

Parameters:: member - The member; valueMapper - The mapper
Returns:: The string values

classValues
```
public Class<?>[] classValues(@Nonnull
                              String member)
```
Description copied from interface: AnnotationValueResolver

The value of the given annotation member as a Class.

Specified by:

classValues in interface AnnotationValueResolver

Parameters:

member - The annotation member

Returns:

An Optional class

intValue
```
public OptionalInt intValue(@Nonnull
                            String member)
```
The integer value of the given member.

Specified by:

intValue in interface AnnotationValueResolver

Parameters:

member - The annotation member

Returns:

An OptionalInt

intValue

public OptionalInt intValue(@Nonnull
                            String member,
                            @Nullable
                            Function<Object,Object> valueMapper)

The integer value of the given member.

Parameters:: member - The annotation member; valueMapper - The value mapper
Returns:: An OptionalInt

intValue
```
public OptionalInt intValue()
```
The integer value of the given member.

Specified by:

intValue in interface AnnotationValueResolver

Returns:

An OptionalInt

longValue
```
public OptionalLong longValue(@Nonnull
                              String member)
```
Description copied from interface: AnnotationValueResolver

The long value of the given member.

Specified by:

longValue in interface AnnotationValueResolver

Parameters:

member - The annotation member

Returns:

An OptionalLong

longValue

public OptionalLong longValue(@Nonnull
                              String member,
                              @Nullable
                              Function<Object,Object> valueMapper)

The integer value of the given member.

Parameters:: member - The annotation member; valueMapper - The value mapper
Returns:: An OptionalInt

booleanValue

public Optional<Boolean> booleanValue(@Nonnull
                                      String member,
                                      @Nullable
                                      Function<Object,Object> valueMapper)

The boolean value of the given member.

Parameters:: member - The annotation member; valueMapper - The value mapper
Returns:: An Optional boolean

doubleValue
```
public OptionalDouble doubleValue(@Nonnull
                                  String member)
```
The double value of the given member.

Specified by:

doubleValue in interface AnnotationValueResolver

Parameters:

member - The annotation member

Returns:

An OptionalDouble

doubleValue

public OptionalDouble doubleValue(@Nonnull
                                  String member,
                                  @Nullable
                                  Function<Object,Object> valueMapper)

The double value of the given member.

Parameters:: member - The annotation member; valueMapper - The value mapper
Returns:: An OptionalDouble

doubleValue
```
public OptionalDouble doubleValue()
```
The double value of the given member.

Specified by:

doubleValue in interface AnnotationValueResolver

Returns:

An OptionalDouble

stringValue
```
public Optional<String> stringValue(@Nonnull
                                    String member)
```
The string value of the given member.

Specified by:

stringValue in interface AnnotationValueResolver

Parameters:

member - The annotation member

Returns:

An OptionalInt

stringValue

public Optional<String> stringValue(@Nonnull
                                    String member,
                                    @Nullable
                                    Function<Object,Object> valueMapper)

The string value of the given member.

Parameters:: member - The annotation member; valueMapper - An optional raw value mapper
Returns:: An OptionalInt

stringValue
```
public Optional<String> stringValue()
```
The double value of the given member.

Specified by:

stringValue in interface AnnotationValueResolver

Returns:

An OptionalInt

booleanValue
```
public Optional<Boolean> booleanValue(@Nonnull
                                      String member)
```
Description copied from interface: AnnotationValueResolver

The boolean value of the given member.

Specified by:

booleanValue in interface AnnotationValueResolver

Parameters:

member - The annotation member

Returns:

An Optional boolean

isPresent
```
public final boolean isPresent(CharSequence member)
```
Is the given member present.

Specified by:

isPresent in interface AnnotationValueResolver

Parameters:

member - The member

Returns:

True if it is

isTrue
```
public boolean isTrue()
```
Specified by:

isTrue in interface AnnotationValueResolver

Returns:

Is the value of the annotation true.

isTrue
```
public boolean isTrue(String member)
```
Specified by:

isTrue in interface AnnotationValueResolver

Parameters:

member - The member

Returns:

Is the value of the annotation true.

isTrue

public boolean isTrue(@Nonnull
                      String member,
                      @Nullable
                      Function<Object,Object> valueMapper)

Parameters:: member - The member; valueMapper - The value mapper
Returns:: Is the value of the annotation true.

isFalse
```
public boolean isFalse()
```
Specified by:

isFalse in interface AnnotationValueResolver

Returns:

Is the value of the annotation true.

isFalse
```
public boolean isFalse(String member)
```
Specified by:

isFalse in interface AnnotationValueResolver

Parameters:

member - The member

Returns:

Is the value of the annotation true.

getAnnotationName
```
@Nonnull
public final String getAnnotationName()
```
The annotation name.

Returns:

The annotation name

contains
```
public final boolean contains(String member)
```
Whether a particular member is present.

Parameters:

member - The member

Returns:

True if it is

getMemberNames
```
@Nonnull
public final Set<CharSequence> getMemberNames()
```
Resolves the names of all the present annotation members.

Returns:

The names of the members

getValues
```
@Nonnull
public Map<CharSequence,Object> getValues()
```
Specified by:

getValues in interface AnnotationValueResolver

Returns:

The attribute values

getConvertibleValues

@Nonnull
public ConvertibleValues<Object> getConvertibleValues()

Returns:: The convertible values

get
```
public <T> Optional<T> get(CharSequence member,
                           ArgumentConversionContext<T> conversionContext)
```
Description copied from interface: ValueResolver

Resolve the given property for the given name.

Specified by:

get in interface ValueResolver<CharSequence>

Type Parameters:

T - The concrete type

Parameters:

member - The name

conversionContext - The conversion context

Returns:

An optional containing the property value if it exists and is able to be converted

getValue
```
public <T> Optional<T> getValue(ArgumentConversionContext<T> conversionContext)
```
Get the value of the value member of the annotation.

Type Parameters:

T - The type

Parameters:

conversionContext - The conversion context

Returns:

The result

getValue
```
public final <T> Optional<T> getValue(Argument<T> argument)
```
Get the value of the value member of the annotation.

Type Parameters:

T - The type

Parameters:

argument - The argument

Returns:

The result

getValue
```
public final <T> Optional<T> getValue(Class<T> type)
```
Get the value of the value member of the annotation.

Type Parameters:

T - The type

Parameters:

type - The type

Returns:

The result

getRequiredValue
```
@Nonnull
public final <T> T getRequiredValue(Class<T> type)
```
Get the value of the value member of the annotation.

Type Parameters:

T - The type

Parameters:

type - The type

Returns:

The result

Throws:

IllegalStateException - If no member is available that conforms to the given type

getRequiredValue
```
@Nonnull
public final <T> T getRequiredValue(String member,
                                             Class<T> type)
```
Get the value of the value member of the annotation.

Type Parameters:

T - The type

Parameters:

member - The member

type - The type

Returns:

The result

Throws:

IllegalStateException - If no member is available that conforms to the given name and type

getAnnotations

@Nonnull
public final <T extends Annotation> List<AnnotationValue<T>> getAnnotations(String member,
                                                                                     Class<T> type)

Gets a list of AnnotationValue for the given member.

Type Parameters:: T - The type
Parameters:: member - The member; type - The type
Returns:: The result
Throws:: IllegalStateException - If no member is available that conforms to the given name and type

getAnnotations
```
@Nonnull
public final <T extends Annotation> List<AnnotationValue<T>> getAnnotations(String member)
```
Gets a list of AnnotationValue for the given member.

Type Parameters:

T - The type

Parameters:

member - The member

Returns:

The result

Throws:

IllegalStateException - If no member is available that conforms to the given name and type

getAnnotation

@Nonnull
public final <T extends Annotation> Optional<AnnotationValue<T>> getAnnotation(String member,
                                                                                        Class<T> type)

Gets a list of AnnotationValue for the given member.

Type Parameters:: T - The type
Parameters:: member - The member; type - The type
Returns:: The result
Throws:: IllegalStateException - If no member is available that conforms to the given name and type

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

builder
```
public static <T extends Annotation> AnnotationValueBuilder<T> builder(String annotationName)
```
Start building a new annotation for the given name.

Type Parameters:

T - The annotation type

Parameters:

annotationName - The annotation name

Returns:

The builder

builder
```
public static <T extends Annotation> AnnotationValueBuilder<T> builder(Class<T> annotation)
```
Start building a new annotation for the given name.

Type Parameters:

T - The annotation type

Parameters:

annotation - The annotation name

Returns:

The builder

resolveStringValues

@Internal
 @Nullable
public static String[] resolveStringValues(@Nullable
                                                                Object value,
                                                                @Nullable
                                                                Function<Object,Object> valueMapper)

The string values for the given value.

Parameters:: value - The value; valueMapper - The value mapper
Returns:: The string[] or null

resolveStringArray

@Internal
public static String[] resolveStringArray(String[] strs,
                                                    @Nullable
                                                    Function<Object,Object> valueMapper)

The string[] values for the given value.

Parameters:: strs - The strings; valueMapper - The value mapper
Returns:: The string[] or the original string

resolveClassValues

@Internal
 @Nullable
public static Class<?>[] resolveClassValues(@Nullable
                                                                 Object value)

The classes class values for the given value.

Parameters:: value - The value
Returns:: The class values or null

Class AnnotationValue<A extends Annotation>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.micronaut.core.annotation.AnnotationValueResolver

Methods inherited from interface io.micronaut.core.value.ValueResolver

Constructor Detail

AnnotationValue

AnnotationValue

AnnotationValue

AnnotationValue

AnnotationValue

Method Detail

getProperties

getProperties

enumValue

enumValue

classValue

classValue

classValue

classValue

stringValues

stringValues

classValues

intValue

intValue

intValue

longValue

longValue

booleanValue

doubleValue

doubleValue

doubleValue

stringValue

stringValue

stringValue

booleanValue

isPresent

isTrue

isTrue

isTrue

isFalse

isFalse

getAnnotationName

contains

getMemberNames

getValues

getConvertibleValues

get

getValue

getValue

getValue

getRequiredValue

getRequiredValue

getAnnotations

getAnnotations

getAnnotation

hashCode

equals

builder

builder

resolveStringValues

resolveStringArray

resolveClassValues