third_codes/mapstruct
1
0
Fork 0
mirror of https://github.com/mapstruct/mapstruct.git synced 2025-07-12 00:00:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

#1 Supporting "is" prefix for boolean getter methods

Browse Source
This commit is contained in:
Gunnar Morling 2013-05-19 18:40:35 +02:00
parent 87e0da6f96
commit f4a2260d80
10 changed files with 229 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
processor/src/main/java/org/mapstruct/ap/MapperGenerationVisitor.java
View File

@ -52,8 +52,8 @@ import org.mapstruct.ap.model.source.MappedProperty;
import org.mapstruct.ap.model.source.Mapping;
import org.mapstruct.ap.model.source.Method;
import org.mapstruct.ap.model.source.Parameter;
import org.mapstruct.ap.util.Executables;
import org.mapstruct.ap.util.Filters;
import org.mapstruct.ap.util.Strings;
import org.mapstruct.ap.util.TypeUtil;
import org.mapstruct.ap.writer.ModelWriter;
@ -158,9 +158,11 @@ public class MapperGenerationVisitor extends ElementKindVisitor6<Void, Void> {
propertyMappings.add(
new PropertyMapping(
property.getSourceName(),
property.getSourceReadAccessorName(),
property.getSourceWriteAccessorName(),
property.getSourceType(),
property.getTargetName(),
property.getTargetReadAccessorName(),
property.getTargetWriteAccessorName(),
property.getTargetType(),
propertyMappingMethod != null ? new MappingMethod(
propertyMappingMethod.getDeclaringMapper(),
@ -173,15 +175,11 @@ public class MapperGenerationVisitor extends ElementKindVisitor6<Void, Void> {
reversePropertyMappingMethod.getParameterName()
) : null,
conversion != null ? conversion.to(
mappingMethod.getParameterName() + "." + getAccessor(
property.getSourceName()
),
mappingMethod.getParameterName() + "." + property.getSourceReadAccessorName() + "()",
property.getTargetType()
) : null,
conversion != null ? conversion.from(
reverseMappingMethod.getParameterName() + "." + getAccessor(
property.getTargetName()
),
reverseMappingMethod.getParameterName() + "." + property.getTargetReadAccessorName() + "()",
property.getSourceType()
) : null
)
@ -246,10 +244,6 @@ public class MapperGenerationVisitor extends ElementKindVisitor6<Void, Void> {
return usedMapperTypes;
}
private String getAccessor(String name) {
return "get" + Strings.capitalize( name ) + "()";
}
private MappingMethod getElementMappingMethod(Iterable<Method> methods, Method method) {
Method elementMappingMethod = null;
for ( Method oneMethod : methods ) {
@ -376,19 +370,27 @@ public class MapperGenerationVisitor extends ElementKindVisitor6<Void, Void> {
for ( ExecutableElement getterMethod : Filters.getterMethodsIn( parameterElement.getEnclosedElements() ) ) {
String sourcePropertyName = getPropertyName( getterMethod );
String sourcePropertyName = Executables.getPropertyName( getterMethod );
Mapping mapping = mappings.get( sourcePropertyName );
for ( ExecutableElement setterMethod : Filters.setterMethodsIn( returnTypeElement.getEnclosedElements() ) ) {
String targetPropertyName = getPropertyName( setterMethod );
String targetPropertyName = Executables.getPropertyName( setterMethod );
if ( targetPropertyName.equals( mapping != null ? mapping.getTargetName() : sourcePropertyName ) ) {
properties.add(
new MappedProperty(
sourcePropertyName,
getterMethod.getSimpleName().toString(),
Executables.getCorrespondingSetterMethod( parameterElement, getterMethod )
.getSimpleName()
.toString(),
retrieveReturnType( getterMethod ),
mapping != null ? mapping.getTargetName() : targetPropertyName,
Executables.getCorrespondingGetterMethod( returnTypeElement, setterMethod )
.getSimpleName()
.toString(),
setterMethod.getSimpleName().toString(),
retrieveParameter( setterMethod ).getType()
)
);
@ -399,13 +401,6 @@ public class MapperGenerationVisitor extends ElementKindVisitor6<Void, Void> {
return properties;
}
private String getPropertyName(ExecutableElement getterOrSetterMethod) {
//TODO consider is/has
return Introspector.decapitalize(
getterOrSetterMethod.getSimpleName().toString().substring( 3 )
);
}
private Map<String, Mapping> getMappings(MappingsPrism mappingsAnnotation) {
Map<String, Mapping> mappings = new HashMap<String, Mapping>();

43
processor/src/main/java/org/mapstruct/ap/model/PropertyMapping.java
View File

@ -18,21 +18,34 @@
*/
package org.mapstruct.ap.model;
/**
* Represents the mapping between a source and target property, e.g. from
* {@code String Source#foo} to {@code int Target#bar}. Name and type of source
* and target property can differ. If they have different types, the mapping
* must either refer to a mapping method or a conversion.
*
* @author Gunnar Morling
*/
public class PropertyMapping {
private final String sourceName;
private final String sourceReadAccessorName;
private final String sourceWriteAccessorName;
private final Type sourceType;
private final String targetName;
private final String targetReadAccessorName;
private final String targetWriteAccessorName;
private final Type targetType;
private final MappingMethod mappingMethod;
private final MappingMethod reverseMappingMethod;
private final String toConversion;
private final String fromConversion;
public PropertyMapping(String sourceName, Type sourceType, String targetName, Type targetType, MappingMethod mappingMethod, MappingMethod reverseMappingMethod, String toConversion, String fromConversion) {
this.sourceName = sourceName;
public PropertyMapping(String sourceReadAccessorName, String sourceWriteAccessorName, Type sourceType, String targetReadAccessorName, String targetWriteAccessorName, Type targetType, MappingMethod mappingMethod, MappingMethod reverseMappingMethod, String toConversion, String fromConversion) {
this.sourceReadAccessorName = sourceReadAccessorName;
this.sourceWriteAccessorName = sourceWriteAccessorName;
this.sourceType = sourceType;
this.targetName = targetName;
this.targetReadAccessorName = targetReadAccessorName;
this.targetWriteAccessorName = targetWriteAccessorName;
this.targetType = targetType;
this.mappingMethod = mappingMethod;
this.reverseMappingMethod = reverseMappingMethod;
@ -40,16 +53,24 @@ public class PropertyMapping {
this.fromConversion = fromConversion;
}
public String getSourceName() {
return sourceName;
public String getSourceReadAccessorName() {
return sourceReadAccessorName;
}
public String getSourceWriteAccessorName() {
return sourceWriteAccessorName;
}
public Type getSourceType() {
return sourceType;
}
public String getTargetName() {
return targetName;
public String getTargetReadAccessorName() {
return targetReadAccessorName;
}
public String getTargetWriteAccessorName() {
return targetWriteAccessorName;
}
public Type getTargetType() {
@ -75,9 +96,9 @@ public class PropertyMapping {
@Override
public String toString() {
return "PropertyMapping {" +
"\n sourceName='" + sourceName + "\'," +
"\n sourceName='" + sourceReadAccessorName + "/" + sourceWriteAccessorName + "\'," +
"\n sourceType=" + sourceType + "," +
"\n targetName='" + targetName + "\'," +
"\n targetName='" + targetReadAccessorName + "/" + targetWriteAccessorName + "\'," +
"\n targetType=" + targetType + "," +
"\n mappingMethod=" + mappingMethod + "," +
"\n reverseMappingMethod=" + reverseMappingMethod + "," +

28
processor/src/main/java/org/mapstruct/ap/model/source/MappedProperty.java
View File

@ -23,14 +23,24 @@ import org.mapstruct.ap.model.Type;
public class MappedProperty {
private final String sourceName;
private final String sourceReadAccessorName;
private final String sourceWriteAccessorName;
private final Type sourceType;
private final String targetName;
private final String targetReadAccessorName;
private final String targetWriteAccessorName;
private final Type targetType;
public MappedProperty(String sourceName, Type sourceType, String targetName, Type targetType) {
public MappedProperty(String sourceName, String sourceReadAccessorName, String sourceWriteAccessorName,
Type sourceType, String targetName, String targetReadAccessorName, String targetWriteAccessorName,
Type targetType) {
this.sourceName = sourceName;
this.sourceReadAccessorName = sourceReadAccessorName;
this.sourceWriteAccessorName = sourceWriteAccessorName;
this.sourceType = sourceType;
this.targetName = targetName;
this.targetReadAccessorName = targetReadAccessorName;
this.targetWriteAccessorName = targetWriteAccessorName;
this.targetType = targetType;
}
@ -38,6 +48,14 @@ public class MappedProperty {
return sourceName;
}
public String getSourceReadAccessorName() {
return sourceReadAccessorName;
}
public String getSourceWriteAccessorName() {
return sourceWriteAccessorName;
}
public Type getSourceType() {
return sourceType;
}
@ -46,6 +64,14 @@ public class MappedProperty {
return targetName;
}
public String getTargetReadAccessorName() {
return targetReadAccessorName;
}
public String getTargetWriteAccessorName() {
return targetWriteAccessorName;
}
public Type getTargetType() {
return targetType;
}

109
processor/src/main/java/org/mapstruct/ap/util/Executables.java Normal file
View File

@ -0,0 +1,109 @@
/**
* Copyright 2012-2013 Gunnar Morling (http://www.gunnarmorling.de/)
* and/or other contributors as indicated by the @authors tag. See the
* copyright.txt file in the distribution for a full listing of all
* contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.mapstruct.ap.util;
import java.beans.Introspector;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.type.TypeKind;
/**
* Provides functionality around {@link ExecutableElement}s.
*
* @author Gunnar Morling
*/
public class Executables {
public static boolean isGetterMethod(ExecutableElement method) {
return isNonBooleanGetterMethod( method ) || isBooleanGetterMethod( method );
}
private static boolean isNonBooleanGetterMethod(ExecutableElement method) {
String name = method.getSimpleName().toString();
return method.getParameters().isEmpty() &&
name.startsWith( "get" ) &&
name.length() > 3 &&
method.getReturnType().getKind() != TypeKind.VOID;
}
private static boolean isBooleanGetterMethod(ExecutableElement method) {
String name = method.getSimpleName().toString();
return method.getParameters().isEmpty() &&
name.startsWith( "is" ) &&
name.length() > 2 &&
method.getReturnType().getKind() == TypeKind.BOOLEAN;
}
public static boolean isSetterMethod(ExecutableElement method) {
String name = method.getSimpleName().toString();
if ( name.startsWith( "set" ) && name.length() > 3 && method.getParameters()
.size() == 1 && method.getReturnType().getKind() == TypeKind.VOID ) {
return true;
}
return false;
}
public static String getPropertyName(ExecutableElement getterOrSetterMethod) {
if ( isNonBooleanGetterMethod( getterOrSetterMethod ) ) {
return Introspector.decapitalize(
getterOrSetterMethod.getSimpleName().toString().substring( 3 )
);
}
else if ( isBooleanGetterMethod( getterOrSetterMethod ) ) {
return Introspector.decapitalize(
getterOrSetterMethod.getSimpleName().toString().substring( 2 )
);
}
else if ( isSetterMethod( getterOrSetterMethod ) ) {
return Introspector.decapitalize(
getterOrSetterMethod.getSimpleName().toString().substring( 3 )
);
}
throw new IllegalArgumentException( "Executable " + getterOrSetterMethod + " is not getter or setter method." );
}
public static ExecutableElement getCorrespondingSetterMethod(Element element, ExecutableElement getterMethod) {
String propertyName = getPropertyName( getterMethod );
for ( ExecutableElement setterMethod : Filters.setterMethodsIn( element.getEnclosedElements() ) ) {
if ( getPropertyName( setterMethod ).equals( propertyName ) ) {
return setterMethod;
}
}
return null;
}
public static ExecutableElement getCorrespondingGetterMethod(Element element, ExecutableElement setterMethod) {
String propertyName = getPropertyName( setterMethod );
for ( ExecutableElement getterMethod : Filters.getterMethodsIn( element.getEnclosedElements() ) ) {
if ( getPropertyName( getterMethod ).equals( propertyName ) ) {
return getterMethod;
}
}
return null;
}
}

13
processor/src/main/java/org/mapstruct/ap/util/Filters.java
View File

@ -22,7 +22,6 @@ import java.util.LinkedList;
import java.util.List;
import javax.lang.model.element.Element;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.type.TypeKind;
import static javax.lang.model.util.ElementFilter.methodsIn;
@ -37,11 +36,7 @@ public class Filters {
List<ExecutableElement> getterMethods = new LinkedList<ExecutableElement>();
for ( ExecutableElement method : methodsIn( elements ) ) {
//TODO: consider is/has
String name = method.getSimpleName().toString();
if ( name.startsWith( "get" ) && name.length() > 3 && method.getParameters()
.isEmpty() && method.getReturnType().getKind() != TypeKind.VOID ) {
if ( Executables.isGetterMethod( method ) ) {
getterMethods.add( method );
}
}
@ -53,11 +48,7 @@ public class Filters {
List<ExecutableElement> setterMethods = new LinkedList<ExecutableElement>();
for ( ExecutableElement method : methodsIn( elements ) ) {
//TODO: consider is/has
String name = method.getSimpleName().toString();
if ( name.startsWith( "set" ) && name.length() > 3 && method.getParameters()
.size() == 1 && method.getReturnType().getKind() == TypeKind.VOID ) {
if ( Executables.isSetterMethod( method ) ) {
setterMethods.add( method );
}
}

6
processor/src/main/java/org/mapstruct/ap/util/NativeTypes.java
View File

@ -22,6 +22,12 @@ import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
/**
* Provides functionality around the Java primitive data types and their wrapper
* types.
*
* @author Gunnar Morling
*/
public class NativeTypes {
private final static Map<Class<?>, Class<?>> wrapperToPrimitiveTypes;

24
processor/src/main/resources/mapper-implementation.ftl
View File

@ -69,10 +69,10 @@ public class ${implementationName} implements ${interfaceName} {
<@simpleMap
sourceBeanName=beanMapping.mappingMethod.parameterName
sourceType=propertyMapping.sourceType
sourcePropertyName=propertyMapping.sourceName
sourceAccessorName=propertyMapping.sourceReadAccessorName
targetBeanName=beanMapping.targetType.name?uncap_first
targetType=propertyMapping.targetType
targetPropertyName=propertyMapping.targetName?cap_first
targetAccessorName=propertyMapping.targetWriteAccessorName
conversion=propertyMapping.toConversion
mappingMethod=propertyMapping.mappingMethod
/>
@ -119,10 +119,10 @@ public class ${implementationName} implements ${interfaceName} {
<@simpleMap
sourceBeanName=beanMapping.reverseMappingMethod.parameterName
sourceType=propertyMapping.targetType
sourcePropertyName=propertyMapping.targetName
sourceAccessorName=propertyMapping.targetReadAccessorName
targetBeanName=beanMapping.sourceType.name?uncap_first
targetType=propertyMapping.sourceType
targetPropertyName=propertyMapping.sourceName?cap_first
targetAccessorName=propertyMapping.sourceWriteAccessorName
conversion=propertyMapping.fromConversion
mappingMethod=propertyMapping.reverseMappingMethod
/>
@ -137,27 +137,27 @@ public class ${implementationName} implements ${interfaceName} {
}
<#-- Generates the mapping of one bean property -->
<#macro simpleMap sourceBeanName sourceType sourcePropertyName targetBeanName targetType targetPropertyName conversion="" mappingMethod="">
<#macro simpleMap sourceBeanName sourceType sourceAccessorName targetBeanName targetType targetAccessorName conversion="" mappingMethod="">
<#-- a) simple conversion -->
<#if conversion != "">
<#if sourceType.primitive == false>
if ( ${sourceBeanName}.get${sourcePropertyName?cap_first}() != null ) {
${targetBeanName}.set${targetPropertyName}( ${conversion} );
if ( ${sourceBeanName}.${sourceAccessorName}() != null ) {
${targetBeanName}.${targetAccessorName}( ${conversion} );
}
<#else>
${targetBeanName}.set${targetPropertyName}( ${conversion} );
${targetBeanName}.${targetAccessorName}( ${conversion} );
</#if>
<#-- b) invoke mapping method -->
<#elseif mappingMethod != "">
${targetBeanName}.set${targetPropertyName}( <#if mappingMethod.declaringMapper??>${mappingMethod.declaringMapper.name?uncap_first}.</#if>${mappingMethod.name}( ${sourceBeanName}.get${sourcePropertyName?cap_first}() ) );
${targetBeanName}.${targetAccessorName}( <#if mappingMethod.declaringMapper??>${mappingMethod.declaringMapper.name?uncap_first}.</#if>${mappingMethod.name}( ${sourceBeanName}.${sourceAccessorName}() ) );
<#else>
<#if targetType.collectionType == true>
if ( ${sourceBeanName}.get${sourcePropertyName?cap_first}() != null ) {
${targetBeanName}.set${targetPropertyName}( new <#if targetType.collectionImplementationType??>${targetType.collectionImplementationType.name}<#else>${targetType.name}</#if><#if targetType.elementType??><${targetType.elementType.name}></#if>( ${sourceBeanName}.get${sourcePropertyName?cap_first}() ) );
if ( ${sourceBeanName}.${sourceAccessorName}() != null ) {
${targetBeanName}.${targetAccessorName}( new <#if targetType.collectionImplementationType??>${targetType.collectionImplementationType.name}<#else>${targetType.name}</#if><#if targetType.elementType??><${targetType.elementType.name}></#if>( ${sourceBeanName}.${sourceAccessorName}() ) );
}
<#-- c) simply set -->
<#else>
${targetBeanName}.set${targetPropertyName}( ${sourceBeanName}.get${sourcePropertyName?cap_first}() );
${targetBeanName}.${targetAccessorName}( ${sourceBeanName}.${sourceAccessorName}() );
</#if>
</#if>
</#macro>

4
processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/BooleanConversionTest.java
View File

@ -34,22 +34,26 @@ public class BooleanConversionTest extends MapperTestBase {
@Test
public void shouldApplyBooleanConversion() {
BooleanSource source = new BooleanSource();
source.setB( true );
source.setBool( true );
BooleanTarget target = BooleanMapper.INSTANCE.sourceToTarget( source );
assertThat( target ).isNotNull();
assertThat( target.getB() ).isEqualTo( Boolean.TRUE );
assertThat( target.getBool() ).isEqualTo( Boolean.TRUE );
}
@Test
public void shouldApplyReverseBooleanConversion() {
BooleanTarget target = new BooleanTarget();
target.setB( Boolean.TRUE );
target.setBool( Boolean.TRUE );
BooleanSource source = BooleanMapper.INSTANCE.targetToSource( target );
assertThat( source ).isNotNull();
assertThat( source.isB() ).isEqualTo( true );
assertThat( source.getBool() ).isEqualTo( true );
}
}

10
processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/BooleanSource.java
View File

@ -20,6 +20,16 @@ package org.mapstruct.ap.test.conversion.nativetypes;
public class BooleanSource {
private boolean b;
public boolean isB() {
return b;
}
public void setB(boolean b) {
this.b = b;
}
private boolean bool;
public boolean getBool() {

10
processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/BooleanTarget.java
View File

@ -20,8 +20,18 @@ package org.mapstruct.ap.test.conversion.nativetypes;
public class BooleanTarget {
private Boolean b;
private Boolean bool;
public Boolean getB() {
return b;
}
public void setB(Boolean b) {
this.b = b;
}
public Boolean getBool() {
return bool;
}