org.mapstruct.ap.prism

Class MapperConfigPrism

java.lang.Object

org.mapstruct.ap.prism.MapperConfigPrism

public class MapperConfigPrism
extends java.lang.Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapperConfigPrism.Values A class whose members corespond to those of org.mapstruct.MapperConfig 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.
MapperConfigPrism.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	collectionMappingStrategy() Returns a String representing the value of the org.mapstruct.CollectionMappingStrategy collectionMappingStrategy() member of the Annotation.
java.lang.String	componentModel() Returns a String representing the value of the java.lang.String componentModel() member of the Annotation.
static MapperConfigPrism	getInstance(javax.lang.model.element.AnnotationMirror mirror) Return a prism of the @org.mapstruct.MapperConfig annotation whose mirror is mirror.
static MapperConfigPrism	getInstanceOn(javax.lang.model.element.Element e) Return a prism representing the @org.mapstruct.MapperConfig annotation on 'e'.
java.lang.String	unmappedTargetPolicy() Returns a String representing the value of the org.mapstruct.ReportingPolicy unmappedTargetPolicy() member of the Annotation.
java.util.List<javax.lang.model.type.TypeMirror>	uses() Returns a List representing the value of the uses() 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 MapperConfigPrism.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 MapperConfigPrism getInstanceOn(javax.lang.model.element.Element e)

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

getInstance

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

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

uses

public java.util.List<javax.lang.model.type.TypeMirror> uses()

Returns a List representing the value of the uses() member of the Annotation.

See Also:

MapperConfig.uses()

unmappedTargetPolicy

public java.lang.String unmappedTargetPolicy()

Returns a String representing the value of the org.mapstruct.ReportingPolicy unmappedTargetPolicy() member of the Annotation.

See Also:

MapperConfig.unmappedTargetPolicy()

componentModel

public java.lang.String componentModel()

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

See Also:

MapperConfig.componentModel()

collectionMappingStrategy

public java.lang.String collectionMappingStrategy()

Returns a String representing the value of the org.mapstruct.CollectionMappingStrategy collectionMappingStrategy() member of the Annotation.

See Also:

MapperConfig.collectionMappingStrategy()