Including diff properties.

Author: jonpereiradev

src/main/java/com/github/jonpereiradev/diffobjects/DiffObjects.java

@@ -1,9 +1,10 @@
 package com.github.jonpereiradev.diffobjects;
 
-import com.github.jonpereiradev.diffobjects.builder.DiffConfigurationBuilder;
+import com.github.jonpereiradev.diffobjects.builder.DiffConfiguration;
 import com.github.jonpereiradev.diffobjects.strategy.DiffMetadata;
 import com.github.jonpereiradev.diffobjects.strategy.DiffReflections;
 
+import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Objects;
@@ -51,15 +52,17 @@ public static <T> boolean isEquals(T beforeState, T afterState) {
      * @param afterState  objeto com as informaçnoes depois da alteração.
      * @return resultado do instance.
      */
-    public static <T> List<DiffResult<?>> diff(T beforeState, T afterState, DiffConfigurationBuilder configuration) {
+    public static <T> List<DiffResult<?>> diff(T beforeState, T afterState, DiffConfiguration configuration) {
         Objects.requireNonNull(beforeState, "Before state is required.");
         Objects.requireNonNull(afterState, "After state is required.");
         Objects.requireNonNull(configuration, "Configuration is required.");
 
         List<DiffResult<?>> results = new LinkedList<>();
 
         for (DiffMetadata metadata : configuration.build()) {
-            results.add(metadata.getStrategy().diff(beforeState, afterState, metadata));
+            DiffResult<Object> diff = metadata.getStrategy().diff(beforeState, afterState, metadata);
+            diff.setProperties(Collections.unmodifiableMap(metadata.getProperties()));
+            results.add(diff);
         }
 
         return results;
@@ -73,7 +76,7 @@ public static <T> List<DiffResult<?>> diff(T beforeState, T afterState, DiffConf
      * @param afterState  objeto com as informações depois da alteração.
      * @return resultado do instance.
      */
-    public static <T> boolean isEquals(T beforeState, T afterState, DiffConfigurationBuilder configuration) {
+    public static <T> boolean isEquals(T beforeState, T afterState, DiffConfiguration configuration) {
         Objects.requireNonNull(beforeState, "Before state is required.");
         Objects.requireNonNull(afterState, "After state is required.");
         Objects.requireNonNull(configuration, "Configuration is required.");

src/main/java/com/github/jonpereiradev/diffobjects/DiffResult.java

@@ -1,5 +1,7 @@
 package com.github.jonpereiradev.diffobjects;
 
+import java.util.Map;
+
 /**
  * @author jonpereiradev@gmail.com
  */
@@ -8,6 +10,7 @@ public class DiffResult<T> {
     private T before;
     private T after;
     private boolean equals;
+    private Map<String, String> properties;
 
     public DiffResult(T before, T after, boolean equals) {
         this.before = before;
@@ -26,4 +29,12 @@ public T getAfter() {
     public boolean isEquals() {
         return equals;
     }
+
+    public Map<String, String> getProperties() {
+        return properties;
+    }
+
+    public void setProperties(Map<String, String> properties) {
+        this.properties = properties;
+    }
 }

src/main/java/com/github/jonpereiradev/diffobjects/annotation/DiffMapping.java

@@ -21,4 +21,8 @@
      */
     String value() default "";
 
+    /**
+     * Aditional properties that will be on result for identification.
+     */
+    DiffProperty[] properties() default {};
 }

src/main/java/com/github/jonpereiradev/diffobjects/annotation/DiffProperty.java

@@ -0,0 +1,27 @@
+package com.github.jonpereiradev.diffobjects.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Maps a property on a mapping to be used on result.
+ *
+ * @author jonpereiradev@gmail.com
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ElementType.ANNOTATION_TYPE})
+public @interface DiffProperty {
+
+    /**
+     * Identifier of the property.
+     */
+    String key();
+
+    /**
+     * Value of the property.
+     */
+    String value();
+
+}

src/main/java/com/github/jonpereiradev/diffobjects/builder/DiffBuilder.java

@@ -17,9 +17,9 @@
  * @author jonpereiradev@gmail.com
  * @see DiffInstanceBuilder
  * @see DiffMappingBuilder
- * @see DiffConfigurationBuilder
+ * @see DiffConfiguration
  */
-public final class DiffBuilder implements DiffInstanceBuilder, DiffMappingBuilder, DiffConfigurationBuilder {
+public final class DiffBuilder implements DiffInstanceBuilder, DiffMappingBuilder, DiffConfiguration {
 
     private final Class<?> classMap;
     private final List<DiffMetadata> metadatas;
@@ -120,11 +120,31 @@ public DiffMappingBuilder mapping(String field, String value) {
             throw new DiffException("Field \"" + field + "\" already mapped in this builder.");
         }
 
+        diffMetadata.getProperties().put("field", field);
+
         metadatas.add(diffMetadata);
 
         return this;
     }
 
+    /**
+     * Define a property for the last mapping.
+     *
+     * @param key   the identifier of the property.
+     * @param value the value of the property.
+     * @return the instance of this mapping.
+     */
+    @Override
+    public DiffMappingBuilder property(String key, String value) {
+        if (metadatas.isEmpty()) {
+            throw new DiffException("A mapping field is required to associate the property.");
+        }
+
+        metadatas.get(metadatas.size() - 1).getProperties().put(key, value);
+
+        return this;
+    }
+
     /**
      * Returns to the instance instance to allow the fluent interface.
      *
@@ -141,7 +161,7 @@ public DiffInstanceBuilder instance() {
      * @return a configuration instance instance.
      */
     @Override
-    public DiffConfigurationBuilder configuration() {
+    public DiffConfiguration configuration() {
         return this;
     }
 

…ts/builder/DiffConfigurationBuilder.java …ffobjects/builder/DiffConfiguration.javasrc/main/java/com/github/jonpereiradev/diffobjects/builder/DiffConfigurationBuilder.java renamed to src/main/java/com/github/jonpereiradev/diffobjects/builder/DiffConfiguration.java src/main/java/com/github/jonpereiradev/diffobjects/builder/DiffConfigurationBuilder.java renamed to src/main/java/com/github/jonpereiradev/diffobjects/builder/DiffConfiguration.java

@@ -11,7 +11,7 @@
  * @see DiffInstanceBuilder
  * @see DiffMappingBuilder
  */
-public interface DiffConfigurationBuilder {
+public interface DiffConfiguration {
 
     /**
      * Gets the configuration for the instance instance.

src/main/java/com/github/jonpereiradev/diffobjects/builder/DiffInstanceBuilder.java

@@ -6,7 +6,7 @@
  * @author jonpereiradev@gmail.com
  * @see DiffBuilder
  * @see DiffMappingBuilder
- * @see DiffConfigurationBuilder
+ * @see DiffConfiguration
  */
 public interface DiffInstanceBuilder {
 
@@ -22,7 +22,7 @@ public interface DiffInstanceBuilder {
      *
      * @return a configuration instance instance.
      */
-    DiffConfigurationBuilder configuration();
+    DiffConfiguration configuration();
 
 }
 

src/main/java/com/github/jonpereiradev/diffobjects/builder/DiffMappingBuilder.java

@@ -6,7 +6,7 @@
  * @author jonpereiradev@gmail.com
  * @see DiffBuilder
  * @see DiffInstanceBuilder
- * @see DiffConfigurationBuilder
+ * @see DiffConfiguration
  */
 public interface DiffMappingBuilder {
 
@@ -28,7 +28,7 @@ public interface DiffMappingBuilder {
      * Maps the getter of the field for the class.
      *
      * @param field name of the field that will me used to find the getter method.
-     * @return the instance of this mapping instance.
+     * @return the instance of this mapping.
      */
     DiffMappingBuilder mapping(String field);
 
@@ -37,9 +37,17 @@ public interface DiffMappingBuilder {
      *
      * @param field name of the field that will me used to find the getter method.
      * @param value the nested property of the object to make the diff.
-     * @return the instance of this mapping instance.
+     * @return the instance of this mapping.
      */
     DiffMappingBuilder mapping(String field, String value);
 
+    /**
+     * Define a property for the last mapping.
+     *
+     * @param key   the identifier of the property.
+     * @param value the value of the property.
+     * @return the instance of this mapping.
+     */
+    DiffMappingBuilder property(String key, String value);
 }
 

src/main/java/com/github/jonpereiradev/diffobjects/strategy/DiffMetadata.java

@@ -3,6 +3,8 @@
 import org.apache.commons.lang.StringUtils;
 
 import java.lang.reflect.Method;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Objects;
 
 /**
@@ -14,11 +16,13 @@ public final class DiffMetadata implements Comparable<DiffMetadata> {
     private final String value;
     private final Method method;
     private final DiffStrategy strategy;
+    private final Map<String, String> properties;
 
     public DiffMetadata(String value, Method method, DiffStrategyType diffStrategyType) {
         this.value = value == null ? StringUtils.EMPTY : value;
         this.method = method;
         this.strategy = diffStrategyType == null ? DiffStrategyType.SINGLE.getStrategy() : diffStrategyType.getStrategy();
+        this.properties = new HashMap<>();
     }
 
     @Override
@@ -54,4 +58,8 @@ public Method getMethod() {
     public DiffStrategy getStrategy() {
         return strategy;
     }
+
+    public Map<String, String> getProperties() {
+        return properties;
+    }
 }

src/main/java/com/github/jonpereiradev/diffobjects/strategy/DiffReflections.java

@@ -3,8 +3,9 @@
 import com.github.jonpereiradev.diffobjects.DiffException;
 import com.github.jonpereiradev.diffobjects.annotation.DiffMapping;
 import com.github.jonpereiradev.diffobjects.annotation.DiffMappings;
+import com.github.jonpereiradev.diffobjects.annotation.DiffProperty;
 import com.github.jonpereiradev.diffobjects.builder.DiffBuilder;
-import com.github.jonpereiradev.diffobjects.builder.DiffConfigurationBuilder;
+import com.github.jonpereiradev.diffobjects.builder.DiffConfiguration;
 import com.github.jonpereiradev.diffobjects.builder.DiffInstanceBuilder;
 import org.apache.commons.lang.StringUtils;
 import org.apache.commons.lang.reflect.MethodUtils;
@@ -21,25 +22,33 @@
  */
 public final class DiffReflections {
 
-    private static final Map<String, DiffConfigurationBuilder> CACHE_MAP = new ConcurrentHashMap<>();
+    private static final Map<String, DiffConfiguration> CACHE_MAP = new ConcurrentHashMap<>();
 
     /**
      * Map the methods of the object that has the annotations for diff and stores in cache.
      *
      * @param diffClass class that have the diff annotations.
      * @return the diff mappings of the class.
      */
-    public static DiffConfigurationBuilder mapAnnotations(Class<?> diffClass) {
+    public static DiffConfiguration mapAnnotations(Class<?> diffClass) {
         if (!CACHE_MAP.containsKey(diffClass.getName())) {
             DiffInstanceBuilder builder = DiffBuilder.map(diffClass);
 
             for (Method method : diffClass.getMethods()) {
                 if (method.isAnnotationPresent(DiffMapping.class)) {
                     DiffMapping diffMapping = method.getAnnotation(DiffMapping.class);
                     builder.mapper().mapping(method.getName(), diffMapping.value());
+
+                    for (DiffProperty diffProperty : diffMapping.properties()) {
+                        builder.mapper().property(diffProperty.key(), diffProperty.value());
+                    }
                 } else if (method.isAnnotationPresent(DiffMappings.class)) {
                     for (DiffMapping diffMapping : method.getAnnotation(DiffMappings.class).value()) {
                         builder.mapper().mapping(method.getName(), diffMapping.value());
+
+                        for (DiffProperty diffProperty : diffMapping.properties()) {
+                            builder.mapper().property(diffProperty.key(), diffProperty.value());
+                        }
                     }
                 }
             }