binding/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
  13 import com.google.common.base.Optional;
  14 import com.google.common.cache.CacheBuilder;
  15 import com.google.common.cache.CacheLoader;
  16 import com.google.common.cache.LoadingCache;
  17 import com.google.common.collect.ImmutableSet;
  18 import com.google.common.collect.ImmutableSet.Builder;
  19 import com.google.common.collect.Sets;
  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.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 javax.annotation.RegEx;
  35 import org.opendaylight.yangtools.util.ClassLoaderUtils;
  36 import org.opendaylight.yangtools.yang.binding.Augmentable;
  37 import org.opendaylight.yangtools.yang.binding.Augmentation;
  38 import org.opendaylight.yangtools.yang.binding.BaseIdentity;
  39 import org.opendaylight.yangtools.yang.binding.BindingMapping;
  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])";
  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).orNull();
 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                 && Future.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.absent() 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.absent();
 159     }
 160
 161     /**
 162      * Extracts input class for RPC method.
 163      *
 164      * @param targetMethod
 165      *            method to scan
 166      * @return Optional.absent() 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.absent();
 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             return findQName(clz).getModule();
 234         }
 235         try {
 236             return BindingReflections.getModuleInfo(clz).getName().getModule();
 237         } catch (Exception e) {
 238             throw new IllegalStateException("Unable to get QName of defining model.", e);
 239         }
 240     }
 241
 242     /**
 243      * Extract a QNameModule from YangModuleInfo.
 244      *
 245      * @param modInfo Module info
 246      * @return QNameModule for the module
 247      * @throws NullPointerException in modInfo is null
 248      *
 249      * @deprecated Use {@code YangModuleInfo.getName().getModule()} instead.
 250      */
 251     @Deprecated
 252     public static QNameModule getQNameModule(final YangModuleInfo modInfo) {
 253         return modInfo.getName().getModule();
 254     }
 255
 256     /**
 257      * Returns instance of {@link YangModuleInfo} of declaring model for specific class.
 258      *
 259      * @param cls data object class
 260      * @return Instance of {@link YangModuleInfo} associated with model, from
 261      *         which this class was derived.
 262      */
 263     public static YangModuleInfo getModuleInfo(final Class<?> cls) throws Exception {
 264         checkArgument(cls != null);
 265         String packageName = getModelRootPackageName(cls.getPackage());
 266         final String potentialClassName = getModuleInfoClassName(packageName);
 267         return ClassLoaderUtils.withClassLoader(cls.getClassLoader(), (Callable<YangModuleInfo>) () -> {
 268             Class<?> moduleInfoClass = Thread.currentThread().getContextClassLoader().loadClass(potentialClassName);
 269             return (YangModuleInfo) moduleInfoClass.getMethod("getInstance").invoke(null);
 270         });
 271     }
 272
 273     public static String getModuleInfoClassName(final String packageName) {
 274         return packageName + "." + BindingMapping.MODULE_INFO_CLASS_NAME;
 275     }
 276
 277     /**
 278      * Check if supplied class is derived from YANG model.
 279      *
 280      * @param cls
 281      *            Class to check
 282      * @return true if class is derived from YANG model.
 283      */
 284     public static boolean isBindingClass(final Class<?> cls) {
 285         if (DataContainer.class.isAssignableFrom(cls) || Augmentation.class.isAssignableFrom(cls)) {
 286             return true;
 287         }
 288         return cls.getName().startsWith(BindingMapping.PACKAGE_PREFIX);
 289     }
 290
 291     /**
 292      * Checks if supplied method is callback for notifications.
 293      *
 294      * @param method method to check
 295      * @return true if method is notification callback.
 296      */
 297     public static boolean isNotificationCallback(final Method method) {
 298         checkArgument(method != null);
 299         if (method.getName().startsWith("on") && method.getParameterTypes().length == 1) {
 300             Class<?> potentialNotification = method.getParameterTypes()[0];
 301             if (isNotification(potentialNotification)
 302                     && method.getName().equals("on" + potentialNotification.getSimpleName())) {
 303                 return true;
 304             }
 305         }
 306         return false;
 307     }
 308
 309     /**
 310      * Checks is supplied class is a {@link Notification}.
 311      *
 312      * @param potentialNotification class to examine
 313      * @return True if the class represents a Notification.
 314      */
 315     public static boolean isNotification(final Class<?> potentialNotification) {
 316         checkArgument(potentialNotification != null, "potentialNotification must not be null.");
 317         return Notification.class.isAssignableFrom(potentialNotification);
 318     }
 319
 320     /**
 321      * Loads {@link YangModuleInfo} infos available on current classloader. This method is shorthand for
 322      * {@link #loadModuleInfos(ClassLoader)} with {@link Thread#getContextClassLoader()} for current thread.
 323      *
 324      * @return Set of {@link YangModuleInfo} available for current classloader.
 325      */
 326     public static ImmutableSet<YangModuleInfo> loadModuleInfos() {
 327         return loadModuleInfos(Thread.currentThread().getContextClassLoader());
 328     }
 329
 330     /**
 331      * Loads {@link YangModuleInfo} infos available on supplied classloader.
 332      *
 333      * <p>
 334      * {@link YangModuleInfo} are discovered using {@link ServiceLoader} for {@link YangModelBindingProvider}.
 335      * {@link YangModelBindingProvider} are simple classes which holds only pointers to actual instance
 336      * {@link YangModuleInfo}.
 337      *
 338      * <p>
 339      * When {@link YangModuleInfo} is available, all dependencies are recursively collected into returning set by
 340      * collecting results of {@link YangModuleInfo#getImportedModules()}.
 341      *
 342      * @param loader
 343      *            Classloader for which {@link YangModuleInfo} should be
 344      *            retrieved.
 345      * @return Set of {@link YangModuleInfo} available for supplied classloader.
 346      */
 347     public static ImmutableSet<YangModuleInfo> loadModuleInfos(final ClassLoader loader) {
 348         Builder<YangModuleInfo> moduleInfoSet = ImmutableSet.builder();
 349         ServiceLoader<YangModelBindingProvider> serviceLoader = ServiceLoader.load(YangModelBindingProvider.class,
 350                 loader);
 351         for (YangModelBindingProvider bindingProvider : serviceLoader) {
 352             YangModuleInfo moduleInfo = bindingProvider.getModuleInfo();
 353             checkState(moduleInfo != null, "Module Info for %s is not available.", bindingProvider.getClass());
 354             collectYangModuleInfo(bindingProvider.getModuleInfo(), moduleInfoSet);
 355         }
 356         return moduleInfoSet.build();
 357     }
 358
 359     private static void collectYangModuleInfo(final YangModuleInfo moduleInfo,
 360             final Builder<YangModuleInfo> moduleInfoSet) {
 361         moduleInfoSet.add(moduleInfo);
 362         for (YangModuleInfo dependency : moduleInfo.getImportedModules()) {
 363             collectYangModuleInfo(dependency, moduleInfoSet);
 364         }
 365     }
 366
 367     /**
 368      * Checks if supplied class represents RPC Input / RPC Output.
 369      *
 370      * @param targetType
 371      *            Class to be checked
 372      * @return true if class represents RPC Input or RPC Output class.
 373      */
 374     public static boolean isRpcType(final Class<? extends DataObject> targetType) {
 375         return DataContainer.class.isAssignableFrom(targetType)
 376                 && !ChildOf.class.isAssignableFrom(targetType)
 377                 && !Notification.class.isAssignableFrom(targetType)
 378                 && (targetType.getName().endsWith("Input") || targetType.getName().endsWith("Output"));
 379     }
 380
 381     /**
 382      * Scans supplied class and returns an iterable of all data children classes.
 383      *
 384      * @param type
 385      *            YANG Modeled Entity derived from DataContainer
 386      * @return Iterable of all data children, which have YANG modeled entity
 387      */
 388     @SuppressWarnings("unchecked")
 389     public static Iterable<Class<? extends DataObject>> getChildrenClasses(final Class<? extends DataContainer> type) {
 390         checkArgument(type != null, "Target type must not be null");
 391         checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer");
 392         List<Class<? extends DataObject>> ret = new LinkedList<>();
 393         for (Method method : type.getMethods()) {
 394             Optional<Class<? extends DataContainer>> entity = getYangModeledReturnType(method);
 395             if (entity.isPresent()) {
 396                 ret.add((Class<? extends DataObject>) entity.get());
 397             }
 398         }
 399         return ret;
 400     }
 401
 402     /**
 403      * Scans supplied class and returns an iterable of all data children classes.
 404      *
 405      * @param type
 406      *            YANG Modeled Entity derived from DataContainer
 407      * @return Iterable of all data children, which have YANG modeled entity
 408      */
 409     public static Map<Class<?>, Method> getChildrenClassToMethod(final Class<?> type) {
 410         checkArgument(type != null, "Target type must not be null");
 411         checkArgument(DataContainer.class.isAssignableFrom(type), "Supplied type must be derived from DataContainer");
 412         Map<Class<?>, Method> ret = new HashMap<>();
 413         for (Method method : type.getMethods()) {
 414             Optional<Class<? extends DataContainer>> entity = getYangModeledReturnType(method);
 415             if (entity.isPresent()) {
 416                 ret.put(entity.get(), method);
 417             }
 418         }
 419         return ret;
 420     }
 421
 422     @SuppressWarnings({ "unchecked", "rawtypes", "checkstyle:illegalCatch" })
 423     private static Optional<Class<? extends DataContainer>> getYangModeledReturnType(final Method method) {
 424         if ("getClass".equals(method.getName()) || !method.getName().startsWith("get")
 425                 || method.getParameterTypes().length > 0) {
 426             return Optional.absent();
 427         }
 428
 429         Class returnType = method.getReturnType();
 430         if (DataContainer.class.isAssignableFrom(returnType)) {
 431             return Optional.of(returnType);
 432         } else if (List.class.isAssignableFrom(returnType)) {
 433             try {
 434                 return ClassLoaderUtils.withClassLoader(method.getDeclaringClass().getClassLoader(),
 435                     (Callable<Optional<Class<? extends DataContainer>>>) () -> {
 436                         Type listResult = ClassLoaderUtils.getFirstGenericParameter(method.getGenericReturnType());
 437                         if (listResult instanceof Class
 438                                 && DataContainer.class.isAssignableFrom((Class) listResult)) {
 439                             return Optional.of((Class) listResult);
 440                         }
 441                         return Optional.absent();
 442                     });
 443             } catch (Exception e) {
 444                 /*
 445                  * It is safe to log this this exception on debug, since this
 446                  * method should not fail. Only failures are possible if the
 447                  * runtime / backing.
 448                  */
 449                 LOG.debug("Unable to find YANG modeled return type for {}", method, e);
 450             }
 451         }
 452         return Optional.absent();
 453     }
 454
 455     private static class ClassToQNameLoader extends CacheLoader<Class<?>, Optional<QName>> {
 456
 457         @Override
 458         public Optional<QName> load(@SuppressWarnings("NullableProblems") final Class<?> key) throws Exception {
 459             return resolveQNameNoCache(key);
 460         }
 461
 462         /**
 463          * Tries to resolve QName for supplied class. Looks up for static field with name from constant
 464          * {@link BindingMapping#QNAME_STATIC_FIELD_NAME} and returns value if present. If field is not present uses
 465          * {@link #computeQName(Class)} to compute QName for missing types.
 466          */
 467         private static Optional<QName> resolveQNameNoCache(final Class<?> key) {
 468             try {
 469                 Field field = key.getField(BindingMapping.QNAME_STATIC_FIELD_NAME);
 470                 Object obj = field.get(null);
 471                 if (obj instanceof QName) {
 472                     return Optional.of((QName) obj);
 473                 }
 474
 475             } catch (NoSuchFieldException e) {
 476                 return Optional.of(computeQName(key));
 477
 478             } catch (SecurityException | IllegalArgumentException | IllegalAccessException e) {
 479                 /*
 480                  *
 481                  * It is safe to log this this exception on debug, since this method
 482                  * should not fail. Only failures are possible if the runtime /
 483                  * backing.
 484                  */
 485                 LOG.debug("Unexpected exception during extracting QName for {}", key, e);
 486             }
 487             return Optional.absent();
 488         }
 489
 490         /**
 491          * Computes QName for supplied class. Namespace and revision are same as {@link YangModuleInfo} associated with
 492          * supplied class.
 493          *
 494          * <p>
 495          * If class is
 496          * <ul>
 497          * <li>rpc input: local name is "input".
 498          * <li>rpc output: local name is "output".
 499          * <li>augmentation: local name is "module name".
 500          * </ul>
 501          *
 502          * <p>
 503          * There is also fallback, if it is not possible to compute QName using following algorithm returns module
 504          * QName.
 505          *
 506          * @throws IllegalStateException If YangModuleInfo could not be resolved
 507          * @throws IllegalArgumentException If supplied class was not derived from YANG model.
 508          */
 509         // FIXME: Extend this algorithm to also provide QName for YANG modeled simple types.
 510         @SuppressWarnings({ "rawtypes", "unchecked", "checkstyle:illegalCatch" })
 511         private static QName computeQName(final Class key) {
 512             checkArgument(isBindingClass(key), "Supplied class %s is not derived from YANG.", key);
 513
 514             YangModuleInfo moduleInfo;
 515             try {
 516                 moduleInfo = getModuleInfo(key);
 517             } catch (Exception e) {
 518                 throw new IllegalStateException("Unable to get QName for " + key + ". YangModuleInfo was not found.",
 519                     e);
 520             }
 521             final QName module = moduleInfo.getName();
 522             if (Augmentation.class.isAssignableFrom(key)) {
 523                 return module;
 524             } else if (isRpcType(key)) {
 525                 final String className = key.getSimpleName();
 526                 if (className.endsWith(BindingMapping.RPC_OUTPUT_SUFFIX)) {
 527                     return YangConstants.operationOutputQName(module.getModule()).intern();
 528                 }
 529
 530                 return YangConstants.operationInputQName(module.getModule()).intern();
 531             }
 532
 533             /*
 534              * Fallback for Binding types which do not have QNAME field
 535              */
 536             return module;
 537         }
 538     }
 539
 540     /**
 541      * Given a {@link YangModuleInfo}, create a QName representing it. The QName is formed by reusing the module's
 542      * namespace and revision using the module's name as the QName's local name.
 543      *
 544      * @param moduleInfo
 545      *            module information
 546      * @return QName representing the module
 547      *
 548      * @deprecated Use {@link YangModuleInfo#getName()} instead.
 549      */
 550     @Deprecated
 551     public static QName getModuleQName(final YangModuleInfo moduleInfo) {
 552         checkArgument(moduleInfo != null, "moduleInfo must not be null.");
 553         return moduleInfo.getName();
 554     }
 555
 556     /**
 557      * Extracts augmentation from Binding DTO field using reflection.
 558      *
 559      * @param input
 560      *            Instance of DataObject which is augmentable and may contain
 561      *            augmentation
 562      * @return Map of augmentations if read was successful, otherwise empty map.
 563      */
 564     public static Map<Class<? extends Augmentation<?>>, Augmentation<?>> getAugmentations(final Augmentable<?> input) {
 565         return AugmentationFieldGetter.getGetter(input.getClass()).getAugmentations(input);
 566     }
 567
 568     /**
 569      * Determines if two augmentation classes or case classes represents same
 570      * data.
 571      *
 572      * <p>
 573      * Two augmentations or cases could be substituted only if and if:
 574      * <ul>
 575      * <li>Both implements same interfaces</li>
 576      * <li>Both have same children</li>
 577      * <li>If augmentations: Both have same augmentation target class. Target
 578      * class was generated for data node in grouping.</li>
 579      * <li>If cases: Both are from same choice. Choice class was generated for
 580      * data node in grouping.</li>
 581      * </ul>
 582      *
 583      * <p>
 584      * <b>Explanation:</b> Binding Specification reuses classes generated for
 585      * groupings as part of normal data tree, this classes from grouping could
 586      * be used at various locations and user may not be aware of it and may use
 587      * incorrect case or augmentation in particular subtree (via copy
 588      * constructors, etc).
 589      *
 590      * @param potential
 591      *            Class which is potential substition
 592      * @param target
 593      *            Class which should be used at particular subtree
 594      * @return true if and only if classes represents same data.
 595      */
 596     @SuppressWarnings({ "rawtypes", "unchecked" })
 597     public static boolean isSubstitutionFor(final Class potential, final Class target) {
 598         HashSet<Class> subImplemented = Sets.newHashSet(potential.getInterfaces());
 599         HashSet<Class> targetImplemented = Sets.newHashSet(target.getInterfaces());
 600         if (!subImplemented.equals(targetImplemented)) {
 601             return false;
 602         }
 603         if (Augmentation.class.isAssignableFrom(potential)
 604                 && !BindingReflections.findAugmentationTarget(potential).equals(
 605                         BindingReflections.findAugmentationTarget(target))) {
 606             return false;
 607         }
 608         for (Method potentialMethod : potential.getMethods()) {
 609             try {
 610                 Method targetMethod = target.getMethod(potentialMethod.getName(), potentialMethod.getParameterTypes());
 611                 if (!potentialMethod.getReturnType().equals(targetMethod.getReturnType())) {
 612                     return false;
 613                 }
 614             } catch (NoSuchMethodException e) {
 615                 // Counterpart method is missing, so classes could not be
 616                 // substituted.
 617                 return false;
 618             } catch (SecurityException e) {
 619                 throw new IllegalStateException("Could not compare methods", e);
 620             }
 621         }
 622         return true;
 623     }
 624 }