Package org.immutables.value.processor.meta

Class InjectAnnotationMirror

java.lang.Object

org.immutables.value.processor.meta.InjectAnnotationMirror

All Implemented Interfaces:

java.lang.annotation.Annotation

public class InjectAnnotationMirror
extends java.lang.Object
implements AnnotationInjections.InjectAnnotation

InjectAnnotationMirror used to parse data of AnnotationMirror for original annotation org.immutables.annotate.InjectAnnotation during annotation processing. Interface is being described using AnnotationInjections.InjectAnnotation annotation, which should be structurally compatible to the annotation being modelled.

See Also:

find(Iterable), from(AnnotationMirror)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	InjectAnnotationMirror.CodeExtractor
private static class	InjectAnnotationMirror.DeduplicationKeyExtractor
private static class	InjectAnnotationMirror.IfPresentExtractor
private static class	InjectAnnotationMirror.TargetExtractor
private static class	InjectAnnotationMirror.TypeExtractor

Nested classes/interfaces inherited from class org.immutables.value.processor.meta.AnnotationInjections.InjectAnnotation

AnnotationInjections.InjectAnnotation.Where

Field Summary

Fields

Modifier and Type	Field	Description
private javax.lang.model.element.AnnotationMirror	annotationMirror
private java.lang.String	code
private java.lang.String	deduplicationKey
private boolean	ifPresent
static java.lang.String	MIRROR_QUALIFIED_NAME
static java.lang.String	QUALIFIED_NAME
private AnnotationInjections.InjectAnnotation.Where[]	target
private javax.lang.model.type.TypeMirror	type
private java.lang.String	typeName

Constructor Summary

Constructors

Modifier	Constructor	Description
private	InjectAnnotationMirror(javax.lang.model.element.AnnotationMirror annotationMirror)
private	InjectAnnotationMirror(javax.lang.model.element.TypeElement defaultAnnotationElement)

Method Summary

Modifier and Type	Method	Description
java.lang.Class<? extends java.lang.annotation.Annotation>	annotationType()
java.lang.String	code()
java.lang.String	deduplicationKey()
boolean	equals(java.lang.Object other)
static com.google.common.base.Optional<InjectAnnotationMirror>	find(java.lang.Iterable<? extends javax.lang.model.element.AnnotationMirror> mirrors)	Finds first annotation of this type in an iterable of annotation mirrors.
static com.google.common.base.Optional<InjectAnnotationMirror>	find(javax.lang.model.element.Element element)	Finds first annotation of this type on the element.
static com.google.common.base.Optional<InjectAnnotationMirror>	from(javax.lang.model.element.AnnotationMirror mirror)	Tries to convert annotation mirror to this annotation type.
static InjectAnnotationMirror	from(javax.lang.model.element.TypeElement element)	Creates mirror with default values using annotation element (i.e.
static com.google.common.collect.ImmutableList<InjectAnnotationMirror>	fromAll(java.lang.Iterable<? extends javax.lang.model.element.AnnotationMirror> mirrors)	Converts iterable of annotation mirrors where all annotation are of this type.
javax.lang.model.element.AnnotationMirror	getAnnotationMirror()
int	hashCode()
boolean	ifPresent()
static boolean	isPresent(javax.lang.model.element.Element annotatedElement)
static java.lang.String	mirrorQualifiedName()
static java.lang.String	qualifiedName()
static java.lang.String	simpleName()
AnnotationInjections.InjectAnnotation.Where[]	target()
java.lang.String	toString()
java.lang.Class<? extends java.lang.annotation.Annotation>	type()	Deprecated. Always throws UnsupportedOperationException.
javax.lang.model.type.TypeMirror	typeMirror()
java.lang.String	typeName()

Methods inherited from class java.lang.Object

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

Field Detail

QUALIFIED_NAME

public static final java.lang.String QUALIFIED_NAME

See Also:

Constant Field Values

MIRROR_QUALIFIED_NAME

public static final java.lang.String MIRROR_QUALIFIED_NAME

See Also:

Constant Field Values

annotationMirror

private final javax.lang.model.element.AnnotationMirror annotationMirror

code

private final java.lang.String code

type

private final javax.lang.model.type.TypeMirror type

typeName

private final java.lang.String typeName

ifPresent

private final boolean ifPresent

target

private final AnnotationInjections.InjectAnnotation.Where[] target

deduplicationKey

private final java.lang.String deduplicationKey

Constructor Detail

InjectAnnotationMirror

private InjectAnnotationMirror(javax.lang.model.element.TypeElement defaultAnnotationElement)

InjectAnnotationMirror

private InjectAnnotationMirror(javax.lang.model.element.AnnotationMirror annotationMirror)

Method Detail

mirrorQualifiedName

public static java.lang.String mirrorQualifiedName()

qualifiedName

public static java.lang.String qualifiedName()

simpleName

public static java.lang.String simpleName()

isPresent

public static boolean isPresent(javax.lang.model.element.Element annotatedElement)

find

public static com.google.common.base.Optional<InjectAnnotationMirror> find(javax.lang.model.element.Element element)

Finds first annotation of this type on the element.

Parameters:

element - annotated element

Returns:

optional InjectAnnotationMirror, present if this annotation found

find

public static com.google.common.base.Optional<InjectAnnotationMirror> find(java.lang.Iterable<? extends javax.lang.model.element.AnnotationMirror> mirrors)

Finds first annotation of this type in an iterable of annotation mirrors.

Parameters:

mirrors - annotation mirrors

Returns:

optional InjectAnnotationMirror, present if this annotation found

fromAll

public static com.google.common.collect.ImmutableList<InjectAnnotationMirror> fromAll(java.lang.Iterable<? extends javax.lang.model.element.AnnotationMirror> mirrors)

Converts iterable of annotation mirrors where all annotation are of this type. Otherwise it fails

Parameters:

mirrors - of this annotation type.

Returns:

list of converted InjectAnnotationMirrors

from

public static InjectAnnotationMirror from(javax.lang.model.element.TypeElement element)

Creates mirror with default values using annotation element (i.e. declaration, not usage).

Parameters:

element - annotation type element

Returns:

InjectAnnotationMirror

from

public static com.google.common.base.Optional<InjectAnnotationMirror> from(javax.lang.model.element.AnnotationMirror mirror)

Tries to convert annotation mirror to this annotation type.

Parameters:

mirror - annotation mirror

Returns:

optional InjectAnnotationMirror, present if mirror matched this annotation type

code

public java.lang.String code()

Returns:

value of attribute code

typeName

public java.lang.String typeName()

Returns:

type name for value of attribute type

typeMirror

public javax.lang.model.type.TypeMirror typeMirror()

Returns:

type mirror for value of attribute type

type

@Deprecated
public java.lang.Class<? extends java.lang.annotation.Annotation> type()

Deprecated.

Always throws UnsupportedOperationException. Use typeMirror() or typeName.

ifPresent

public boolean ifPresent()

Returns:

value of attribute ifPresent

target

public AnnotationInjections.InjectAnnotation.Where[] target()

Returns:

value of attribute target

deduplicationKey

public java.lang.String deduplicationKey()

Returns:

value of attribute deduplicationKey

getAnnotationMirror

public javax.lang.model.element.AnnotationMirror getAnnotationMirror()

Returns:

underlying annotation mirror

annotationType

public java.lang.Class<? extends java.lang.annotation.Annotation> annotationType()

Specified by:

annotationType in interface java.lang.annotation.Annotation

Returns:

InjectAnnotation.class

hashCode

public int hashCode()

Specified by:

hashCode in interface java.lang.annotation.Annotation

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Specified by:

equals in interface java.lang.annotation.Annotation

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface java.lang.annotation.Annotation

Overrides:

toString in class java.lang.Object