PLANNER-352 Prepare for field annotations: refactor PropertyAccessor …

…to extend AnnotatedElement

optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/common/PropertyAccessor.java

@@ -16,17 +16,23 @@
 
 package org.optaplanner.core.impl.domain.common;
 
+import java.lang.annotation.Annotation;
+import java.lang.reflect.AnnotatedElement;
+import java.lang.reflect.Field;
 import java.lang.reflect.Method;
+import java.lang.reflect.Type;
 
-public interface PropertyAccessor {
+public interface PropertyAccessor extends AnnotatedElement {
 
     String getName();
 
-    Class<?> getPropertyType();
+    Class<?> getType();
 
-    Method getReadMethod();
-
-    Method getWriteMethod();
+    /**
+     * As defined by {@link Method#getGenericReturnType()} and {@link Field#getGenericType()}.
+     * @return never null
+     */
+    Type getGenericType();
 
     Object executeGetter(Object bean);
 

optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/common/ReflectionPropertyAccessor.java

@@ -17,8 +17,10 @@
 package org.optaplanner.core.impl.domain.common;
 
 import java.beans.PropertyDescriptor;
+import java.lang.annotation.Annotation;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.lang.reflect.Type;
 
 /**
  * Wraps {@link PropertyDescriptor} for faster and easier access.
@@ -32,31 +34,31 @@ public final class ReflectionPropertyAccessor implements PropertyAccessor {
     public ReflectionPropertyAccessor(PropertyDescriptor propertyDescriptor) {
         this.propertyDescriptor = propertyDescriptor;
         readMethod = propertyDescriptor.getReadMethod();
-        if (readMethod != null) {
-            readMethod.setAccessible(true); // Performance hack by avoiding security checks
+        if (readMethod == null) {
+            throw new IllegalStateException("The propertyDescriptor (" + propertyDescriptor
+                    + ") lacks a readMethod (" + readMethod + ").");
         }
+        readMethod.setAccessible(true); // Performance hack by avoiding security checks
         writeMethod = propertyDescriptor.getWriteMethod();
         if (writeMethod != null) {
             writeMethod.setAccessible(true); // Performance hack by avoiding security checks
         }
     }
 
-    public Method getReadMethod() {
-        return readMethod;
-    }
-
-    public Method getWriteMethod() {
-        return writeMethod;
-    }
-
     public String getName() {
         return propertyDescriptor.getName();
     }
 
-    public Class<?> getPropertyType() {
+    @Override
+    public Class<?> getType() {
         return propertyDescriptor.getPropertyType();
     }
 
+    @Override
+    public Type getGenericType() {
+        return readMethod.getGenericReturnType();
+    }
+
     public Object executeGetter(Object bean) {
         try {
             return readMethod.invoke(bean);
@@ -83,4 +85,28 @@ public void executeSetter(Object bean, Object value) {
         }
     }
 
+    // ************************************************************************
+    // AnnotatedElement methods
+    // ************************************************************************
+
+    @Override
+    public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {
+        return readMethod.isAnnotationPresent(annotationClass);
+    }
+
+    @Override
+    public <T extends Annotation> T getAnnotation(Class<T> annotationClass) {
+        return readMethod.getAnnotation(annotationClass);
+    }
+
+    @Override
+    public Annotation[] getAnnotations() {
+        return readMethod.getAnnotations();
+    }
+
+    @Override
+    public Annotation[] getDeclaredAnnotations() {
+        return readMethod.getDeclaredAnnotations();
+    }
+
 }

optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/solution/descriptor/SolutionDescriptor.java

@@ -61,7 +61,6 @@ public class SolutionDescriptor {
     private final BeanInfo solutionBeanInfo;
     private SolutionCloner solutionCloner;
 
-    private final Map<String, PropertyAccessor> propertyAccessorMap;
     private final Map<String, PropertyAccessor> entityPropertyAccessorMap;
     private final Map<String, PropertyAccessor> entityCollectionPropertyAccessorMap;
 
@@ -77,7 +76,6 @@ public SolutionDescriptor(Class<? extends Solution> solutionClass) {
             throw new IllegalStateException("The solutionClass (" + solutionClass + ") is not a valid java bean.", e);
         }
         int mapSize = solutionBeanInfo.getPropertyDescriptors().length;
-        propertyAccessorMap = new LinkedHashMap<String, PropertyAccessor>(mapSize);
         entityPropertyAccessorMap = new LinkedHashMap<String, PropertyAccessor>(mapSize);
         entityCollectionPropertyAccessorMap = new LinkedHashMap<String, PropertyAccessor>(mapSize);
         entityDescriptorMap = new LinkedHashMap<Class<?>, EntityDescriptor>(mapSize);
@@ -143,16 +141,14 @@ private void processMethodAnnotations(DescriptorPolicy descriptorPolicy) {
     private void processPropertyAnnotations(DescriptorPolicy descriptorPolicy) {
         boolean noPlanningEntityPropertyAnnotation = true;
         for (PropertyDescriptor propertyDescriptor : solutionBeanInfo.getPropertyDescriptors()) {
-            PropertyAccessor propertyAccessor = new ReflectionPropertyAccessor(propertyDescriptor);
-            propertyAccessorMap.put(propertyAccessor.getName(), propertyAccessor);
-            Method propertyGetter = propertyAccessor.getReadMethod();
-            if (propertyGetter != null) {
-                if (propertyGetter.isAnnotationPresent(PlanningEntityProperty.class)) {
+            if (propertyDescriptor.getReadMethod() != null) {
+                PropertyAccessor propertyAccessor = new ReflectionPropertyAccessor(propertyDescriptor);
+                if (propertyAccessor.isAnnotationPresent(PlanningEntityProperty.class)) {
                     noPlanningEntityPropertyAnnotation = false;
                     entityPropertyAccessorMap.put(propertyAccessor.getName(), propertyAccessor);
-                } else if (propertyGetter.isAnnotationPresent(PlanningEntityCollectionProperty.class)) {
+                } else if (propertyAccessor.isAnnotationPresent(PlanningEntityCollectionProperty.class)) {
                     noPlanningEntityPropertyAnnotation = false;
-                    if (!Collection.class.isAssignableFrom(propertyAccessor.getPropertyType())) {
+                    if (!Collection.class.isAssignableFrom(propertyAccessor.getType())) {
                         throw new IllegalStateException("The solutionClass (" + solutionClass
                                 + ") has a PlanningEntityCollection annotated property ("
                                 + propertyAccessor.getName() + ") that does not return a Collection.");
@@ -220,10 +216,6 @@ public Map<String, PropertyAccessor> getEntityCollectionPropertyAccessorMap() {
     // Model methods
     // ************************************************************************
 
-    public PropertyAccessor getPropertyAccessor(String propertyName) {
-        return propertyAccessorMap.get(propertyName);
-    }
-
     public Set<Class<?>> getEntityClassSet() {
         return entityDescriptorMap.keySet();
     }
@@ -387,7 +379,7 @@ public List<Object> getEntityList(Solution solution) {
     public List<Object> getEntityListByEntityClass(Solution solution, Class<?> entityClass) {
         List<Object> entityList = new ArrayList<Object>();
         for (PropertyAccessor entityPropertyAccessor : entityPropertyAccessorMap.values()) {
-            if (entityPropertyAccessor.getPropertyType().isAssignableFrom(entityClass)) {
+            if (entityPropertyAccessor.getType().isAssignableFrom(entityClass)) {
                 Object entity = extractEntity(entityPropertyAccessor, solution);
                 if (entity != null && entityClass.isInstance(entity)) {
                     entityList.add(entity);

optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/variable/anchor/AnchorShadowVariableDescriptor.java

@@ -48,8 +48,7 @@ private void processPropertyAnnotations(DescriptorPolicy descriptorPolicy) {
     }
 
     public void linkShadowSources(DescriptorPolicy descriptorPolicy) {
-        AnchorShadowVariable shadowVariableAnnotation = variablePropertyAccessor.getReadMethod()
-                .getAnnotation(AnchorShadowVariable.class);
+        AnchorShadowVariable shadowVariableAnnotation = variablePropertyAccessor.getAnnotation(AnchorShadowVariable.class);
         String sourceVariableName = shadowVariableAnnotation.sourceVariableName();
         sourceVariableDescriptor = entityDescriptor.getVariableDescriptor(sourceVariableName);
         if (sourceVariableDescriptor == null) {

optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/variable/custom/CustomShadowVariableDescriptor.java

@@ -48,7 +48,7 @@ public void processAnnotations(DescriptorPolicy descriptorPolicy) {
     }
 
     private void processPropertyAnnotations(DescriptorPolicy descriptorPolicy) {
-        CustomShadowVariable shadowVariableAnnotation = variablePropertyAccessor.getReadMethod()
+        CustomShadowVariable shadowVariableAnnotation = variablePropertyAccessor
                 .getAnnotation(CustomShadowVariable.class);
         variableListenerClass = shadowVariableAnnotation.variableListenerClass();
         CustomShadowVariable.Source[] sources = shadowVariableAnnotation.sources();
@@ -62,7 +62,7 @@ private void processPropertyAnnotations(DescriptorPolicy descriptorPolicy) {
     }
 
     public void linkShadowSources(DescriptorPolicy descriptorPolicy) {
-        CustomShadowVariable shadowVariableAnnotation = variablePropertyAccessor.getReadMethod()
+        CustomShadowVariable shadowVariableAnnotation = variablePropertyAccessor
                 .getAnnotation(CustomShadowVariable.class);
         SolutionDescriptor solutionDescriptor = entityDescriptor.getSolutionDescriptor();
         CustomShadowVariable.Source[] sources = shadowVariableAnnotation.sources();

optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/variable/descriptor/GenuineVariableDescriptor.java

@@ -24,8 +24,6 @@
 import java.util.List;
 
 import org.apache.commons.lang3.ArrayUtils;
-import org.optaplanner.core.api.domain.entity.PlanningEntity;
-import org.optaplanner.core.api.domain.solution.PlanningSolution;
 import org.optaplanner.core.api.domain.solution.Solution;
 import org.optaplanner.core.api.domain.valuerange.CountableValueRange;
 import org.optaplanner.core.api.domain.valuerange.ValueRangeProvider;
@@ -34,7 +32,6 @@
 import org.optaplanner.core.config.heuristic.selector.common.decorator.SelectionSorterOrder;
 import org.optaplanner.core.config.util.ConfigUtils;
 import org.optaplanner.core.impl.domain.common.PropertyAccessor;
-import org.optaplanner.core.impl.domain.common.ReflectionPropertyAccessor;
 import org.optaplanner.core.impl.domain.entity.descriptor.EntityDescriptor;
 import org.optaplanner.core.impl.domain.policy.DescriptorPolicy;
 import org.optaplanner.core.impl.domain.valuerange.descriptor.CompositeValueRangeDescriptor;
@@ -69,8 +66,7 @@ public void processAnnotations(DescriptorPolicy descriptorPolicy) {
     }
 
     private void processPropertyAnnotations(DescriptorPolicy descriptorPolicy) {
-        PlanningVariable planningVariableAnnotation = variablePropertyAccessor.getReadMethod()
-                .getAnnotation(PlanningVariable.class);
+        PlanningVariable planningVariableAnnotation = variablePropertyAccessor.getAnnotation(PlanningVariable.class);
         processNullable(descriptorPolicy, planningVariableAnnotation);
         processChained(descriptorPolicy, planningVariableAnnotation);
         processValueRangeRefs(descriptorPolicy, planningVariableAnnotation);
@@ -79,11 +75,11 @@ private void processPropertyAnnotations(DescriptorPolicy descriptorPolicy) {
 
     private void processNullable(DescriptorPolicy descriptorPolicy, PlanningVariable planningVariableAnnotation) {
         nullable = planningVariableAnnotation.nullable();
-        if (nullable && variablePropertyAccessor.getPropertyType().isPrimitive()) {
+        if (nullable && variablePropertyAccessor.getType().isPrimitive()) {
             throw new IllegalArgumentException("The entityClass (" + entityDescriptor.getEntityClass()
                     + ") has a PlanningVariable annotated property (" + variablePropertyAccessor.getName()
                     + ") with nullable (" + nullable + "), which is not compatible with the primitive propertyType ("
-                    + variablePropertyAccessor.getPropertyType() + ").");
+                    + variablePropertyAccessor.getType() + ").");
         }
         Class<? extends SelectionFilter> reinitializeVariableEntityFilterClass
                 = planningVariableAnnotation.reinitializeVariableEntityFilter();
@@ -100,11 +96,11 @@ private void processNullable(DescriptorPolicy descriptorPolicy, PlanningVariable
 
     private void processChained(DescriptorPolicy descriptorPolicy, PlanningVariable planningVariableAnnotation) {
         chained = planningVariableAnnotation.graphType() == PlanningVariableGraphType.CHAINED;
-        if (chained && !variablePropertyAccessor.getPropertyType().isAssignableFrom(
+        if (chained && !variablePropertyAccessor.getType().isAssignableFrom(
                 entityDescriptor.getEntityClass())) {
             throw new IllegalArgumentException("The entityClass (" + entityDescriptor.getEntityClass()
                     + ") has a PlanningVariable annotated property (" + variablePropertyAccessor.getName()
-                    + ") with chained (" + chained + ") and propertyType (" + variablePropertyAccessor.getPropertyType()
+                    + ") with chained (" + chained + ") and propertyType (" + variablePropertyAccessor.getType()
                     + ") which is not a superclass/interface of or the same as the entityClass ("
                     + entityDescriptor.getEntityClass() + ").");
         }

optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/variable/descriptor/VariableDescriptor.java

@@ -20,7 +20,6 @@
 import java.util.List;
 
 import org.optaplanner.core.impl.domain.common.PropertyAccessor;
-import org.optaplanner.core.impl.domain.common.ReflectionPropertyAccessor;
 import org.optaplanner.core.impl.domain.entity.descriptor.EntityDescriptor;
 
 public abstract class VariableDescriptor {
@@ -55,7 +54,7 @@ public String getSimpleEntityAndVariableName() {
     }
 
     public Class<?> getVariablePropertyType() {
-        return variablePropertyAccessor.getPropertyType();
+        return variablePropertyAccessor.getType();
     }
 
     // ************************************************************************

optaplanner-core/src/main/java/org/optaplanner/core/impl/domain/variable/inverserelation/InverseRelationShadowVariableDescriptor.java

@@ -51,12 +51,12 @@ private void processPropertyAnnotations(DescriptorPolicy descriptorPolicy) {
     }
 
     public void linkShadowSources(DescriptorPolicy descriptorPolicy) {
-        InverseRelationShadowVariable shadowVariableAnnotation = variablePropertyAccessor.getReadMethod()
+        InverseRelationShadowVariable shadowVariableAnnotation = variablePropertyAccessor
                 .getAnnotation(InverseRelationShadowVariable.class);
         Class<?> variablePropertyType = getVariablePropertyType();
         Class<?> masterClass;
         if (Collection.class.isAssignableFrom(variablePropertyType)) {
-            Type genericType = variablePropertyAccessor.getReadMethod().getGenericReturnType();
+            Type genericType = variablePropertyAccessor.getGenericType();
             if (!(genericType instanceof ParameterizedType)) {
                 throw new IllegalArgumentException("The entityClass (" + entityDescriptor.getEntityClass()
                         + ") has a " + InverseRelationShadowVariable.class.getSimpleName()