updated coding rules.
[utils] / system / general / src / main / java / org / wamblee / system / adapters / SetterConfiguration.java
index 581c5b5913e7513fd5c7d59e37ceeb5c1b1c2429..77fd9720b4c66c9ac69a12bce27862a1458e5d41 100644 (file)
@@ -21,12 +21,16 @@ import java.lang.reflect.Method;
 import java.lang.reflect.Modifier;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
+import java.util.Set;
 
 import org.wamblee.collections.CollectionFilter;
 import org.wamblee.conditions.Condition;
 import org.wamblee.conditions.FixedCondition;
 import org.wamblee.general.Pair;
+import org.wamblee.reflection.ReflectionUtils;
 import org.wamblee.system.core.DefaultProvidedInterface;
 import org.wamblee.system.core.DefaultRequiredInterface;
 import org.wamblee.system.core.ProvidedInterface;
@@ -43,32 +47,43 @@ import org.wamblee.system.core.SystemAssemblyException;
 public class SetterConfiguration {
 
        private Class _class;
-       private boolean _publicOnly;
+       private boolean publicOnly;
 
-       private List<Pair<Method, ParameterValues>> _setters;
+       private Map<Method, ParameterValues> setters;
 
        /**
-        * Constructs the setter configuration. By default all setters are added.
+        * Constructs the setter configuration. By default no setters are added. 
         * 
         * @param aClass
         *            Class which is being configured.
         */
        public SetterConfiguration(Class aClass) {
                _class = aClass;
-               _publicOnly = true;
-               _setters = getAllSetters(_class, _publicOnly);
+               publicOnly = true;
+               setters = new HashMap<Method, ParameterValues>();
+       }
+
+       /**
+        * Makes sure that all available setters are used. 
+        */
+       public SetterConfiguration initAllSetters() {
+           setters.clear();
+               for (Method method: getAllSetters(_class, publicOnly) ) { 
+                       setters.put(method, createParameterValues(method));
+               }
+               return this; 
        }
 
        /**
         * Called to set whether non-public setters are also used. By default only
-        * public setters are used.
+        * public setters are used. The currently selected setters remain chosen.  
         * 
         * @param aIsNonPublic
         *            Non public flag.
         */
-       public void setNonPublic(boolean aIsNonPublic) {
-               _publicOnly = !aIsNonPublic;
-               _setters = getAllSetters(_class, _publicOnly);
+       public SetterConfiguration setNonPublic(boolean aIsNonPublic) {
+               publicOnly = !aIsNonPublic;
+               return this; 
        }
 
        /**
@@ -77,7 +92,7 @@ public class SetterConfiguration {
         * @return Reference to the current object to allow call chaining.
         */
        public SetterConfiguration clear() {
-               _setters.clear();
+               setters.clear();
                return this;
        }
 
@@ -85,61 +100,106 @@ public class SetterConfiguration {
         * Removes a setter from the set of methods.
         * 
         * @param aName
-        *            Name of the setter to remove (without the "set" prefix).
+        *            Name of the setter to remove.
         * @return Reference to the current object to allow call chaining.
         */
        public SetterConfiguration remove(String aName) {
-               final String name = createSetterName(aName);
-               List<Pair<Method, ParameterValues>> setters = new ArrayList<Pair<Method, ParameterValues>>();
-               CollectionFilter.filter(_setters, setters,
-                               new Condition<Pair<Method, ParameterValues>>() {
+               for (Method method : setters.keySet()) {
+                       if (method.getName().equals(aName)) {
+                               setters.remove(method);
+                               return this;
+                       }
+               }
+               throw new IllegalArgumentException(
+                               "No method configured by the name of '" + aName + "'");
+       }
+       
+       /**
+        * Removes the method from the set of methods. 
+        * @param aMethod Method to remove. 
+        * @return
+        */
+       public SetterConfiguration remove(Method aMethod) { 
+           if ( !aMethod.getDeclaringClass().isAssignableFrom(_class) ) { 
+               throw new RuntimeException("Method " + aMethod + " not found in class " + _class + " or its superclasses");
+           }
+           for (Method method : setters.keySet()) {
+            if (method.equals(aMethod)) {
+                setters.remove(method);
+                return this;
+            }
+        }
+        throw new IllegalArgumentException(
+                "Method '" + aMethod + "' was not configured. ");
+       }
+       
+       /**
+        * Adds a given setter name to the setters.
+        * 
+        * @param aName Name of a setter method.
+        * @return Reference to the current object to allow call chaining.
+        */
+       public SetterConfiguration add(final String aName) {
+               int oldlen = setters.size();
+               List<Method> methods = new ArrayList<Method>();
+               CollectionFilter.filter(getAllSetters(_class, publicOnly), methods,
+                               new Condition<Method>() {
                                        @Override
-                                       public boolean matches(Pair<Method, ParameterValues> aObject) {
-                                               return !aObject.getFirst().getName().equals(name);
+                                       public boolean matches(Method aObject) {
+                                               return aObject.getName().equals(aName);
                                        }
 
                                });
-               if (_setters.size() == setters.size()) {
-                       throw new IllegalArgumentException(
-                                       "No setter configured by the name of '" + aName + "'");
+               if (methods.size() == 0 ) {
+                       throw new IllegalArgumentException("Method '" + aName
+                                       + "' not found in " + _class.getName());
                }
-               _setters = setters;
+               // TODO is it possible to get more than one setter here in case the subclass overrides
+               // the baseclass method? 
+               setters.put(methods.get(0), createParameterValues(methods.get(0)));
                return this;
        }
 
        /**
-        * Creates the name of a setter based on the name of the setter without the
-        * "set" prefix.
+        * Adds a given setter identified by the type it accepts to the list of
+        * setters.N
         * 
-        * @param aName
-        *            Setter name.
-        * @return Setter name.
-        */
-       private String createSetterName(String aName) {
-               return "set" + aName.substring(0, 1).toUpperCase() + aName.substring(1);
-       }
-
-       /**
-        * Adds a given setter name to the setters.
-        * 
-        * @param aName
+        * @param aType
+        *            Type to look for. Note that this must be the exact type as
+        *            autoboxing and autounboxing is not used.
         * @return Reference to the current object to allow call chaining.
+        * @throws IllegalArgumentException
+        *             In case no setter is found or multiple setters are found.
         */
-       public SetterConfiguration add(String aName) {
-               final String name = createSetterName(aName);
-               int oldlen = _setters.size();
-               CollectionFilter.filter(getAllSetters(_class, false), _setters,
-                               new Condition<Pair<Method, ParameterValues>>() {
+       public SetterConfiguration addSetter(final Class aType) {
+               List<Method> result = new ArrayList<Method>();
+               CollectionFilter.filter(getAllSetters(_class, publicOnly), result,
+                               new Condition<Method>() {
                                        @Override
-                                       public boolean matches(Pair<Method, ParameterValues> aObject) {
-                                               return aObject.getFirst().getName().equals(name);
+                                       public boolean matches(Method aObject) {
+                                               Class type = aObject.getParameterTypes()[0];
+                                               return type.equals(aType);
                                        }
 
                                });
-               if (_setters.size() == oldlen) {
-                       throw new IllegalArgumentException("No setter found for '" + aName
-                                       + "' in " + _class.getName());
+               if (result.size() == 0) {
+                       throw new IllegalArgumentException("No setter found in class '"
+                                       + _class.getName()
+                                       + "' that has a setter with argument type '"
+                                       + aType.getName() + "'");
                }
+               if (result.size() > 1) {
+                       String setters = "";
+                       for (Method method : result) {
+                               setters += method.getName() + " ";
+                       }
+                       throw new IllegalArgumentException(
+                                       "Multiple setters found in class '" + _class.getName()
+                                                       + " that accept type '" + aType.getName() + "': "
+                                                       + setters);
+               }
+               Method method = result.get(0);
+               setters.put(method, createParameterValues(method));
                return this;
        }
 
@@ -148,35 +208,34 @@ public class SetterConfiguration {
         * 
         * @return List of all setters.
         */
-       private static List<Pair<Method, ParameterValues>> getAllSetters(
-                       Class aClass, boolean aPublicOnly) {
-               List<Pair<Method, ParameterValues>> result = new ArrayList<Pair<Method, ParameterValues>>();
+       public static List<Method> getAllSetters(Class aClass,
+                       boolean aPublicOnly) {
+               List<Method> result = new ArrayList<Method>();
                for (Method method : getAllMethods(aClass)) {
                        if (!aPublicOnly || Modifier.isPublic(method.getModifiers())) {
                                if (method.getName().startsWith("set")
                                                && method.getParameterTypes().length == 1) {
                                        method.setAccessible(true);
-                                       String name = getSetterName(method);
-                                       result
-                                                       .add(new Pair<Method, ParameterValues>(method,
-                                                                       new ParameterValues(new String[] { name },
-                                                                                       new Class[] { method
-                                                                                                       .getParameterTypes()[0] })));
+                                       result.add(method);
                                }
                        }
                }
                return result;
        }
 
+       private static ParameterValues createParameterValues(Method aMethod) {
+           
+           Class[] paramTypes = aMethod.getParameterTypes();
+           String[] paramNames = new String[paramTypes.length];
+           for (int i = 0; i < paramTypes.length; i++) { 
+               paramNames[i] = aMethod.getName() + "." + i; 
+           } 
+               return new ParameterValues(paramNames, paramTypes);
+       }
+
        private static final List<Method> getAllMethods(Class aClass) {
-       List<Method> result = new ArrayList<Method>();
-       result.addAll(Arrays.asList(aClass.getDeclaredMethods()));
-       Class superClass = aClass.getSuperclass();
-       if ( superClass != null ) { 
-               result.addAll(getAllMethods(superClass));
-       }
-       return result; 
-    }
+               return ReflectionUtils.getAllMethods(aClass);
+       }
 
        /**
         * Gets the required interfaces based on the configured setteres.
@@ -185,8 +244,8 @@ public class SetterConfiguration {
         */
        public List<RequiredInterface> getRequiredInterfaces() {
                List<RequiredInterface> result = new ArrayList<RequiredInterface>();
-               for (Pair<Method, ParameterValues> method : _setters) {
-                       result.addAll(method.getSecond().getRequiredInterfaces());
+               for (Method method : setters.keySet()) {
+                       result.addAll(setters.get(method).getRequiredInterfaces());
                }
                return result;
        }
@@ -204,9 +263,8 @@ public class SetterConfiguration {
                        throw new IllegalArgumentException("Object '" + aObject
                                        + "' is not an instance of " + _class.getName());
                }
-               for (Pair<Method, ParameterValues> setter : _setters) {
-                       Method method = setter.getFirst();
-                       ParameterValues values = setter.getSecond();
+               for (Method method : setters.keySet()) {
+                       ParameterValues values = setters.get(method);
 
                        try {
                                method.invoke(aObject, values.values(aScope));
@@ -230,28 +288,16 @@ public class SetterConfiguration {
         * @return Parameter values.
         */
        public ParameterValues values(String aMethod) {
-               String name = createSetterName(aMethod);
-               for (Pair<Method, ParameterValues> method : _setters) {
-                       if (method.getFirst().getName().equals(name)) {
-                               return method.getSecond();
+               for (Method method : setters.keySet()) {
+                       if (method.getName().equals(aMethod)) {
+                               return setters.get(method);
                        }
                }
-               throw new IllegalArgumentException("No setter method '" + name
+               throw new IllegalArgumentException("No setter method '" + aMethod
                                + "' found");
        }
 
-       /**
-        * Gets the setter name for a given setter method. This is the name of the
-        * setter without the "set" prefix and with the first character converted to
-        * lowercase.
-        * 
-        * @param aMethod
-        *            Method.
-        * @return Setter name.
-        */
-       private static String getSetterName(Method aMethod) {
-               String result = aMethod.getName().substring(3);
-               return result.substring(0, 1).toLowerCase() + result.substring(1);
+       public List<Method> getSetters() { 
+               return new ArrayList<Method>(setters.keySet());
        }
-
 }