mapstruct#33 Fixing CheckStyle issues

gunnarmorling · gunnarmorling · commit fd286e17ab4b · 2013-06-01T18:11:11.000+02:00
diff --git a/core/src/main/java/org/mapstruct/Mappers.java b/core/src/main/java/org/mapstruct/Mappers.java
@@ -25,7 +25,10 @@
  */
 public class Mappers {
 
-    private final static String IMPLEMENTATION_SUFFIX = "Impl";
+    private static final String IMPLEMENTATION_SUFFIX = "Impl";
+
+    private Mappers() {
+    }
 
     /**
      * Returns an instance of the given mapper type.
diff --git a/core/src/test/java/org/mapstruct/MappersTest.java b/core/src/test/java/org/mapstruct/MappersTest.java
@@ -18,12 +18,16 @@
  */
 package org.mapstruct;
 
-
 import org.mapstruct.test.model.Foo;
 import org.testng.annotations.Test;
 
 import static org.fest.assertions.Assertions.assertThat;
 
+/**
+ * Unit test for {@link Mappers}.
+ *
+ * @author Gunnar Morling
+ */
 public class MappersTest {
 
     @Test
diff --git a/integrationtest/src/main/java/org/mapstruct/itest/SourceTargetMapper.java b/integrationtest/src/main/java/org/mapstruct/itest/SourceTargetMapper.java
@@ -26,7 +26,7 @@
 @Mapper
 public interface SourceTargetMapper {
 
-    public static SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
+    SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
 
     @Mappings({
         @Mapping(source = "qax", target = "baz"),
diff --git a/processor/src/main/java/org/mapstruct/ap/MapperGenerationVisitor.java b/processor/src/main/java/org/mapstruct/ap/MapperGenerationVisitor.java
@@ -62,7 +62,7 @@
 
 public class MapperGenerationVisitor extends ElementKindVisitor6<Void, Void> {
 
-    private final static String IMPLEMENTATION_SUFFIX = "Impl";
+    private static final String IMPLEMENTATION_SUFFIX = "Impl";
 
     private final ProcessingEnvironment processingEnvironment;
     private final Types typeUtils;
@@ -235,7 +235,9 @@ private List<BeanMapping> getMappings(List<Method> methods) {
         return mappings;
     }
 
-    private void reportErrorIfPropertyCanNotBeMapped(Method method, Method reverseMethod, MappedProperty property, Method propertyMappingMethod, Method reversePropertyMappingMethod, Conversion conversion) {
+    private void reportErrorIfPropertyCanNotBeMapped(Method method, Method reverseMethod, MappedProperty property,
+                                                     Method propertyMappingMethod, Method reversePropertyMappingMethod,
+                                                     Conversion conversion) {
         if ( property.getSourceType().equals( property.getTargetType() ) ) {
             return;
         }
@@ -282,7 +284,8 @@ private void reportErrorIfPropertyCanNotBeMapped(Method method, Method reverseMe
         }
     }
 
-    private String getIterableConversionString(Conversions conversions, Type sourceElementType, Type targetElementType, boolean isToConversion) {
+    private String getIterableConversionString(Conversions conversions, Type sourceElementType, Type targetElementType,
+                                               boolean isToConversion) {
         Conversion conversion = conversions.getConversion( sourceElementType, targetElementType );
 
         if ( conversion == null ) {
@@ -435,7 +438,8 @@ private List<MappedProperty> getMappedProperties(ExecutableElement method, Map<S
             String sourcePropertyName = Executables.getPropertyName( getterMethod );
             Mapping mapping = mappings.get( sourcePropertyName );
 
-            for ( ExecutableElement setterMethod : Filters.setterMethodsIn( returnTypeElement.getEnclosedElements() ) ) {
+            for ( ExecutableElement setterMethod :Filters.setterMethodsIn( returnTypeElement
+                    .getEnclosedElements() ) ) {
 
                 String targetPropertyName = Executables.getPropertyName( setterMethod );
 
diff --git a/processor/src/main/java/org/mapstruct/ap/conversion/PrimitiveToStringConversion.java b/processor/src/main/java/org/mapstruct/ap/conversion/PrimitiveToStringConversion.java
@@ -43,6 +43,7 @@ public String to(String sourcePropertyAccessor, Type type) {
 
     @Override
     public String from(String targetPropertyAccessor, Type type) {
-        return wrapperType.getSimpleName() + ".parse" + Strings.capitalize( sourceType.getSimpleName() ) + "( " + targetPropertyAccessor + " )";
+        return wrapperType.getSimpleName() + ".parse" + Strings.capitalize( sourceType.getSimpleName() ) + "( " +
+            targetPropertyAccessor + " )";
     }
 }
diff --git a/processor/src/main/java/org/mapstruct/ap/conversion/WrapperToStringConversion.java b/processor/src/main/java/org/mapstruct/ap/conversion/WrapperToStringConversion.java
@@ -43,6 +43,7 @@ public String to(String sourcePropertyAccessor, Type type) {
 
     @Override
     public String from(String targetPropertyAccessor, Type type) {
-        return sourceType.getSimpleName() + ".parse" + Strings.capitalize( primitiveType.getSimpleName() ) + "( " + targetPropertyAccessor + " )";
+        return sourceType.getSimpleName() + ".parse" + Strings.capitalize( primitiveType.getSimpleName() ) + "( " +
+            targetPropertyAccessor + " )";
     }
 }
diff --git a/processor/src/main/java/org/mapstruct/ap/model/BeanMapping.java b/processor/src/main/java/org/mapstruct/ap/model/BeanMapping.java
@@ -31,7 +31,8 @@ public class BeanMapping {
     private final String toConversion;
     private final String fromConversion;
 
-    public BeanMapping(Type sourceType, Type targetType, List<PropertyMapping> propertyMappings, MappingMethod mappingMethod,
+    public BeanMapping(Type sourceType, Type targetType, List<PropertyMapping> propertyMappings,
+                       MappingMethod mappingMethod,
                        MappingMethod reverseMappingMethod, String toConversion, String fromConversion) {
         this.sourceType = sourceType;
         this.targetType = targetType;
diff --git a/processor/src/main/java/org/mapstruct/ap/model/Mapper.java b/processor/src/main/java/org/mapstruct/ap/model/Mapper.java
@@ -35,7 +35,8 @@ public class Mapper {
     private final SortedSet<Type> importedTypes;
 
     public Mapper(String packageName, String interfaceName,
-                  String implementationName, List<BeanMapping> beanMappings, List<Type> usedMapperTypes, Options options) {
+                  String implementationName, List<BeanMapping> beanMappings, List<Type> usedMapperTypes,
+                  Options options) {
         this.packageName = packageName;
         this.interfaceName = interfaceName;
         this.implementationName = implementationName;
diff --git a/processor/src/main/java/org/mapstruct/ap/model/PropertyMapping.java b/processor/src/main/java/org/mapstruct/ap/model/PropertyMapping.java
@@ -40,7 +40,10 @@ public class PropertyMapping {
     private final String toConversion;
     private final String fromConversion;
 
-    public PropertyMapping(String sourceReadAccessorName, String sourceWriteAccessorName, Type sourceType, String targetReadAccessorName, String targetWriteAccessorName, Type targetType, MappingMethod mappingMethod, MappingMethod reverseMappingMethod, String toConversion, String fromConversion) {
+    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;
diff --git a/processor/src/main/java/org/mapstruct/ap/model/Type.java b/processor/src/main/java/org/mapstruct/ap/model/Type.java
@@ -34,20 +34,22 @@
  */
 public class Type implements Comparable<Type> {
 
-    private final static Set<String> primitiveTypeNames = new HashSet<String>(
+    private static final Set<String> PRIMITIVE_TYPE_NAMES = new HashSet<String>(
         Arrays.asList( "boolean", "char", "byte", "short", "int", "long", "float", "double" )
     );
 
-    private final static ConcurrentMap<String, Type> defaultIterableImplementationTypes = new ConcurrentHashMap<String, Type>();
-    private final static ConcurrentMap<String, Type> defaultCollectionImplementationTypes = new ConcurrentHashMap<String, Type>();
+    private static final ConcurrentMap<String, Type> DEFAULT_ITERABLE_IMPLEMENTATION_TYPES =
+            new ConcurrentHashMap<String, Type>();
+    private static final ConcurrentMap<String, Type> DEFAULT_COLLECTION_IMPLEMENTATION_TYPES =
+            new ConcurrentHashMap<String, Type>();
 
     static {
-        defaultCollectionImplementationTypes.put( List.class.getName(), forClass( ArrayList.class ) );
-        defaultCollectionImplementationTypes.put( Set.class.getName(), forClass( HashSet.class ) );
-        defaultCollectionImplementationTypes.put( Collection.class.getName(), forClass( ArrayList.class ) );
+        DEFAULT_COLLECTION_IMPLEMENTATION_TYPES.put( List.class.getName(), forClass( ArrayList.class ) );
+        DEFAULT_COLLECTION_IMPLEMENTATION_TYPES.put( Set.class.getName(), forClass( HashSet.class ) );
+        DEFAULT_COLLECTION_IMPLEMENTATION_TYPES.put( Collection.class.getName(), forClass( ArrayList.class ) );
 
-        defaultIterableImplementationTypes.put( Iterable.class.getName(), forClass( ArrayList.class ) );
-        defaultIterableImplementationTypes.putAll( defaultCollectionImplementationTypes );
+        DEFAULT_ITERABLE_IMPLEMENTATION_TYPES.put( Iterable.class.getName(), forClass( ArrayList.class ) );
+        DEFAULT_ITERABLE_IMPLEMENTATION_TYPES.putAll( DEFAULT_COLLECTION_IMPLEMENTATION_TYPES );
     }
 
     private final String packageName;
@@ -81,7 +83,8 @@ public Type(String name) {
         this( null, name, null, false, false, false );
     }
 
-    public Type(String packageName, String name, Type elementType, boolean isEnumType, boolean isCollectionType, boolean isIterableType) {
+    public Type(String packageName, String name, Type elementType, boolean isEnumType, boolean isCollectionType,
+                boolean isIterableType) {
         this.packageName = packageName;
         this.name = name;
         this.elementType = elementType;
@@ -90,14 +93,14 @@ public Type(String packageName, String name, Type elementType, boolean isEnumTyp
         this.isIterableType = isIterableType;
 
         if ( isCollectionType ) {
-            collectionImplementationType = defaultCollectionImplementationTypes.get( packageName + "." + name );
+            collectionImplementationType = DEFAULT_COLLECTION_IMPLEMENTATION_TYPES.get( packageName + "." + name );
         }
         else {
             collectionImplementationType = null;
         }
 
         if ( isIterableType ) {
-            iterableImplementationType = defaultIterableImplementationTypes.get( packageName + "." + name );
+            iterableImplementationType = DEFAULT_ITERABLE_IMPLEMENTATION_TYPES.get( packageName + "." + name );
         }
         else {
             iterableImplementationType = null;
@@ -117,7 +120,7 @@ public Type getElementType() {
     }
 
     public boolean isPrimitive() {
-        return packageName == null && primitiveTypeNames.contains( name );
+        return packageName == null && PRIMITIVE_TYPE_NAMES.contains( name );
     }
 
     public boolean isEnumType() {
diff --git a/processor/src/main/java/org/mapstruct/ap/model/source/MappedProperty.java b/processor/src/main/java/org/mapstruct/ap/model/source/MappedProperty.java
@@ -32,7 +32,8 @@ public class MappedProperty {
     private final Type targetType;
 
     public MappedProperty(String sourceName, String sourceReadAccessorName, String sourceWriteAccessorName,
-                          Type sourceType, String targetName, String targetReadAccessorName, String targetWriteAccessorName,
+                          Type sourceType, String targetName, String targetReadAccessorName,
+                          String targetWriteAccessorName,
                           Type targetType) {
         this.sourceName = sourceName;
         this.sourceReadAccessorName = sourceReadAccessorName;
diff --git a/processor/src/main/java/org/mapstruct/ap/model/source/Method.java b/processor/src/main/java/org/mapstruct/ap/model/source/Method.java
@@ -33,7 +33,8 @@ public class Method {
     private final Type targetType;
     private final List<MappedProperty> mappedProperties;
 
-    public Method(Type declaringMapper, ExecutableElement executable, String parameterName, Type sourceType, Type targetType, List<MappedProperty> mappedProperties) {
+    public Method(Type declaringMapper, ExecutableElement executable, String parameterName, Type sourceType,
+                  Type targetType, List<MappedProperty> mappedProperties) {
         this.declaringMapper = declaringMapper;
         this.executable = executable;
         this.parameterName = parameterName;
diff --git a/processor/src/main/java/org/mapstruct/ap/util/Executables.java b/processor/src/main/java/org/mapstruct/ap/util/Executables.java
@@ -30,6 +30,9 @@
  */
 public class Executables {
 
+    private Executables() {
+    }
+
     public static boolean isGetterMethod(ExecutableElement method) {
         return isNonBooleanGetterMethod( method ) || isBooleanGetterMethod( method );
     }
diff --git a/processor/src/main/java/org/mapstruct/ap/util/Filters.java b/processor/src/main/java/org/mapstruct/ap/util/Filters.java
@@ -32,6 +32,9 @@
  */
 public class Filters {
 
+    private Filters() {
+    }
+
     public static List<ExecutableElement> getterMethodsIn(Iterable<? extends Element> elements) {
         List<ExecutableElement> getterMethods = new LinkedList<ExecutableElement>();
 
diff --git a/processor/src/main/java/org/mapstruct/ap/util/NativeTypes.java b/processor/src/main/java/org/mapstruct/ap/util/NativeTypes.java
@@ -30,8 +30,11 @@
  */
 public class NativeTypes {
 
-    private final static Map<Class<?>, Class<?>> wrapperToPrimitiveTypes;
-    private final static Map<Class<?>, Class<?>> primitiveToWrapperTypes;
+    private static final Map<Class<?>, Class<?>> WRAPPER_TO_PRIMITIVE_TYPES;
+    private static final Map<Class<?>, Class<?>> PRIMITIVE_TO_WRAPPER_TYPES;
+
+    private NativeTypes() {
+    }
 
     static {
         Map<Class<?>, Class<?>> tmp = new HashMap<Class<?>, Class<?>>();
@@ -44,7 +47,7 @@ public class NativeTypes {
         tmp.put( Boolean.class, boolean.class );
         tmp.put( Character.class, char.class );
 
-        wrapperToPrimitiveTypes = Collections.unmodifiableMap( tmp );
+        WRAPPER_TO_PRIMITIVE_TYPES = Collections.unmodifiableMap( tmp );
 
         tmp = new HashMap<Class<?>, Class<?>>();
         tmp.put( byte.class, Byte.class );
@@ -56,22 +59,22 @@ public class NativeTypes {
         tmp.put( boolean.class, Boolean.class );
         tmp.put( char.class, Character.class );
 
-        primitiveToWrapperTypes = Collections.unmodifiableMap( tmp );
+        PRIMITIVE_TO_WRAPPER_TYPES = Collections.unmodifiableMap( tmp );
     }
 
     public static Class<?> getWrapperType(Class<?> clazz) {
         if ( !clazz.isPrimitive() ) {
             throw new IllegalArgumentException( clazz + " is no primitive type." );
         }
 
-        return primitiveToWrapperTypes.get( clazz );
+        return PRIMITIVE_TO_WRAPPER_TYPES.get( clazz );
     }
 
     public static Class<?> getPrimitiveType(Class<?> clazz) {
         if ( clazz.isPrimitive() ) {
             throw new IllegalArgumentException( clazz + " is no wrapper type." );
         }
 
-        return wrapperToPrimitiveTypes.get( clazz );
+        return WRAPPER_TO_PRIMITIVE_TYPES.get( clazz );
     }
 }
diff --git a/processor/src/main/java/org/mapstruct/ap/util/Strings.java b/processor/src/main/java/org/mapstruct/ap/util/Strings.java
@@ -20,8 +20,10 @@
 
 public class Strings {
 
+    private Strings() {
+    }
+
     public static String capitalize(String name) {
         return name == null ? null : name.substring( 0, 1 ).toUpperCase() + name.substring( 1 );
     }
-
 }
diff --git a/processor/src/main/java/org/mapstruct/ap/writer/ModelWriter.java b/processor/src/main/java/org/mapstruct/ap/writer/ModelWriter.java
@@ -25,16 +25,26 @@
 import freemarker.template.DefaultObjectWrapper;
 import freemarker.template.Template;
 
+/**
+ * Writes Java source files based on given mapper models, using a FreeMarker
+ * template.
+ *
+ * @author Gunnar Morling
+ */
 public class ModelWriter {
 
-    private static final Configuration configuration;
+    /**
+     * FreeMarker configuration. As per the documentation, thread-safe if not
+     * altered after original initialization
+     */
+    private static final Configuration CONFIGURATION;
 
     private final String templateName;
 
     static {
-        configuration = new Configuration();
-        configuration.setClassForTemplateLoading( ModelWriter.class, "/" );
-        configuration.setObjectWrapper( new DefaultObjectWrapper() );
+        CONFIGURATION = new Configuration();
+        CONFIGURATION.setClassForTemplateLoading( ModelWriter.class, "/" );
+        CONFIGURATION.setObjectWrapper( new DefaultObjectWrapper() );
     }
 
     public ModelWriter(String templateName) {
@@ -46,7 +56,7 @@ public void writeModel(JavaFileObject sourceFile, Object model) {
         try {
             BufferedWriter writer = new BufferedWriter( sourceFile.openWriter() );
 
-            Template template = configuration.getTemplate( templateName );
+            Template template = CONFIGURATION.getTemplate( templateName );
             template.process( model, writer );
             writer.flush();
             writer.close();
diff --git a/processor/src/test/java/org/mapstruct/ap/test/collection/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/collection/SourceTargetMapper.java
@@ -28,7 +28,7 @@
 @Mapper
 public interface SourceTargetMapper {
 
-    public static SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
+    SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
 
     @Mappings({
         @Mapping(source = "integerList", target = "integerCollection"),
diff --git a/processor/src/test/java/org/mapstruct/ap/test/collection/defaultimplementation/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/collection/defaultimplementation/SourceTargetMapper.java
@@ -28,7 +28,7 @@
 @Mapper
 public interface SourceTargetMapper {
 
-    public static SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
+    SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
 
     Target sourceToTarget(Source source);
 
diff --git a/processor/src/test/java/org/mapstruct/ap/test/collection/iterabletononiterable/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/collection/iterabletononiterable/SourceTargetMapper.java
@@ -24,7 +24,7 @@
 @Mapper(uses = StringListMapper.class)
 public interface SourceTargetMapper {
 
-    public static SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
+    SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
 
     Target sourceToTarget(Source source);
 
diff --git a/processor/src/test/java/org/mapstruct/ap/test/conversion/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/conversion/SourceTargetMapper.java
@@ -26,7 +26,7 @@
 @Mapper
 public interface SourceTargetMapper {
 
-    public static SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
+    SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
 
     @Mappings({
         @Mapping(source = "qax", target = "baz"),
diff --git a/processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/BooleanMapper.java b/processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/BooleanMapper.java
@@ -24,7 +24,7 @@
 @Mapper
 public interface BooleanMapper {
 
-    public static BooleanMapper INSTANCE = Mappers.getMapper( BooleanMapper.class );
+    BooleanMapper INSTANCE = Mappers.getMapper( BooleanMapper.class );
 
     BooleanTarget sourceToTarget(BooleanSource source);
 
diff --git a/processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/CharMapper.java b/processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/CharMapper.java
@@ -24,7 +24,7 @@
 @Mapper
 public interface CharMapper {
 
-    public static CharMapper INSTANCE = Mappers.getMapper( CharMapper.class );
+    CharMapper INSTANCE = Mappers.getMapper( CharMapper.class );
 
     CharTarget sourceToTarget(CharSource source);
 
diff --git a/processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/conversion/nativetypes/SourceTargetMapper.java
@@ -24,7 +24,7 @@
 @Mapper
 public interface SourceTargetMapper {
 
-    public static SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
+    SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
 
     ByteTarget sourceToTarget(ByteSource source);
 
diff --git a/processor/src/test/java/org/mapstruct/ap/test/conversion/precedence/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/conversion/precedence/SourceTargetMapper.java
diff --git a/processor/src/test/java/org/mapstruct/ap/test/conversion/string/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/conversion/string/SourceTargetMapper.java
diff --git a/processor/src/test/java/org/mapstruct/ap/testutil/compilation/model/CompilationOutcomeDescriptor.java b/processor/src/test/java/org/mapstruct/ap/testutil/compilation/model/CompilationOutcomeDescriptor.java
diff --git a/processor/src/test/java/org/mapstruct/ap/testutil/compilation/model/DiagnosticDescriptor.java b/processor/src/test/java/org/mapstruct/ap/testutil/compilation/model/DiagnosticDescriptor.java

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ public String to(String sourcePropertyAccessor, Type type) {`
`43`	`43`
`44`	`44`	`@Override`
`45`	`45`	`public String from(String targetPropertyAccessor, Type type) {`
`46`		`- return wrapperType.getSimpleName() + ".parse" + Strings.capitalize( sourceType.getSimpleName() ) + "( " + targetPropertyAccessor + " )";`
	`46`	`+ return wrapperType.getSimpleName() + ".parse" + Strings.capitalize( sourceType.getSimpleName() ) + "( " +`
	`47`	`+ targetPropertyAccessor + " )";`
`47`	`48`	`}`
`48`	`49`	`}`