From af9074ce13f78c636b310bd8ada159a358da86f6 Mon Sep 17 00:00:00 2001
From: sjaakd <sjaakderksen@zonnet.nl>
Date: Tue, 1 Apr 2014 23:35:00 +0200
Subject: [PATCH] #102 addressing some comments (config iso mapperConfig,
 removing TYPE.PACKAGE from annotation, adding class javadoc, renaming
 MapperSettings to more logical MapperConfig)

---
 core/src/main/java/org/mapstruct/Mapper.java  |  6 +++---
 .../main/java/org/mapstruct/MapperConfig.java |  8 +++----
 ...nnotationBasedComponentModelProcessor.java |  4 ++--
 .../ap/processor/MapperCreationProcessor.java |  6 +++---
 .../processor/MethodRetrievalProcessor.java   |  4 ++--
 ...{MapperSettings.java => MapperConfig.java} | 21 ++++++++++++-------
 .../test/mapperconfig/SourceTargetMapper.java |  2 +-
 .../mapperconfig/SourceTargetMapperError.java |  2 +-
 .../mapperconfig/SourceTargetMapperWarn.java  |  2 +-
 9 files changed, 31 insertions(+), 24 deletions(-)
 rename processor/src/main/java/org/mapstruct/ap/util/{MapperSettings.java => MapperConfig.java} (80%)

