org.mapstruct.ap.prism

Class MappingPrism

java.lang.Object

org.mapstruct.ap.prism.MappingPrism

public class MappingPrism
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MappingPrism.Values A class whose members corespond to those of org.mapstruct.Mapping 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.
MappingPrism.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
java.lang.String	constant() Returns a String representing the value of the java.lang.String constant() member of the Annotation.
java.lang.String	dateFormat() Returns a String representing the value of the java.lang.String dateFormat() member of the Annotation.
java.lang.String	expression() Returns a String representing the value of the java.lang.String expression() member of the Annotation.
static MappingPrism	getInstance(javax.lang.model.element.AnnotationMirror mirror) Return a prism of the @org.mapstruct.Mapping annotation whose mirror is mirror.
static MappingPrism	getInstanceOn(javax.lang.model.element.Element e) Return a prism representing the @org.mapstruct.Mapping annotation on 'e'.
java.lang.Boolean	ignore() Returns a Boolean representing the value of the boolean ignore() member of the Annotation.
java.lang.String	source() Returns a String representing the value of the java.lang.String source() member of the Annotation.
java.lang.String	target() Returns a String representing the value of the java.lang.String target() 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 MappingPrism.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 MappingPrism getInstanceOn(javax.lang.model.element.Element e)

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

getInstance

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

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

source

public java.lang.String source()

Returns a String representing the value of the java.lang.String source() member of the Annotation.

See Also:

Mapping.source()

target

public java.lang.String target()

Returns a String representing the value of the java.lang.String target() member of the Annotation.

See Also:

Mapping.target()

dateFormat

public java.lang.String dateFormat()

Returns a String representing the value of the java.lang.String dateFormat() member of the Annotation.

See Also:

Mapping.dateFormat()

constant

public java.lang.String constant()

Returns a String representing the value of the java.lang.String constant() member of the Annotation.

See Also:

Mapping.constant()

expression

public java.lang.String expression()

Returns a String representing the value of the java.lang.String expression() member of the Annotation.

See Also:

Mapping.expression()

ignore

public java.lang.Boolean ignore()

Returns a Boolean representing the value of the boolean ignore() member of the Annotation.

See Also:

Mapping.ignore()