org.mapstruct.ap

Class IterableMappingPrism

java.lang.Object

org.mapstruct.ap.IterableMappingPrism

public class IterableMappingPrism
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IterableMappingPrism.Values A class whose members corespond to those of org.mapstruct.IterableMapping 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.
AnnotationMirror	mirror The underlying AnnotationMirror of the annotation represented by this Prism.
IterableMappingPrism.Values	values An instance of the Values inner class whose methods return the AnnotationValues used to build this prism.

Method Summary

Methods

Modifier and Type	Method and Description
String	dateFormat() Returns a String representing the value of the java.lang.String dateFormat() member of the Annotation.
static IterableMappingPrism	getInstance(AnnotationMirror mirror) Return a prism of the @org.mapstruct.IterableMapping annotation whose mirror is mirror.
static IterableMappingPrism	getInstanceOn(Element e) Return a prism representing the @org.mapstruct.IterableMapping annotation on 'e'.

Methods inherited from class java.lang.Object

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

Field Detail

values

public final IterableMappingPrism.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 AnnotationMirror mirror

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

Method Detail

getInstanceOn

public static IterableMappingPrism getInstanceOn(Element e)

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

getInstance

public static IterableMappingPrism getInstance(AnnotationMirror mirror)

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

dateFormat

public String dateFormat()

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

See Also:

IterableMapping.dateFormat()