BindingReflections (md-sal 2.1.5-SNAPSHOT API)

java.lang.Object
- org.opendaylight.yangtools.yang.binding.util.BindingReflections

public final class BindingReflections
extends Object

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Class<? extends Augmentable<?>>`	`findAugmentationTarget(Class<? extends Augmentation<?>> augmentation)` Find augmentation target class from concrete Augmentation class.
`static Class<?>`	`findHierarchicalParent(Class<? extends ChildOf<?>> childClass)` Find data hierarchy parent from concrete Data class.
`static Class<?>`	`findHierarchicalParent(DataObject child)` Find data hierarchy parent from concrete Data class.
`static org.opendaylight.yangtools.yang.common.QName`	`findQName(Class<?> dataType)` Returns a QName associated to supplied type.
`static Map<Class<? extends Augmentation<?>>,Augmentation<?>>`	`getAugmentations(Augmentable<?> input)` Extracts augmentation from Binding DTO field using reflection.
`static Iterable<Class<? extends DataObject>>`	`getChildrenClasses(Class<? extends DataContainer> type)` Scans supplied class and returns an iterable of all data children classes.
`static Map<Class<?>,Method>`	`getChildrenClassToMethod(Class<?> type)` Scans supplied class and returns an iterable of all data children classes.
`static String`	`getModelRootPackageName(Package pkg)` Returns root package name for suplied package.
`static String`	`getModelRootPackageName(String name)` Returns root package name for supplied package name.
`static YangModuleInfo`	`getModuleInfo(Class<?> cls)` Returns instance of `YangModuleInfo` of declaring model for specific class.
`static String`	`getModuleInfoClassName(String packageName)`
`static org.opendaylight.yangtools.yang.common.QName`	`getModuleQName(YangModuleInfo moduleInfo)` Given a `YangModuleInfo`, create a QName representing it.
`static org.opendaylight.yangtools.yang.common.QName`	`getQName(Class<? extends BaseIdentity> context)`
`static org.opendaylight.yangtools.yang.common.QNameModule`	`getQNameModule(Class<?> clz)`
`static org.opendaylight.yangtools.yang.common.QNameModule`	`getQNameModule(YangModuleInfo modInfo)`
`static boolean`	`isAugmentationChild(Class<?> clazz)` Checks if class is child of augmentation.
`static boolean`	`isBindingClass(Class<?> cls)` Check if supplied class is derived from YANG model.
`static boolean`	`isNotification(Class<?> potentialNotification)` Checks is supplied class is a `Notification`.
`static boolean`	`isNotificationCallback(Method method)` Checks if supplied method is callback for notifications.
`static boolean`	`isRpcMethod(Method possibleMethod)` Checks if method is RPC invocation.
`static boolean`	`isRpcType(Class<? extends DataObject> targetType)` Checks if supplied class represents RPC Input / RPC Output.
`static boolean`	`isSubstitutionFor(Class potential, Class target)` Determines if two augmentation classes or case classes represents same data.
`static com.google.common.collect.ImmutableSet<YangModuleInfo>`	`loadModuleInfos()` Loads `YangModuleInfo` infos available on current classloader.
`static com.google.common.collect.ImmutableSet<YangModuleInfo>`	`loadModuleInfos(ClassLoader loader)` Loads `YangModuleInfo` infos available on supplied classloader.
`static com.google.common.base.Optional<Class<? extends DataContainer>>`	`resolveRpcInputClass(Method targetMethod)` Extracts input class for RPC method.
`static com.google.common.base.Optional<Class<?>>`	`resolveRpcOutputClass(Method targetMethod)` Extracts Output class for RPC method.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - findAugmentationTarget
```
public static Class<? extends Augmentable<?>> findAugmentationTarget(Class<? extends Augmentation<?>> augmentation)
```
    Find augmentation target class from concrete Augmentation class. This method uses first generic argument of implemented Augmentation interface.
    
    Parameters:
    
    augmentation - Augmentation subclass for which we want to determine augmentation target.
    
    Returns:
    
    Augmentation target - class which augmentation provides additional extensions.
  - findHierarchicalParent
```
public static Class<?> findHierarchicalParent(Class<? extends ChildOf<?>> childClass)
```
    Find data hierarchy parent from concrete Data class. This method uses first generic argument of implemented ChildOf interface.
    
    Parameters:
    
    childClass - child class for which we want to find the parent class.
    
    Returns:
    
    Parent class, e.g. class of which the childClass is ChildOf.
  - findHierarchicalParent
```
public static Class<?> findHierarchicalParent(DataObject child)
```
    Find data hierarchy parent from concrete Data class. This method is shorthand which gets DataObject class by invoking DataContainer.getImplementedInterface() and uses findHierarchicalParent(Class).
    
    Parameters:
    
    child - Child object for which the parent needs to be located.
    
    Returns:
    
    Parent class, or null if a parent is not found.
  - findQName
```
public static org.opendaylight.yangtools.yang.common.QName findQName(Class<?> dataType)
```
    Returns a QName associated to supplied type.
    
    Parameters:
    
    dataType - Data type class
    
    Returns:
    
    QName associated to supplied dataType. If dataType is Augmentation method does not return canonical QName, but QName with correct namespace revision, but virtual local name, since augmentations do not have name. May return null if QName is not present.
  - isRpcMethod
```
public static boolean isRpcMethod(Method possibleMethod)
```
    Checks if method is RPC invocation.
    
    Parameters:
    
    possibleMethod - Method to check
    
    Returns:
    
    true if method is RPC invocation, false otherwise.
  - resolveRpcOutputClass
```
public static com.google.common.base.Optional<Class<?>> resolveRpcOutputClass(Method targetMethod)
```
    Extracts Output class for RPC method.
    
    Parameters:
    
    targetMethod - method to scan
    
    Returns:
    
    Optional.absent() if result type could not be get, or return type is Void.
  - resolveRpcInputClass
```
public static com.google.common.base.Optional<Class<? extends DataContainer>> resolveRpcInputClass(Method targetMethod)
```
    Extracts input class for RPC method.
    
    Parameters:
    
    targetMethod - method to scan
    
    Returns:
    
    Optional.absent() if RPC has no input, RPC input type otherwise.
  - getQName
```
public static org.opendaylight.yangtools.yang.common.QName getQName(Class<? extends BaseIdentity> context)
```
  - isAugmentationChild
```
public static boolean isAugmentationChild(Class<?> clazz)
```
    Checks if class is child of augmentation.
  - getModelRootPackageName
```
public static String getModelRootPackageName(Package pkg)
```
    Returns root package name for suplied package.
    
    Parameters:
    
    pkg - Package for which find model root package.
    
    Returns:
    
    Package of model root.
  - getModelRootPackageName
```
public static String getModelRootPackageName(String name)
```
    Returns root package name for supplied package name.
    
    Parameters:
    
    name - Package for which find model root package.
    
    Returns:
    
    Package of model root.
  - getQNameModule
```
public static org.opendaylight.yangtools.yang.common.QNameModule getQNameModule(Class<?> clz)
```
  - getQNameModule
```
public static org.opendaylight.yangtools.yang.common.QNameModule getQNameModule(YangModuleInfo modInfo)
```
  - getModuleInfo
```
public static YangModuleInfo getModuleInfo(Class<?> cls)
                                    throws Exception
