uk.co.strangeskies.reflection

Class Annotations

java.lang.Object

uk.co.strangeskies.reflection.Annotations

public final class Annotations
extends java.lang.Object

A collection of general utility methods relating to annotated types within the Java type system. Utilities related to more specific classes of annotated type may be found in AnnotatedWildcardTypes, AnnotatedParameterizedTypes, and AnnotatedArrayTypes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Annotations.AnnotationParser A parser for Annotations, and various related types.

Constructor Summary

Constructors

Constructor and Description
Annotations()

Method Summary

Modifier and Type	Method and Description
static <T extends java.lang.annotation.Annotation> T	from(java.lang.Class<T> annotationClass) Try to instantiate an instance of a given annotation type, with default values for any properties.
static <T extends java.lang.annotation.Annotation> T	from(java.lang.Class<T> annotationClass, AnnotationProperty... properties)
static <T extends java.lang.annotation.Annotation> T	from(java.lang.Class<T> annotationClass, java.util.Collection<? extends AnnotationProperty> properties)
static <T extends java.lang.annotation.Annotation> T	from(java.lang.Class<T> annotationClass, java.util.Map<java.lang.String,java.lang.Object> properties) Instantiate an instance of a given annotation type, with the given mapping from properties to their values.
static java.lang.annotation.Annotation	fromString(java.lang.String typeString) Create an Annotation instance from a parsed String.
static java.lang.annotation.Annotation	fromString(java.lang.String typeString, Imports imports) Create an Annotation instance from a parsed String.
static java.util.stream.Stream<AnnotationProperty>	getModifiedProperties(java.lang.annotation.Annotation annotation)
static Annotations.AnnotationParser	getParser() Get the default annotation parser.
static Annotations.AnnotationParser	getParser(Imports imports) Get an annotation parser with knowledge of the given imports.
static java.util.stream.Stream<AnnotationProperty>	getProperties(java.lang.annotation.Annotation annotation)
protected static java.lang.StringBuilder	toPropertyString(java.lang.Object object)
protected static java.lang.StringBuilder	toPropertyString(java.lang.Object object, Imports imports)
static java.lang.String	toString(java.lang.annotation.Annotation annotation) Give a canonical String representation of a given annotation.
static java.lang.String	toString(java.lang.annotation.Annotation annotation, Imports imports) Give a canonical String representation of a given annotation.Provided class and package imports allow the names of some classes to be output without full package qualification.

Methods inherited from class java.lang.Object

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

Constructor Detail

Annotations

public Annotations()

Method Detail

toString

public static java.lang.String toString(java.lang.annotation.Annotation annotation)

Give a canonical String representation of a given annotation.

Parameters:

annotation - The annotation of which we wish to determine a string representation.

Returns:

A canonical string representation of the given type.

toString

public static java.lang.String toString(java.lang.annotation.Annotation annotation,
                                        Imports imports)

Give a canonical String representation of a given annotation.Provided class and package imports allow the names of some classes to be output without full package qualification.

Parameters:

annotation - The annotation of which we wish to determine a string representation.

imports - Classes and packages for which full package qualification may be omitted from output.

Returns:

A canonical string representation of the given type.

toPropertyString

protected static java.lang.StringBuilder toPropertyString(java.lang.Object object)

toPropertyString

protected static java.lang.StringBuilder toPropertyString(java.lang.Object object,
                                                          Imports imports)

fromString

public static java.lang.annotation.Annotation fromString(java.lang.String typeString)

Create an Annotation instance from a parsed String.

Parameters:

typeString - The String to parse.

Returns:

The type described by the String.

fromString

public static java.lang.annotation.Annotation fromString(java.lang.String typeString,
                                                         Imports imports)

Create an Annotation instance from a parsed String. Provided class and package imports allow the names of some classes to be given without full package qualification.

Parameters:

typeString - The String to parse.

imports - Classes and packages for which full package qualification may be omitted from input.

Returns:

The type described by the String.

getProperties

public static java.util.stream.Stream<AnnotationProperty> getProperties(java.lang.annotation.Annotation annotation)

getModifiedProperties

public static java.util.stream.Stream<AnnotationProperty> getModifiedProperties(java.lang.annotation.Annotation annotation)

from

public static <T extends java.lang.annotation.Annotation> T from(java.lang.Class<T> annotationClass)

Try to instantiate an instance of a given annotation type, with default values for any properties.

Type Parameters:

T - The type of the annotation to instantiate

Parameters:

annotationClass - The type of the annotation to instantiate

Returns:

A new annotation of the given type and properties

from

public static <T extends java.lang.annotation.Annotation> T from(java.lang.Class<T> annotationClass,
                                                                 AnnotationProperty... properties)

from

public static <T extends java.lang.annotation.Annotation> T from(java.lang.Class<T> annotationClass,
                                                                 java.util.Collection<? extends AnnotationProperty> properties)

from

public static <T extends java.lang.annotation.Annotation> T from(java.lang.Class<T> annotationClass,
                                                                 java.util.Map<java.lang.String,java.lang.Object> properties)

Instantiate an instance of a given annotation type, with the given mapping from properties to their values.

Type Parameters:

T - The type of the annotation to instantiate

Parameters:

annotationClass - The type of the annotation to instantiate

properties - A mapping from names of properties on the annotation to values

Returns:

A new annotation of the given type and properties

getParser

public static Annotations.AnnotationParser getParser()

Get the default annotation parser. All type names will need to be fully qualified to correctly parse.

Returns:

The default annotation parser

getParser

public static Annotations.AnnotationParser getParser(Imports imports)

Get an annotation parser with knowledge of the given imports. Type names may omit full qualification if those types are imported according to the given imports.

Parameters:

imports - A list of imports the annotation parser should be aware of

Returns:

An annotation parser with knowledge of the given imports