org.mapstruct.ap.model.source

Class SourceReference

java.lang.Object

org.mapstruct.ap.model.source.SourceReference

public class SourceReference
extends Object

This class describes the source side of a property mapping.

It contains the source parameter, and all individual (nested) property entries. So consider the following mapping method:

 @Mapping(source = "in.propA.propB" target = "propC")
 TypeB mappingMethod(TypeA in);
 

Then:

• parameter will describe in
• propertyEntries[0] will describe propA
• propertyEntries[1] will describe propB

After building, isValid() will return true when when no problems are detected during building.

Author:

Sjaak Derksen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SourceReference.BuilderFromMapping Builds a SourceReference from an @Mappping.
static class	SourceReference.BuilderFromProperty Builds a SourceReference from a property.
static class	SourceReference.PropertyEntry A PropertyEntry contains information on the name, accessor and return type of a property.

Method Summary

Modifier and Type	Method and Description
SourceReference	copyForInheritanceTo(SourceMethod method) Creates a copy of this reference, which is adapted to the given method
List<String>	getElementNames()
Parameter	getParameter()
List<SourceReference.PropertyEntry>	getPropertyEntries()
boolean	isValid()

Methods inherited from class java.lang.Object

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

Method Detail

getParameter

public Parameter getParameter()

getPropertyEntries

public List<SourceReference.PropertyEntry> getPropertyEntries()

isValid

public boolean isValid()

getElementNames

public List<String> getElementNames()

copyForInheritanceTo

public SourceReference copyForInheritanceTo(SourceMethod method)

Creates a copy of this reference, which is adapted to the given method