org.mapstruct.ap.prism

Class DecoratedWithPrism

java.lang.Object

org.mapstruct.ap.prism.DecoratedWithPrism

public class DecoratedWithPrism
extends java.lang.Object

A Prism representing an @org.mapstruct.DecoratedWith annotation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DecoratedWithPrism.Values A class whose members corespond to those of org.mapstruct.DecoratedWith but which each return the AnnotationValue corresponding to that member in the model of the annotations.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isValid Determine whether the underlying AnnotationMirror has no errors.
javax.lang.model.element.AnnotationMirror	mirror The underlying AnnotationMirror of the annotation represented by this Prism.
DecoratedWithPrism.Values	values An instance of the Values inner class whose methods return the AnnotationValues used to build this prism.

Method Summary

Modifier and Type	Method and Description
static DecoratedWithPrism	getInstance(javax.lang.model.element.AnnotationMirror mirror) Return a prism of the @org.mapstruct.DecoratedWith annotation whose mirror is mirror.
static DecoratedWithPrism	getInstanceOn(javax.lang.model.element.Element e) Return a prism representing the @org.mapstruct.DecoratedWith annotation on 'e'.
javax.lang.model.type.TypeMirror	value() Returns a TypeMirror representing the value of the java.lang.Class<?> value() member of the Annotation.

Methods inherited from class java.lang.Object

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

Field Detail

values

public final DecoratedWithPrism.Values values

An instance of the Values inner class whose methods return the AnnotationValues used to build this prism. Primarily intended to support using Messager.

isValid

public final boolean isValid

Determine whether the underlying AnnotationMirror has no errors. True if the underlying AnnotationMirror has no errors. When true is returned, none of the methods will return null. When false is returned, a least one member will either return null, or another prism that is not valid.

mirror

public final javax.lang.model.element.AnnotationMirror mirror

The underlying AnnotationMirror of the annotation represented by this Prism. Primarily intended to support using Messager.

Method Detail

getInstanceOn

public static DecoratedWithPrism getInstanceOn(javax.lang.model.element.Element e)

Return a prism representing the @org.mapstruct.DecoratedWith annotation on 'e'. similar to e.getAnnotation(org.mapstruct.DecoratedWith.class) except that an instance of this class rather than an instance of org.mapstruct.DecoratedWith is returned.

getInstance

public static DecoratedWithPrism getInstance(javax.lang.model.element.AnnotationMirror mirror)

Return a prism of the @org.mapstruct.DecoratedWith annotation whose mirror is mirror.

value

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

Returns a TypeMirror representing the value of the java.lang.Class<?> value() member of the Annotation.

See Also:

DecoratedWith.value()