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