From bcda1d25b7a951db425e34ff104f09c104ddeef1 Mon Sep 17 00:00:00 2001 From: Gunnar Morling Date: Tue, 18 Nov 2014 22:10:25 +0100 Subject: [PATCH] #327 Improving method name; Formatting --- .../org/mapstruct/ap/model/common/Type.java | 3 +- .../processor/MethodRetrievalProcessor.java | 5 ++- .../org/mapstruct/ap/util/Executables.java | 35 +++++++++---------- .../abstractclass/AbstractBaseMapper.java | 1 - .../test/abstractclass/AbstractClassTest.java | 14 ++++---- .../ap/test/abstractclass/AbstractDto.java | 1 - .../AbstractReferencedMapper.java | 1 - .../abstractclass/BaseMapperInterface.java | 1 - .../ap/test/abstractclass/Identifiable.java | 1 - .../ap/test/abstractclass/Measurable.java | 1 - .../test/abstractclass/ReferencedMapper.java | 1 - .../ReferencedMapperInterface.java | 1 - .../ap/test/abstractclass/Source.java | 3 +- .../abstractclass/SourceTargetMapper.java | 2 +- 14 files changed, 30 insertions(+), 40 deletions(-) diff --git a/processor/src/main/java/org/mapstruct/ap/model/common/Type.java b/processor/src/main/java/org/mapstruct/ap/model/common/Type.java index cee88077a..a3b813340 100644 --- a/processor/src/main/java/org/mapstruct/ap/model/common/Type.java +++ b/processor/src/main/java/org/mapstruct/ap/model/common/Type.java @@ -24,7 +24,6 @@ import java.util.Collections; import java.util.List; import java.util.Map; import java.util.Set; - import javax.lang.model.element.AnnotationMirror; import javax.lang.model.element.Element; import javax.lang.model.element.ElementKind; @@ -288,7 +287,7 @@ public class Type extends ModelElement implements Comparable { private List getAllExecutables() { if ( allExecutables == null ) { - allExecutables = Executables.getAllEnclosingExecutableElements( elementUtils, typeElement ); + allExecutables = Executables.getAllEnclosedExecutableElements( elementUtils, typeElement ); } return allExecutables; diff --git a/processor/src/main/java/org/mapstruct/ap/processor/MethodRetrievalProcessor.java b/processor/src/main/java/org/mapstruct/ap/processor/MethodRetrievalProcessor.java index 4cd68877f..f4d4468e7 100644 --- a/processor/src/main/java/org/mapstruct/ap/processor/MethodRetrievalProcessor.java +++ b/processor/src/main/java/org/mapstruct/ap/processor/MethodRetrievalProcessor.java @@ -22,7 +22,6 @@ import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; - import javax.annotation.processing.Messager; import javax.lang.model.element.ExecutableElement; import javax.lang.model.element.Modifier; @@ -48,7 +47,7 @@ import org.mapstruct.ap.prism.MappingsPrism; import org.mapstruct.ap.util.AnnotationProcessingException; import org.mapstruct.ap.util.MapperConfig; -import static org.mapstruct.ap.util.Executables.getAllEnclosingExecutableElements; +import static org.mapstruct.ap.util.Executables.getAllEnclosedExecutableElements; /** * A {@link ModelElementProcessor} which retrieves a list of {@link SourceMethod}s @@ -90,7 +89,7 @@ public class MethodRetrievalProcessor implements ModelElementProcessor retrieveMethods(TypeElement usedMapper, TypeElement mapperToImplement) { List methods = new ArrayList(); - for ( ExecutableElement executable : getAllEnclosingExecutableElements( elementUtils, usedMapper ) ) { + for ( ExecutableElement executable : getAllEnclosedExecutableElements( elementUtils, usedMapper ) ) { SourceMethod method = getMethod( usedMapper, executable, mapperToImplement ); if ( method != null ) { methods.add( method ); diff --git a/processor/src/main/java/org/mapstruct/ap/util/Executables.java b/processor/src/main/java/org/mapstruct/ap/util/Executables.java index a7b082057..2263aa8ec 100644 --- a/processor/src/main/java/org/mapstruct/ap/util/Executables.java +++ b/processor/src/main/java/org/mapstruct/ap/util/Executables.java @@ -23,7 +23,6 @@ import java.util.ArrayList; import java.util.HashSet; import java.util.List; import java.util.Set; - import javax.lang.model.element.ExecutableElement; import javax.lang.model.element.Modifier; import javax.lang.model.element.TypeElement; @@ -168,6 +167,7 @@ public class Executables { /** * @param mirror the type mirror + * * @return the corresponding type element */ private static TypeElement asTypeElement(TypeMirror mirror) { @@ -181,21 +181,18 @@ public class Executables { * * @param elementUtils element helper * @param element the element to inspect + * * @return the executable elements usable in the type */ - public static List getAllEnclosingExecutableElements( - Elements elementUtils, TypeElement element) { + public static List getAllEnclosedExecutableElements(Elements elementUtils, TypeElement element) { List enclosedElements = new ArrayList(); - addEnclosingElementsIncludingSuper( elementUtils, enclosedElements, element ); return enclosedElements; } - private static void addEnclosingElementsIncludingSuper(Elements elementUtils, - List alreadyAdded, - TypeElement element) { - + private static void addEnclosingElementsIncludingSuper(Elements elementUtils, List alreadyAdded, + TypeElement element) { addNotYetOverridden( elementUtils, alreadyAdded, methodsIn( element.getEnclosedElements() ) ); if ( hasNonObjectSuperclass( element ) ) { @@ -210,12 +207,11 @@ public class Executables { /** * @param alreadyCollected methods that have already been collected and to which the not-yet-overridden methods will - * be added + * be added * @param methodsToAdd methods to add to alreadyAdded, if they are not yet overridden by an element in the list */ private static void addNotYetOverridden(Elements elementUtils, List alreadyCollected, - List methodsToAdd) { - + List methodsToAdd) { List safeToAdd = new ArrayList( methodsToAdd.size() ); for ( ExecutableElement toAdd : methodsToAdd ) { if ( isNotObjectEquals( toAdd ) && wasNotYetOverridden( elementUtils, alreadyCollected, toAdd ) ) { @@ -228,13 +224,15 @@ public class Executables { /** * @param executable the executable to check - * @return true, iff the executable does not represent {@link java.lang.Object#equals(Object)} or an - * overridden version of it + * + * @return {@code true}, iff the executable does not represent {@link java.lang.Object#equals(Object)} or an + * overridden version of it */ private static boolean isNotObjectEquals(ExecutableElement executable) { if ( executable.getSimpleName().contentEquals( "equals" ) && executable.getParameters().size() == 1 && asTypeElement( executable.getParameters().get( 0 ).asType() ).getQualifiedName().contentEquals( - "java.lang.Object" ) ) { + "java.lang.Object" + ) ) { return false; } return true; @@ -243,9 +241,10 @@ public class Executables { /** * @param elementUtils the elementUtils * @param methods the list of already collected methods of one type hierarchy (order is from sub-types to - * super-types) + * super-types) * @param executable the method to check - * @return true, iff the given executable was not yet overridden by a method in the given list. + * + * @return {@code true}, iff the given executable was not yet overridden by a method in the given list. */ private static boolean wasNotYetOverridden(Elements elementUtils, List alreadyAdded, ExecutableElement executable) { @@ -261,11 +260,11 @@ public class Executables { /** * @param element the type element to check - * @return true, iff the type has a super-class that is not java.lang.Object + * + * @return {@code true}, iff the type has a super-class that is not java.lang.Object */ private static boolean hasNonObjectSuperclass(TypeElement element) { return element.getSuperclass().getKind() == TypeKind.DECLARED && asTypeElement( element.getSuperclass() ).getSuperclass().getKind() == TypeKind.DECLARED; } - } diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractBaseMapper.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractBaseMapper.java index 71540b642..3e9a61f7e 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractBaseMapper.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractBaseMapper.java @@ -20,7 +20,6 @@ package org.mapstruct.ap.test.abstractclass; /** * @author Andreas Gudian - * */ public abstract class AbstractBaseMapper implements BaseMapperInterface { public abstract Target sourceToTargetFromBaseMapper(Source source); diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractClassTest.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractClassTest.java index 7cbfa87fd..87d16160c 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractClassTest.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractClassTest.java @@ -31,19 +31,21 @@ import static org.fest.assertions.Assertions.assertThat; * * @author Gunnar Morling */ -@WithClasses( { Source.class, Target.class, SourceTargetMapper.class, AbstractBaseMapper.class, +@WithClasses({ + Source.class, Target.class, SourceTargetMapper.class, AbstractBaseMapper.class, BaseMapperInterface.class, ReferencedMapper.class, AbstractReferencedMapper.class, ReferencedMapperInterface.class, AbstractDto.class, Identifiable.class, - Measurable.class } ) -@RunWith( AnnotationProcessorTestRunner.class ) + Measurable.class +}) +@RunWith(AnnotationProcessorTestRunner.class) public class AbstractClassTest { @Test - @IssueKey( "64" ) + @IssueKey("64") public void shouldCreateImplementationOfAbstractMethod() { Source source = new Source(); @@ -51,7 +53,7 @@ public class AbstractClassTest { } @Test - @IssueKey( "165" ) + @IssueKey("165") public void shouldCreateImplementationOfMethodFromSuper() { Source source = new Source(); @@ -59,7 +61,7 @@ public class AbstractClassTest { } @Test - @IssueKey( "165" ) + @IssueKey("165") public void shouldCreateImplementationOfMethodFromInterface() { Source source = new Source(); diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractDto.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractDto.java index 05ebd2a6b..628ebe473 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractDto.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractDto.java @@ -20,7 +20,6 @@ package org.mapstruct.ap.test.abstractclass; /** * @author Andreas Gudian - * */ public class AbstractDto implements Identifiable { private Long id = 1L; diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractReferencedMapper.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractReferencedMapper.java index 3385ad97b..8563aff19 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractReferencedMapper.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/AbstractReferencedMapper.java @@ -22,7 +22,6 @@ import javax.xml.ws.Holder; /** * @author Andreas Gudian - * */ public abstract class AbstractReferencedMapper implements ReferencedMapperInterface { @Override diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/BaseMapperInterface.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/BaseMapperInterface.java index c8d8b9982..4aa3b8420 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/BaseMapperInterface.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/BaseMapperInterface.java @@ -20,7 +20,6 @@ package org.mapstruct.ap.test.abstractclass; /** * @author Andreas Gudian - * */ public interface BaseMapperInterface { Target sourceToTargetFromBaseMapperInterface(Source source); diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Identifiable.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Identifiable.java index fd31b0de3..844dd3b79 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Identifiable.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Identifiable.java @@ -20,7 +20,6 @@ package org.mapstruct.ap.test.abstractclass; /** * @author Andreas Gudian - * */ public interface Identifiable { Long getId(); diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Measurable.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Measurable.java index 89dc59214..6b470de39 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Measurable.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Measurable.java @@ -20,7 +20,6 @@ package org.mapstruct.ap.test.abstractclass; /** * @author Andreas Gudian - * */ public interface Measurable { int getSize(); diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/ReferencedMapper.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/ReferencedMapper.java index f791dbdd4..f0635737f 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/ReferencedMapper.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/ReferencedMapper.java @@ -22,7 +22,6 @@ import javax.xml.ws.Holder; /** * @author Andreas Gudian - * */ public class ReferencedMapper extends AbstractReferencedMapper { @Override diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/ReferencedMapperInterface.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/ReferencedMapperInterface.java index d46c9b5cb..e54a20f17 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/ReferencedMapperInterface.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/ReferencedMapperInterface.java @@ -22,7 +22,6 @@ import javax.xml.ws.Holder; /** * @author Andreas Gudian - * */ public interface ReferencedMapperInterface { int holderToInt(Holder holder); diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Source.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Source.java index 1407e258c..8cbd737e8 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Source.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/Source.java @@ -19,7 +19,6 @@ package org.mapstruct.ap.test.abstractclass; import java.util.Calendar; - import javax.xml.ws.Holder; public class Source extends AbstractDto { @@ -27,7 +26,7 @@ public class Source extends AbstractDto { private final int size; private final Calendar birthday; private final String notAttractingEqualsMethod = "no way"; - private final Holder manuallyConverted = new Holder("What is the answer?"); + private final Holder manuallyConverted = new Holder( "What is the answer?" ); public Source() { size = 181; diff --git a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/SourceTargetMapper.java index 8b2cf87be..ea1dd8410 100644 --- a/processor/src/test/java/org/mapstruct/ap/test/abstractclass/SourceTargetMapper.java +++ b/processor/src/test/java/org/mapstruct/ap/test/abstractclass/SourceTargetMapper.java @@ -25,7 +25,7 @@ import java.util.Calendar; import org.mapstruct.Mapper; import org.mapstruct.factory.Mappers; -@Mapper( uses = ReferencedMapper.class ) +@Mapper(uses = ReferencedMapper.class) public abstract class SourceTargetMapper extends AbstractBaseMapper { public static final SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );