io.micronaut.core.annotation

Class AnnotationValue<A extends Annotation>

java.lang.Object

io.micronaut.core.annotation.AnnotationValue<A>

Type Parameters:

A - The annotation type

All Implemented Interfaces:

ValueResolver<CharSequence>

public class AnnotationValue<A extends Annotation>
extends Object
implements ValueResolver<CharSequence>

A runtime representation of the an annotation and its values.

This class implements the ValueResolver 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) 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

Modifier and Type	Method and Description
static <T extends Annotation> AnnotationValueBuilder<T>	builder(Class<T> annotation) Start building a new annotation for the given name.
static AnnotationValueBuilder<?>	builder(String annotationName) Start building a new annotation for the given name.
boolean	contains(String member) Whether a particular member is present.
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, 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.
<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()

Methods inherited from class java.lang.Object

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

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)

Internal copy constructor.

Parameters:

target - The target

defaultValues - The default values

convertibleValues - The convertible values

Method Detail

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()

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

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 AnnotationValueBuilder<?> builder(String annotationName)

Start building a new annotation for the given name.

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