```
    Returns instance of YangModuleInfo of declaring model for specific class.
    
    Parameters:
    
    cls - data object class
    
    Returns:
    
    Instance of YangModuleInfo associated with model, from which this class was derived.
    
    Throws:
    
    Exception
  - getModuleInfoClassName
```
public static String getModuleInfoClassName(String packageName)
```
  - isBindingClass
```
public static boolean isBindingClass(Class<?> cls)
```
    Check if supplied class is derived from YANG model.
    
    Parameters:
    
    cls - Class to check
    
    Returns:
    
    true if class is derived from YANG model.
  - isNotificationCallback
```
public static boolean isNotificationCallback(Method method)
```
    Checks if supplied method is callback for notifications.
    
    Parameters:
    
    method - method to check
    
    Returns:
    
    true if method is notification callback.
  - isNotification
```
public static boolean isNotification(Class<?> potentialNotification)
```
    Checks is supplied class is a Notification.
    
    Parameters:
    
    potentialNotification - class to examine
    
    Returns:
    
    True if the class represents a Notification.
  - loadModuleInfos
```
public static com.google.common.collect.ImmutableSet<YangModuleInfo> loadModuleInfos()
```
    Loads YangModuleInfo infos available on current classloader. This method is shorthand for loadModuleInfos(ClassLoader) with Thread.getContextClassLoader() for current thread.
    
    Returns:
    
    Set of YangModuleInfo available for current classloader.
  - loadModuleInfos
```
public static com.google.common.collect.ImmutableSet<YangModuleInfo> loadModuleInfos(ClassLoader loader)
```
    Loads YangModuleInfo infos available on supplied classloader.
    YangModuleInfo are discovered using ServiceLoader for YangModelBindingProvider. YangModelBindingProvider are simple classes which holds only pointers to actual instance YangModuleInfo.
    When YangModuleInfo is available, all dependencies are recursively collected into returning set by collecting results of YangModuleInfo.getImportedModules().
    
    Parameters:
    
    loader - Classloader for which YangModuleInfo should be retrieved.
    
    Returns:
    
    Set of YangModuleInfo available for supplied classloader.
  - isRpcType
```
public static boolean isRpcType(Class<? extends DataObject> targetType)
```
    Checks if supplied class represents RPC Input / RPC Output.
    
    Parameters:
    
    targetType - Class to be checked
    
    Returns:
    
    true if class represents RPC Input or RPC Output class.
  - getChildrenClasses
```
public static Iterable<Class<? extends DataObject>> getChildrenClasses(Class<? extends DataContainer> type)
```
    Scans supplied class and returns an iterable of all data children classes.
    
    Parameters:
    
    type - YANG Modeled Entity derived from DataContainer
    
    Returns:
    
    Iterable of all data children, which have YANG modeled entity
  - getChildrenClassToMethod
```
public static Map<Class<?>,Method> getChildrenClassToMethod(Class<?> type)
```
    Scans supplied class and returns an iterable of all data children classes.
    
    Parameters:
    
    type - YANG Modeled Entity derived from DataContainer
    
    Returns:
    
    Iterable of all data children, which have YANG modeled entity
  - getModuleQName
```
public static org.opendaylight.yangtools.yang.common.QName getModuleQName(YangModuleInfo moduleInfo)
```
    Given a 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.
    
    Parameters:
    
    moduleInfo - module information
    
    Returns:
    
    QName representing the module
  - getAugmentations
```
public static Map<Class<? extends Augmentation<?>>,Augmentation<?>> getAugmentations(Augmentable<?> input)
```
    Extracts augmentation from Binding DTO field using reflection.
    
    Parameters:
    
    input - Instance of DataObject which is augmentable and may contain augmentation
    
    Returns:
    
    Map of augmentations if read was successful, otherwise empty map.
  - isSubstitutionFor
```
public static boolean isSubstitutionFor(Class potential,
                                        Class target)
```
    Determines if two augmentation classes or case classes represents same data.
    Two augmentations or cases could be substituted only if and if:
    - Both implements same interfaces
    - Both have same children
    - If augmentations: Both have same augmentation target class. Target class was generated for data node in grouping.
    - If cases: Both are from same choice. Choice class was generated for data node in grouping.
    Explanation: 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).
    Parameters:
    
    potential - Class which is potential substition
    
    target - Class which should be used at particular subtree
    
    Returns:
    
    true if and only if classes represents same data.

Class BindingReflections

Method Summary

Methods inherited from class java.lang.Object

Method Detail

findAugmentationTarget

findHierarchicalParent

findHierarchicalParent

findQName

isRpcMethod

resolveRpcOutputClass

resolveRpcInputClass

getQName

isAugmentationChild

getModelRootPackageName

getModelRootPackageName

getQNameModule

getQNameModule

getModuleInfo

getModuleInfoClassName

isBindingClass

isNotificationCallback

isNotification

loadModuleInfos

loadModuleInfos

isRpcType

getChildrenClasses

getChildrenClassToMethod

getModuleQName

getAugmentations

isSubstitutionFor