yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/util/BindingReflections.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.binding.util;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static com.google.common.base.Preconditions.checkState;
  12 import com.google.common.base.Optional;
  13 import com.google.common.cache.CacheBuilder;
  14 import com.google.common.cache.CacheLoader;
  15 import com.google.common.cache.LoadingCache;
  16 import com.google.common.collect.ImmutableSet;
  17 import com.google.common.collect.ImmutableSet.Builder;
  18 import com.google.common.collect.Sets;
  19 import java.lang.reflect.Field;
  20 import java.lang.reflect.InvocationTargetException;
  21 import java.lang.reflect.Method;
  22 import java.lang.reflect.Type;
  23 import java.util.HashMap;
  24 import java.util.HashSet;
  25 import java.util.LinkedList;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.ServiceLoader;
  29 import java.util.concurrent.Callable;
  30 import java.util.concurrent.Future;
  31 import java.util.concurrent.TimeUnit;
  32 import java.util.regex.Matcher;
  33 import java.util.regex.Pattern;
  34 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  35 import org.opendaylight.yangtools.yang.binding.Augmentable;
  36 import org.opendaylight.yangtools.yang.binding.Augmentation;
  37 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  38 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  39 import org.opendaylight.yangtools.yang.binding.ChildOf;
  40 import org.opendaylight.yangtools.yang.binding.DataContainer;
  41 import org.opendaylight.yangtools.yang.binding.DataObject;
  42 import org.opendaylight.yangtools.yang.binding.Notification;
  43 import org.opendaylight.yangtools.yang.binding.RpcService;
  44 import org.opendaylight.yangtools.yang.binding.YangModelBindingProvider;
  45 import org.opendaylight.yangtools.yang.binding.YangModuleInfo;
  46 import org.opendaylight.yangtools.yang.common.QName;
  47 import org.slf4j.Logger;
  48 import org.slf4j.LoggerFactory;
  49
  50 public class BindingReflections {
  51
  52     private static final long EXPIRATION_TIME = 60;
  53     private static final String ROOT_PACKAGE_PATTERN_STRING = "(org.opendaylight.yang.gen.v1.[a-z0-9_\\.]*\\.rev[0-9][0-9][0-1][0-9][0-3][0-9])";
  54     private static final Pattern ROOT_PACKAGE_PATTERN = Pattern.compile(ROOT_PACKAGE_PATTERN_STRING);
  55     private static final Logger LOG = LoggerFactory.getLogger(BindingReflections.class);
  56
  57     private static final LoadingCache<Class<?>, Optional<QName>> classToQName = CacheBuilder.newBuilder() //
  58             .weakKeys() //
  59             .expireAfterAccess(EXPIRATION_TIME, TimeUnit.SECONDS) //
  60             .build(new ClassToQNameLoader());
  61
  62
  63
  64     private BindingReflections() {
  65         throw new UnsupportedOperationException("Utility class.");
  66     }
  67
  68     /**
  69      * Find augmentation target class from concrete Augmentation class
  70      *
  71      * This method uses first generic argument of
  72      * implemented {@link Augmentation} interface.
  73      *
  74      * @param augmentation
  75      *            {@link Augmentation} subclass for which we want to determine
  76      *            augmentation target.
  77      * @return Augmentation target - class which augmentation provides
  78      *         additional extensions.
  79      */
  80     public static Class<? extends Augmentable<?>> findAugmentationTarget(
  81             final Class<? extends Augmentation<?>> augmentation) {
  82         return ClassLoaderUtils.findFirstGenericArgument(augmentation, Augmentation.class);
  83     }
  84
  85     /**
  86      * Find data hierarchy parent from concrete Data class
  87      *
  88      * This method uses first generic argument of
  89      * implemented {@link ChildOf} interface.
  90      *
  91      * @param childClass
  92      *            child class for which we want to find the parent class.
  93      * @return Parent class, e.g. class of which the childClass is ChildOf.
  94      */
  95     public static Class<?> findHierarchicalParent(final Class<? extends ChildOf<?>> childClass) {
  96         return ClassLoaderUtils.findFirstGenericArgument(childClass, ChildOf.class);
  97     }
  98
  99     /**
 100      * Find data hierarchy parent from concrete Data class
 101      *
 102      * This method is shorthand which gets DataObject class by invoking
 103      * {@link DataObject#getImplementedInterface()} and uses {@link #findHierarchicalParent(Class)}.
 104      *
 105      * @param child
 106      *            Child object for which the parent needs to be located.
 107      * @return Parent class, or null if a parent is not found.
 108      */
 109     public static Class<?> findHierarchicalParent(final DataObject child) {
 110         if (child instanceof ChildOf) {
 111             return ClassLoaderUtils.findFirstGenericArgument(child.getImplementedInterface(), ChildOf.class);
 112         }
 113         return null;
 114     }
 115
 116     /**
 117      * Returns a QName associated to supplied type
 118      *
 119      * @param dataType
 120      * @return QName associated to supplied dataType. If dataType is
 121      *         Augmentation method does not return canonical QName, but QName
 122      *         with correct namespace revision, but virtual local name, since
 123      *         augmentations do not have name.
 124      *
 125      *         May return null if QName is not present.
 126      */
 127     public static final QName findQName(final Class<?> dataType) {
 128         return classToQName.getUnchecked(dataType).orNull();
 129     }
 130
 131     /**
 132      * Checks if method is RPC invocation
 133      *
 134      *
 135      *
 136      * @param possibleMethod Method to check
 137      * @return true if method is RPC invocation, false otherwise.
 138      */
 139     public static boolean isRpcMethod(final Method possibleMethod) {
 140         return possibleMethod != null && RpcService.class.isAssignableFrom(possibleMethod.getDeclaringClass())
 141                 && Future.class.isAssignableFrom(possibleMethod.getReturnType())
 142                 && possibleMethod.getParameterTypes().length <= 1;
 143     }
 144
 145     /**
 146      *
 147      * Extracts Output class for RPC method
 148      *
 149      * @param targetMethod method to scan
 150      * @return Optional.absent() if result type could not be get,
 151      *         or return type is Void.
 152      */
 153     @SuppressWarnings("rawtypes")
 154     public static Optional<Class<?>> resolveRpcOutputClass(final Method targetMethod) {
 155         checkState(isRpcMethod(targetMethod), "Supplied method is not Rpc invocation method");
 156         Type futureType = targetMethod.getGenericReturnType();
 157         Type rpcResultType = ClassLoaderUtils.getFirstGenericParameter(futureType);
 158         Type rpcResultArgument = ClassLoaderUtils.getFirstGenericParameter(rpcResultType);
 159         if (rpcResultArgument instanceof Class && !Void.class.equals(rpcResultArgument)) {
 160             return Optional.<Class<?>> of((Class) rpcResultArgument);
 161         }
 162         return Optional.absent();
 163     }
 164
 165     /**
 166      *
 167      * Extracts input class for RPC method
 168      *
 169      * @param targetMethod method to scan
 170      * @return Optional.absent() if rpc has no input, Rpc input type otherwise.
 171      */
 172     @SuppressWarnings("unchecked")
 173     public static Optional<Class<? extends DataContainer>> resolveRpcInputClass(final Method targetMethod) {
 174         @SuppressWarnings("rawtypes")
 175         Class[] types = targetMethod.getParameterTypes();
 176         if (types.length == 0) {
 177             return Optional.absent();
 178         }
 179         if (types.length == 1) {
 180             return Optional.<Class<? extends DataContainer>> of(types[0]);
 181         }
 182         throw new IllegalArgumentException("Method has 2 or more arguments.");
 183     }
 184
 185     public static QName getQName(final Class<? extends BaseIdentity> context) {
 186         return findQName(context);
 187     }
 188
 189     /**
 190      *
 191      * Checks if class is child of augmentation.
 192      *
 193      *
 194      * @param clazz
 195      * @return
 196      */
 197     public static boolean isAugmentationChild(final Class<?> clazz) {
 198         // FIXME: Current resolver could be still confused when
 199         // child node was added by grouping
 200         checkArgument(clazz != null);
 201
 202         @SuppressWarnings({ "rawtypes", "unchecked" })
 203         Class<?> parent = findHierarchicalParent((Class) clazz);
 204         if (parent == null) {
 205             LOG.debug("Did not find a parent for class {}", clazz);
 206             return false;
 207         }
 208
 209         String clazzModelPackage = getModelRootPackageName(clazz.getPackage());
 210         String parentModelPackage = getModelRootPackageName(parent.getPackage());
 211
 212         return !clazzModelPackage.equals(parentModelPackage);
 213     }
 214
 215     /**
 216      * Returns root package name for suplied package.
 217      *
 218      * @param pkg Package for which find model root package.
 219      * @return Package of model root.
 220      */
 221     public static String getModelRootPackageName(final Package pkg) {
 222         return getModelRootPackageName(pkg.getName());
 223     }
 224
 225     /**
 226      * Returns root package name for supplied package name.
 227      *
 228      * @param name Package for which find model root package.
 229      * @return Package of model root.
 230      */
 231     public static String getModelRootPackageName(final String name) {
 232         checkArgument(name != null, "Package name should not be null.");
 233         checkArgument(name.startsWith(BindingMapping.PACKAGE_PREFIX), "Package name not starting with %s, is: %s",
 234                 BindingMapping.PACKAGE_PREFIX, name);
 235         Matcher match = ROOT_PACKAGE_PATTERN.matcher(name);
 236         checkArgument(match.find(), "Package name '%s' does not match required pattern '%s'", name,
 237                 ROOT_PACKAGE_PATTERN_STRING);
 238         return match.group(0);
 239     }
 240
 241     /**
 242      *
 243      * Returns instance of {@link YangModuleInfo} of declaring model for specific class.
 244      *
 245      * @param cls
 246      * @return Instance of {@link YangModuleInfo} associated with model, from which this class was derived.
 247      * @throws Exception
 248      */
 249     public static YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
 250         checkArgument(cls != null);
 251         String packageName = getModelRootPackageName(cls.getPackage());
 252         final String potentialClassName = getModuleInfoClassName(packageName);
 253         return ClassLoaderUtils.withClassLoader(cls.getClassLoader(), new Callable<YangModuleInfo>() {
 254             @Override
 255             public YangModuleInfo call() throws ClassNotFoundException, IllegalAccessException,
 256                     IllegalArgumentException, InvocationTargetException, NoSuchMethodException, SecurityException {
 257                 Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
 258                 return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null);
 259             }
 260         });
 261     }
 262
 263     public static String getModuleInfoClassName(final String packageName) {
 264         return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
 265     }
 266
 267     /**
 268      *
 269      * Check if supplied class is derived from YANG model.
 270      *
 271      * @param cls Class to check
 272      * @return true if class is derived from YANG model.
 273      */
 274     public static boolean isBindingClass(final Class<?> cls) {
 275         if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
 276             return true;
 277         }
 278         return (cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX));
 279     }
 280
 281     /**
 282      *
 283      * Checks if supplied method is callback for notifications.
 284      *
 285      * @param method
 286      * @return true if method is notification callback.
 287      */
 288     public static boolean isNotificationCallback(final Method method) {
 289         checkArgument(method != null);
 290         if (method.getName().startsWith("on") && method.getParameterTypes().length == 1) {
 291             Class<?> potentialNotification = method.getParameterTypes()[0];
 292             if (isNotification(potentialNotification)
 293                     && method.getName().equals("on" + potentialNotification.getSimpleName())) {
 294                 return true;
 295             }
 296         }
 297         return false;
 298     }
 299
 300     /**
 301      *
 302      * Checks is supplied class is Notification.
 303      *
 304      * @param potentialNotification
 305      * @return
 306      */
 307     public static boolean isNotification(final Class<?> potentialNotification) {
 308         checkArgument(potentialNotification != null,"potentialNotification must not be null.");
 309         return Notification.class.isAssignableFrom(potentialNotification);
 310     }
 311
 312     /**
 313      *
 314      * Loads {@link YangModuleInfo} infos available on current classloader.
 315      *
 316      * This method is shorthand for {@link #loadModuleInfos(ClassLoader)} with
 317      * {@link Thread#getContextClassLoader()} for current thread.
 318      *
 319      * @return Set of {@link YangModuleInfo} available for current classloader.
 320      */
 321     public static ImmutableSet<YangModuleInfo> loadModuleInfos() {
 322         return loadModuleInfos(Thread.currentThread().getContextClassLoader());
 323     }
 324
 325     /**
 326     *
 327     * Loads {@link YangModuleInfo} infos available on supplied classloader.
 328     *
 329     * {@link YangModuleInfo} are discovered using {@link ServiceLoader}
 330     * for {@link YangModelBindingProvider}. {@link YangModelBindingProvider}
 331     * are simple classes which holds only pointers to actual instance
 332     * {@link YangModuleInfo}.
 333     *
 334     * When {@link YangModuleInfo} is available, all dependencies are recursivelly collected
 335     * into returning set by collecting results of {@link YangModuleInfo#getImportedModules()}.
 336     *
 337     *
 338     * @param loader Classloader for which {@link YangModuleInfo} should be retrieved.
 339     * @return Set of {@link YangModuleInfo} available for supplied classloader.
 340     */
 341     public static ImmutableSet<YangModuleInfo> loadModuleInfos(final ClassLoader loader) {
 342         Builder<YangModuleInfo> moduleInfoSet = ImmutableSet.<YangModuleInfo> builder();
 343         ServiceLoader<YangModelBindingProvider> serviceLoader = ServiceLoader.load(YangModelBindingProvider.class,
 344                 loader);
 345         for (YangModelBindingProvider bindingProvider : serviceLoader) {
 346             YangModuleInfo moduleInfo = bindingProvider.getModuleInfo();
 347             checkState(moduleInfo != null, "Module Info for %s is not available.", bindingProvider.getClass());
 348             collectYangModuleInfo(bindingProvider.getModuleInfo(), moduleInfoSet);
 349         }
 350         return moduleInfoSet.build();
 351     }
 352
 353     private static void collectYangModuleInfo(final YangModuleInfo moduleInfo,
 354             final Builder<YangModuleInfo> moduleInfoSet) {
 355         moduleInfoSet.add(moduleInfo);
 356         for (YangModuleInfo dependency : moduleInfo.getImportedModules()) {
 357             collectYangModuleInfo(dependency, moduleInfoSet);
 358         }
 359     }
 360
 361     /**
 362      *
 363      * Checks if supplied class represents RPC Input / RPC Output.
 364      *
 365      * @param targetType Class to be checked
 366      * @return true if class represents RPC Input or RPC Output class.
 367      */
 368     public static boolean isRpcType(final Class<? extends DataObject> targetType) {
 369         return DataContainer.class.isAssignableFrom(targetType) //
 370                 && !ChildOf.class.isAssignableFrom(targetType) //
 371                 && !Notification.class.isAssignableFrom(targetType) //
 372                 && (targetType.getName().endsWith("Input") || targetType.getName().endsWith("Output"));
 373     }
 374
 375     /**
 376      *
 377      * Scans supplied class and returns an iterable of all data children classes.
 378      *
 379      * @param type YANG Modeled Entity derived from DataContainer
 380      * @return Iterable of all data children, which have YANG modeled entity
 381      */
 382     @SuppressWarnings("unchecked")
 383     public static Iterable<Class<? extends DataObject>> getChildrenClasses(final Class<? extends DataContainer> type) {
 384         checkArgument(type != null, "Target type must not be null");
 385         checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer");
 386         List<Class<? extends DataObject>> ret = new LinkedList<>();
 387         for (Method method : type.getMethods()) {
 388             Optional<Class<? extends DataContainer>> entity = getYangModeledReturnType(method);
 389             if (entity.isPresent()) {
 390                 ret.add((Class<? extends DataObject>) entity.get());
 391             }
 392         }
 393         return ret;
 394     }
 395
 396     /**
 397     *
 398     * Scans supplied class and returns an iterable of all data children classes.
 399     *
 400     * @param type YANG Modeled Entity derived from DataContainer
 401     * @return Iterable of all data children, which have YANG modeled entity
 402     */
 403    public static Map<Class<?>,Method> getChildrenClassToMethod(final Class<?> type) {
 404        checkArgument(type != null, "Target type must not be null");
 405        checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer");
 406        Map<Class<?>,Method> ret = new HashMap<>();
 407        for (Method method : type.getMethods()) {
 408            Optional<Class<? extends DataContainer>> entity = getYangModeledReturnType(method);
 409            if (entity.isPresent()) {
 410                ret.put(entity.get(),method);
 411            }
 412        }
 413        return ret;
 414    }
 415
 416     @SuppressWarnings("unchecked")
 417     private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method) {
 418         if (method.getName().equals("getClass") || !method.getName().startsWith("get")
 419                 || method.getParameterTypes().length > 0) {
 420             return Optional.absent();
 421         }
 422
 423         @SuppressWarnings("rawtypes")
 424         Class returnType = method.getReturnType();
 425         if (DataContainer.class.isAssignableFrom(returnType)) {
 426             return Optional.<Class<? extends DataContainer>> of(returnType);
 427         } else if (List.class.isAssignableFrom(returnType)) {
 428             try {
 429                 return ClassLoaderUtils.withClassLoader(method.getDeclaringClass().getClassLoader(),
 430                         new Callable<Optional<Class<? extends DataContainer>>>() {
 431                             @SuppressWarnings("rawtypes")
 432                             @Override
 433                             public Optional<Class<? extends DataContainer>> call() {
 434                                 Type listResult = ClassLoaderUtils.getFirstGenericParameter(method
 435                                         .getGenericReturnType());
 436                                 if (listResult instanceof Class
 437                                         && DataContainer.class.isAssignableFrom((Class) listResult)) {
 438                                     return Optional.<Class<? extends DataContainer>> of((Class) listResult);
 439                                 }
 440                                 return Optional.absent();
 441                             }
 442
 443                         });
 444             } catch (Exception e) {
 445                 /*
 446                  *
 447                  * It is safe to log this this exception on debug, since
 448                  * this method should not fail. Only failures are possible if
 449                  * the runtime / backing.
 450                  *
 451                  */
 452                 LOG.debug("Unable to find YANG modeled return type for {}", method, e);
 453             }
 454         }
 455         return Optional.absent();
 456     }
 457
 458     private static class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
 459
 460         @Override
 461         public Optional<QName> load(final Class<?> key) throws Exception {
 462             return resolveQNameNoCache(key);
 463         }
 464     }
 465
 466     /**
 467      *
 468      * Tries to resolve QName for supplied class.
 469      *
 470      * Looks up for static field with name from constant {@link BindingMapping#QNAME_STATIC_FIELD_NAME}
 471      * and returns value if present.
 472      *
 473      * If field is not present uses {@link #computeQName(Class)} to compute QName for missing types.
 474      *
 475      * @param key
 476      * @return
 477      */
 478     private static Optional<QName> resolveQNameNoCache(final Class<?> key) {
 479         try {
 480             Field field = key.getField(BindingMapping.QNAME_STATIC_FIELD_NAME);
 481             Object obj = field.get(null);
 482             if (obj instanceof QName) {
 483                 return Optional.of((QName) obj);
 484             }
 485
 486         } catch (NoSuchFieldException e) {
 487             return Optional.of(computeQName(key));
 488
 489         } catch (SecurityException | IllegalArgumentException | IllegalAccessException e) {
 490             /*
 491              *
 492              * It is safe to log this this exception on debug, since
 493              * this method should not fail. Only failures are possible if
 494              * the runtime / backing.
 495              *
 496              */
 497             LOG.debug("Unexpected exception during extracting QName for {}",key,e);
 498         }
 499         return Optional.absent();
 500     }
 501
 502     /**
 503      * Computes QName for supplied class
 504      *
 505      * Namespace and revision are same as {@link YangModuleInfo}
 506      * associated with supplied class.
 507      * <p>
 508      * If class is
 509      * <ul>
 510      *  <li>rpc input: local name is "input".
 511      *  <li>rpc output: local name is "output".
 512      *  <li>augmentation: local name is "module name".
 513      * </ul>
 514      *
 515      * There is also fallback, if it is not possible to compute QName
 516      * using following algorithm returns module QName.
 517      *
 518      * FIXME: Extend this algorithm to also provide QName for YANG modeled simple types.
 519      *
 520      * @throws IllegalStateException If YangModuleInfo could not be resolved
 521      * @throws IllegalArgumentException If supplied class was not derived from YANG model.
 522      *
 523      */
 524     @SuppressWarnings({ "rawtypes", "unchecked" })
 525     private static QName computeQName(final Class key) {
 526         if(isBindingClass(key)) {
 527             YangModuleInfo moduleInfo;
 528             try {
 529                 moduleInfo = getModuleInfo(key);
 530             } catch (Exception e) {
 531                 throw new IllegalStateException("Unable to get QName for " + key + ". YangModuleInfo was not found.",e);
 532             }
 533             final QName module = getModuleQName(moduleInfo);
 534             if (Augmentation.class.isAssignableFrom(key)) {
 535                 return module;
 536             } else if(isRpcType(key)) {
 537                 final String className = key.getSimpleName();
 538                 if(className.endsWith(BindingMapping.RPC_OUTPUT_SUFFIX)) {
 539                     return QName.create(module,"output");
 540                 } else {
 541                     return QName.create(module,"input");
 542                 }
 543             }
 544             /*
 545              *  Fallback for Binding types which fo not have QNAME
 546              *  field
 547              */
 548             return module;
 549         } else {
 550             throw new IllegalArgumentException("Supplied class "+key+"is not derived from YANG.");
 551         }
 552     }
 553
 554     /**
 555      * Given a {@link YangModuleInfo}, create a QName representing it. The QName
 556      * is formed by reusing the module's namespace and revision using the module's
 557      * name as the QName's local name.
 558      *
 559      * @param moduleInfo module information
 560      * @return QName representing the module
 561      */
 562     public static QName getModuleQName(final YangModuleInfo moduleInfo) {
 563         checkArgument(moduleInfo != null, "moduleInfo must not be null.");
 564         return QName.create(moduleInfo.getNamespace(), moduleInfo.getRevision(),
 565                 moduleInfo.getName());
 566     }
 567
 568     /**
 569      * Extracts augmentation from Binding DTO field using reflection
 570      *
 571      * @param input Instance of DataObject which is augmentable and
 572      *      may contain augmentation
 573      * @return Map of augmentations if read was successful, otherwise
 574      *      empty map.
 575      */
 576     public static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Augmentable<?> input) {
 577         return AugmentationFieldGetter.getGetter(input.getClass()).getAugmentations(input);
 578     }
 579
 580     /**
 581      *
 582      * Determines if two augmentation classes or case classes represents same data.
 583      * <p>
 584      * Two augmentations or cases could be substituted only if and if:
 585      * <ul>
 586      * <li>Both implements same interfaces</li>
 587      * <li>Both have same children</li>
 588      * <li>If augmentations: Both have same augmentation target class. Target class was generated for data node in grouping.</li>
 589      * <li>If cases: Both are from same choice. Choice class was generated for data node in grouping.</li>
 590      * </ul>
 591      * <p>
 592      * <b>Explanation:</b> Binding Specification reuses classes generated for groupings as part of normal data tree,
 593      * this classes from grouping could be used at various locations and user may not be aware of it
 594      * and may use incorrect case or augmentation in particular subtree (via copy constructors, etc).
 595      *
 596      * @param potential Class which is potential substition
 597      * @param target Class which should be used at particular subtree
 598      * @return true if and only if classes represents same data.
 599      */
 600     @SuppressWarnings({"rawtypes","unchecked"})
 601     public static boolean isSubstitutionFor(final Class potential, final Class target) {
 602         HashSet<Class> subImplemented = Sets.newHashSet(potential.getInterfaces());
 603         HashSet<Class> targetImplemented = Sets.newHashSet(target.getInterfaces());
 604         if(!subImplemented.equals(targetImplemented)) {
 605             return false;
 606         }
 607         if(Augmentation.class.isAssignableFrom(potential)
 608                 && !BindingReflections.findAugmentationTarget(potential).equals(BindingReflections.findAugmentationTarget(target))) {
 609                 return false;
 610         }
 611         for(Method potentialMethod : potential.getMethods()) {
 612             try {
 613                 Method targetMethod = target.getMethod(potentialMethod.getName(), potentialMethod.getParameterTypes());
 614                 if(!potentialMethod.getReturnType().equals(targetMethod.getReturnType())) {
 615                     return false;
 616                 }
 617             } catch (NoSuchMethodException e) {
 618                 // Counterpart method is missing, so classes could not be substituted.
 619                 return false;
 620             } catch (SecurityException e) {
 621                 throw new IllegalStateException("Could not compare methods",e);
 622             }
 623         }
 624         return true;
 625     }
 626 }