Merge "Added tests for yang.model.util"
[yangtools.git] / yang / yang-binding / src / main / java / org / opendaylight / yangtools / yang / binding / util / BindingReflections.java
index 81ef845de6596ee97417a86b84db5c02cb1cc1ee..bc7474a9f2cb765796063f07e8c9cd65dc2b5e96 100644 (file)
@@ -16,10 +16,15 @@ import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.ImmutableSet.Builder;
+import com.google.common.collect.Sets;
+
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.lang.reflect.Type;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
@@ -29,6 +34,7 @@ import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+
 import org.opendaylight.yangtools.yang.binding.Augmentable;
 import org.opendaylight.yangtools.yang.binding.Augmentation;
 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
@@ -63,7 +69,6 @@ public class BindingReflections {
     }
 
     /**
-     *
      * Find augmentation target class from concrete Augmentation class
      *
      * This method uses first generic argument of
@@ -395,6 +400,27 @@ public class BindingReflections {
         return ret;
     }
 
+    /**
+    *
+    * Scans supplied class and returns an iterable of all data children classes.
+    *
+    * @param type YANG Modeled Entity derived from DataContainer
+    * @return Iterable of all data children, which have YANG modeled entity
+    */
+   @SuppressWarnings("unchecked")
+   public static Map<Class<?>,Method> getChildrenClassToMethod(final Class<?> type) {
+       checkArgument(type != null, "Target type must not be null");
+       checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer");
+       Map<Class<?>,Method> ret = new HashMap<>();
+       for (Method method : type.getMethods()) {
+           Optional<Class<? extends DataContainer>> entity = getYangModeledReturnType(method);
+           if (entity.isPresent()) {
+               ret.put(entity.get(),method);
+           }
+       }
+       return ret;
+   }
+
     @SuppressWarnings("unchecked")
     private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method) {
         if (method.getName().equals("getClass") || !method.getName().startsWith("get")
@@ -533,6 +559,14 @@ public class BindingReflections {
         }
     }
 
+    /**
+     * Given a {@link YangModuleInfo}, create a QName representing it. The QName
+     * is formed by reusing the module's namespace and revision using the module's
+     * name as the QName's local name.
+     *
+     * @param moduleInfo module information
+     * @return QName representing the module
+     */
     public static QName getModuleQName(final YangModuleInfo moduleInfo) {
         checkArgument(moduleInfo != null, "moduleInfo must not be null.");
         return QName.create(moduleInfo.getNamespace(), moduleInfo.getRevision(),
@@ -540,17 +574,61 @@ public class BindingReflections {
     }
 
     /**
-    *
-    * Extracts augmentation from Binding DTO field using reflection
-    *
-    * @param input Instance of DataObject which is augmentable and
-    *      may contain augmentation
-    * @return Map of augmentations if read was successful, otherwise
-    *      empty map.
-    */
-   public static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Augmentable<?> input) {
-       return AugmentationFieldGetter.getGetter(input.getClass()).getAugmentations(input);
-   }
-
+     * Extracts augmentation from Binding DTO field using reflection
+     *
+     * @param input Instance of DataObject which is augmentable and
+     *      may contain augmentation
+     * @return Map of augmentations if read was successful, otherwise
+     *      empty map.
+     */
+    public static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Augmentable<?> input) {
+        return AugmentationFieldGetter.getGetter(input.getClass()).getAugmentations(input);
+    }
 
+    /**
+     *
+     * Determines if two augmentation classes or case classes represents same data.
+     * <p>
+     * Two augmentations or cases could be substituted only if and if:
+     * <ul>
+     * <li>Both implements same interfaces</li>
+     * <li>Both have same children</li>
+     * <li>If augmentations: Both have same augmentation target class. Target class was generated for data node in grouping.</li>
+     * <li>If cases: Both are from same choice. Choice class was generated for data node in grouping.</li>
+     * </ul>
+     * <p>
+     * <b>Explanation:</b> Binding Specification reuses classes generated for groupings as part of normal data tree,
+     * this classes from grouping could be used at various locations and user may not be aware of it
+     * and may use incorrect case or augmentation in particular subtree (via copy constructors, etc).
+     *
+     * @param potential Class which is potential substition
+     * @param target Class which should be used at particular subtree
+     * @return true if and only if classes represents same data.
+     */
+    @SuppressWarnings({"rawtypes","unchecked"})
+    public static boolean isSubstitutionFor(Class potential, Class target) {
+        HashSet<Class> subImplemented = Sets.newHashSet(potential.getInterfaces());
+        HashSet<Class> targetImplemented = Sets.newHashSet(target.getInterfaces());
+        if(!subImplemented.equals(targetImplemented)) {
+            return false;
+        }
+        if(Augmentation.class.isAssignableFrom(potential)
+                && !BindingReflections.findAugmentationTarget(potential).equals(BindingReflections.findAugmentationTarget(target))) {
+                return false;
+        }
+        for(Method potentialMethod : potential.getMethods()) {
+            try {
+                Method targetMethod = target.getMethod(potentialMethod.getName(), potentialMethod.getParameterTypes());
+                if(!potentialMethod.getReturnType().equals(targetMethod.getReturnType())) {
+                    return false;
+                }
+            } catch (NoSuchMethodException e) {
+                // Counterpart method is missing, so classes could not be substituted.
+                return false;
+            } catch (SecurityException e) {
+                throw new IllegalStateException("Could not compare methods",e);
+            }
+        }
+        return true;
+    }
 }