diff --git a/core/src/main/java/org/mapstruct/Mapper.java b/core/src/main/java/org/mapstruct/Mapper.java
index 030e19006..a92fcab7f 100644
--- a/core/src/main/java/org/mapstruct/Mapper.java
+++ b/core/src/main/java/org/mapstruct/Mapper.java
@@ -45,7 +45,7 @@ public @interface Mapper {
     /**
      * How unmapped properties of the target type of a mapping should be
      * reported. The method overrides an unmappedTargetPolicy set in a central
-     * configuration set by {@link #mapperConfig() }
+     * configuration set by {@link #config() }
      *
      * @return The reporting policy for unmapped target properties.
      */
@@ -68,7 +68,7 @@ public @interface Mapper {
      * can be retrieved via {@code @Inject}</li>
      * </ul>
      * The method overrides an unmappedTargetPolicy set in a central configuration set
-     * by {@link #mapperConfig() }
+     * by {@link #config() }
 
 * @return The component model for the generated mapper.
      */
@@ -79,6 +79,6 @@ public @interface Mapper {
      *
      * @return a centralized class with {@link MapperConfig} annotation.
      */
-    Class<?> mapperConfig() default void.class;
+    Class<?> config() default void.class;
 
 }
diff --git a/core/src/main/java/org/mapstruct/MapperConfig.java b/core/src/main/java/org/mapstruct/MapperConfig.java
index a49f3b46b..eb4b4197b 100644
--- a/core/src/main/java/org/mapstruct/MapperConfig.java
+++ b/core/src/main/java/org/mapstruct/MapperConfig.java
@@ -26,14 +26,14 @@ import java.lang.annotation.Target;
 import org.mapstruct.factory.Mappers;
 
 /**
- * Marks a class-, interface-, enum declaration or package declaration as (common) configuration.
+ * Marks a class-, interface-, enum declaration as (common) configuration.
  *
- * The {@link #unmappedTargetPolicy() } and {@link #componentModel() } an be overruled by a specific {@link Mapper}
+ * The {@link #unmappedTargetPolicy() } and {@link #componentModel() } can be overruled by a specific {@link Mapper}
  * annotation. {@link #uses() } will be used in addition to what is specified in the {@link Mapper} annotation.
  *
  * @author Sjaak Derksen
  */
-@Target( { ElementType.TYPE, ElementType.PACKAGE } )
+@Target( { ElementType.TYPE } )
 @Retention(RetentionPolicy.SOURCE)
 public @interface MapperConfig {
 
@@ -50,7 +50,7 @@ public @interface MapperConfig {
      *
      * @return The reporting policy for unmapped target properties.
      */
-    ReportingPolicy unmappedTargetPolicy() default ReportingPolicy.DEFAULT;
+    ReportingPolicy unmappedTargetPolicy() default ReportingPolicy.WARN;
 
     /**
      * Specifies the component model to which the generated mapper should
diff --git a/processor/src/main/java/org/mapstruct/ap/processor/AnnotationBasedComponentModelProcessor.java b/processor/src/main/java/org/mapstruct/ap/processor/AnnotationBasedComponentModelProcessor.java
index b62493dfa..6feca2ecd 100644
--- a/processor/src/main/java/org/mapstruct/ap/processor/AnnotationBasedComponentModelProcessor.java
+++ b/processor/src/main/java/org/mapstruct/ap/processor/AnnotationBasedComponentModelProcessor.java
@@ -27,7 +27,7 @@ import org.mapstruct.ap.model.Mapper;
 import org.mapstruct.ap.model.MapperReference;
 import org.mapstruct.ap.model.common.TypeFactory;
 import org.mapstruct.ap.option.OptionsHelper;
-import org.mapstruct.ap.util.MapperSettings;
+import org.mapstruct.ap.util.MapperConfig;
 
 /**
  * An {@link ModelElementProcessor} which converts the given {@link Mapper}
@@ -45,7 +45,7 @@ public abstract class AnnotationBasedComponentModelProcessor implements ModelEle
     public Mapper process(ProcessorContext context, TypeElement mapperTypeElement, Mapper mapper) {
         this.typeFactory = context.getTypeFactory();
 
-        String componentModel = MapperSettings.getInstanceOn( mapperTypeElement ).componentModel();
+        String componentModel = MapperConfig.getInstanceOn( mapperTypeElement ).componentModel();
         String effectiveComponentModel = OptionsHelper.getEffectiveComponentModel(
             context.getOptions(),
             componentModel
diff --git a/processor/src/main/java/org/mapstruct/ap/processor/MapperCreationProcessor.java b/processor/src/main/java/org/mapstruct/ap/processor/MapperCreationProcessor.java
index e3d96b831..61f3006c4 100644
--- a/processor/src/main/java/org/mapstruct/ap/processor/MapperCreationProcessor.java
+++ b/processor/src/main/java/org/mapstruct/ap/processor/MapperCreationProcessor.java
@@ -71,7 +71,7 @@ import org.mapstruct.ap.prism.DecoratedWithPrism;
 import org.mapstruct.ap.prism.MapperPrism;
 import org.mapstruct.ap.util.Executables;
 import org.mapstruct.ap.util.Filters;
-import org.mapstruct.ap.util.MapperSettings;
+import org.mapstruct.ap.util.MapperConfig;
 import org.mapstruct.ap.util.Strings;
 
 /**
@@ -152,7 +152,7 @@ public class MapperCreationProcessor implements ModelElementProcessor<List<Sourc
      * @return The effective policy for reporting unmapped getReturnType properties.
      */
     private ReportingPolicy getEffectiveUnmappedTargetPolicy(TypeElement element) {
-        MapperSettings mapperSettings = MapperSettings.getInstanceOn( element );
+        MapperConfig mapperSettings = MapperConfig.getInstanceOn( element );
         boolean setViaAnnotation = mapperSettings.isSetUnmappedTargetPolicy();
         ReportingPolicy annotationValue = ReportingPolicy.valueOf( mapperSettings.unmappedTargetPolicy() );
 
@@ -244,7 +244,7 @@ public class MapperCreationProcessor implements ModelElementProcessor<List<Sourc
         List<MapperReference> mapperReferences = new LinkedList<MapperReference>();
         List<String> variableNames = new LinkedList<String>();
 
-        MapperSettings mapperPrism = MapperSettings.getInstanceOn( element );
+        MapperConfig mapperPrism = MapperConfig.getInstanceOn( element );
 
         for ( TypeMirror usedMapper : mapperPrism.uses() ) {
             DefaultMapperReference mapperReference = DefaultMapperReference.getInstance(
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 1f074e7a3..2697b87e0 100644
--- a/processor/src/main/java/org/mapstruct/ap/processor/MethodRetrievalProcessor.java
+++ b/processor/src/main/java/org/mapstruct/ap/processor/MethodRetrievalProcessor.java
@@ -48,7 +48,7 @@ import org.mapstruct.ap.prism.MapMappingPrism;
 import org.mapstruct.ap.prism.MappingPrism;
 import org.mapstruct.ap.prism.MappingsPrism;
 import org.mapstruct.ap.util.AnnotationProcessingException;
-import org.mapstruct.ap.util.MapperSettings;
+import org.mapstruct.ap.util.MapperConfig;
 
 /**
  * A {@link ModelElementProcessor} which retrieves a list of {@link SourceMethod}s
@@ -99,7 +99,7 @@ public class MethodRetrievalProcessor implements ModelElementProcessor<Void, Lis
 
         //Add all methods of used mappers in order to reference them in the aggregated model
         if ( mapperRequiresImplementation ) {
-            MapperSettings mapperSettings = MapperSettings.getInstanceOn( element );
+            MapperConfig mapperSettings = MapperConfig.getInstanceOn( element );
             if ( !mapperSettings.isValid() ) {
                 throw new AnnotationProcessingException(
                     "Couldn't retrieve @Mapper annotation", element, mapperSettings.getAnnotationMirror()
diff --git a/processor/src/main/java/org/mapstruct/ap/util/MapperSettings.java b/processor/src/main/java/org/mapstruct/ap/util/MapperConfig.java
similarity index 80%
rename from processor/src/main/java/org/mapstruct/ap/util/MapperSettings.java
rename to processor/src/main/java/org/mapstruct/ap/util/MapperConfig.java
index 6d6ec27d0..71d9cacf4 100644
--- a/processor/src/main/java/org/mapstruct/ap/util/MapperSettings.java
+++ b/processor/src/main/java/org/mapstruct/ap/util/MapperConfig.java
@@ -32,25 +32,32 @@ import org.mapstruct.ap.prism.MapperConfigPrism;
 import org.mapstruct.ap.prism.MapperPrism;
 
 /**
+ * Class decorating the {@link MapperPrism} with the 'default' configuration.
+ *
+ * If no configuration for a property is defined in the {@link org.mapstruct.Mapper} annotation this
+ * decorator will revert to the {@link org.mapstruct.Mapper#config() } defined mapper.
+ *
+ * {@link org.mapstruct.MapperConfig#uses() } will add its Mappers to the ones defined in
+ * {@link org.mapstruct.Mapper#uses() }
  *
  * @author Sjaak Derksen
  */
-public class MapperSettings {
+public class MapperConfig {
 
     private final MapperPrism mapperPrism;
     private final MapperConfigPrism mapperConfigPrism;
 
-    public static MapperSettings getInstanceOn(Element e) {
-        return new MapperSettings( MapperPrism.getInstanceOn( e ) );
+    public static MapperConfig getInstanceOn(Element e) {
+        return new MapperConfig( MapperPrism.getInstanceOn( e ) );
     }
 
-    public static MapperSettings getInstance(AnnotationMirror mirror ) {
-        return new MapperSettings( MapperPrism.getInstance( mirror ) );
+    public static MapperConfig getInstance(AnnotationMirror mirror ) {
+        return new MapperConfig( MapperPrism.getInstance( mirror ) );
     }
 
-    private MapperSettings( MapperPrism mapperPrism ) {
+    private MapperConfig( MapperPrism mapperPrism ) {
         this.mapperPrism = mapperPrism;
-        TypeMirror typeMirror = mapperPrism.mapperConfig();
+        TypeMirror typeMirror = mapperPrism.config();
         if ( typeMirror.getKind().equals( TypeKind.DECLARED ) ) {
             this.mapperConfigPrism = MapperConfigPrism.getInstanceOn( ( (DeclaredType) typeMirror ).asElement() );
         }
diff --git a/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapper.java b/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapper.java
index 89084b6f2..8e49da89d 100644
--- a/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapper.java
+++ b/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapper.java
@@ -25,7 +25,7 @@ import org.mapstruct.factory.Mappers;
  *
  * @author Sjaak Derksen
  */
-@Mapper(uses = { CustomMapperViaMapper.class }, mapperConfig = CentralConfig.class )
+@Mapper(uses = { CustomMapperViaMapper.class }, config = CentralConfig.class )
 public interface SourceTargetMapper {
 
     SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
diff --git a/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapperError.java b/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapperError.java
index 940408b67..82cab8e8d 100644
--- a/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapperError.java
+++ b/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapperError.java
@@ -25,7 +25,7 @@ import org.mapstruct.factory.Mappers;
  *
  * @author Sjaak Derksen
  */
-@Mapper(uses = { CustomMapperViaMapper.class }, mapperConfig = CentralConfig.class )
+@Mapper(uses = { CustomMapperViaMapper.class }, config = CentralConfig.class )
 public interface SourceTargetMapperError {
 
     SourceTargetMapperError INSTANCE = Mappers.getMapper( SourceTargetMapperError.class );
diff --git a/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapperWarn.java b/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapperWarn.java
index 7d2d42648..f1d77f018 100644
--- a/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapperWarn.java
+++ b/processor/src/test/java/org/mapstruct/ap/test/mapperconfig/SourceTargetMapperWarn.java
@@ -27,7 +27,7 @@ import org.mapstruct.factory.Mappers;
  * @author Sjaak Derksen
  */
 @Mapper(uses = { CustomMapperViaMapper.class },
-        mapperConfig = CentralConfig.class,
+        config = CentralConfig.class,
         unmappedTargetPolicy = ReportingPolicy.WARN
 )
 public interface SourceTargetMapperWarn {