BindingReflections (md-sal 3.0.7-SNAPSHOT API)

java.lang.Object
- org.opendaylight.mdsal.binding.javav2.runtime.reflection.BindingReflections

@Beta
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 This method uses first generic argument of implemented `Augmentation` interface.
`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 TreeNode>>`	`getChildrenClasses(Class<? extends Instantiable<?>> 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 supplied 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)` Returns name of module info class.
`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)` Find qname of base identity context.
`static org.opendaylight.yangtools.yang.common.QNameModule`	`getQNameModule(Class<?> clz)` Get QName module of specific Binding object class.
`static org.opendaylight.yangtools.yang.common.QNameModule`	`getQNameModule(YangModuleInfo modInfo)` Returns module QName.
`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)` Check if supplied class is Notification.
`static boolean`	`isNotificationCallback(Method method)` Checks if supplied method is callback for notifications.
`static boolean`	`isOperationMethod(Method possibleMethod)` Checks if method is RPC or Action invocation
`static boolean`	`isOperationType(Class<? extends TreeNode> targetType)` Checks if supplied class represents RPC or Action input/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` info available on current classloader.
`static com.google.common.collect.ImmutableSet<YangModuleInfo>`	`loadModuleInfos(ClassLoader loader)` Loads `YangModuleInfo` info available on supplied classloader.
`static Optional<Class<? extends Instantiable<?>>>`	`resolveOperationInputClass(Method targetMethod)` Extracts input class for RPC or Action
`static Optional<Class<?>>`	`resolveOperationOutputClass(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.
  - findQName
```
public static org.opendaylight.yangtools.yang.common.QName findQName(Class<?> dataType)
```
    Returns a QName associated to supplied type
    
    Parameters:
    
    dataType - - type of data
    
    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.
  - isOperationMethod
```
public static boolean isOperationMethod(Method possibleMethod)
```
    Checks if method is RPC or Action invocation
    
    Parameters:
    
    possibleMethod - - method to check
    
    Returns:
    
    true if method is RPC or Action invocation, false otherwise.
  - resolveOperationOutputClass
```
public static Optional<Class<?>> resolveOperationOutputClass(Method targetMethod)
```
    Extracts Output class for RPC method
    
    Parameters:
    
    targetMethod - method to scan
    
    Returns:
    
    Optional.empty() if result type could not be get, or return type is Void.
  - resolveOperationInputClass
```
public static Optional<Class<? extends Instantiable<?>>> resolveOperationInputClass(Method targetMethod)
```
    Extracts input class for RPC or Action
    
    Parameters:
    
    targetMethod - - method to scan
    
    Returns:
    
    Optional.empty() if RPC or Action has no input, RPC input type otherwise.
  - getQName
```
public static org.opendaylight.yangtools.yang.common.QName getQName(Class<? extends BaseIdentity> context)
```
    Find qname of base identity context.
    
    Parameters:
    
    context - - base identity type context
    
    Returns:
    
    QName of base identity context
  - isAugmentationChild
```
public static boolean isAugmentationChild(Class<?> clazz)
```
    Checks if class is child of augmentation.
    
    Parameters:
    
    clazz - - class to check
    
    Returns:
    
    true if is augmentation, false otherwise
  - getModelRootPackageName
```
public static String getModelRootPackageName(Package pkg)
```
    Returns root package name for supplied 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 final org.opendaylight.yangtools.yang.common.QNameModule getQNameModule(Class<?> clz)
```
    Get QName module of specific Binding object class.
    
    Parameters:
    
    clz - - class of binding object
    
    Returns:
    
    QName module of binding object
  - getQNameModule
```
public static final org.opendaylight.yangtools.yang.common.QNameModule getQNameModule(YangModuleInfo modInfo)
```
    Returns module QName.
    
    Parameters:
    
    modInfo - - module info
    
    Returns:
    
    QNameModule from module info
  - getModuleInfo
```
public static YangModuleInfo getModuleInfo(Class<?> cls)
                                    throws Exception
```
    Returns instance of YangModuleInfo of declaring model for specific class.
    
    Parameters:
    
    cls - - class for getting info
    
    Returns:
    
    Instance of YangModuleInfo associated with model, from which this class was derived.
    
    Throws:
    
    Exception
  - getModuleInfoClassName
```
public static String getModuleInfoClassName(String packageName)
```
    Returns name of module info class.
    
    Parameters:
    
    packageName - - package name
    
    Returns:
    
    name of module info class
  - 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 for check
    
    Returns:
    
    true if method is notification callback
  - isNotification
```
public static boolean isNotification(Class<?> potentialNotification)
```
    Check if supplied class is Notification.
    
    Parameters:
    
    potentialNotification - - class to check
    
    Returns:
    
    true if class is notification, false otherwise
  - loadModuleInfos
```
public static com.google.common.collect.ImmutableSet<YangModuleInfo> loadModuleInfos()
```
    Loads YangModuleInfo info 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 info 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.
  - isOperationType
```
public static boolean isOperationType(Class<? extends TreeNode> targetType)
```
    Checks if supplied class represents RPC or Action input/output.
    
    Parameters:
    
    targetType - - class to be checked
    
    Returns:
    
    true if class represents RPC or Action input/output class
  - getChildrenClasses
```
public static Iterable<Class<? extends TreeNode>> getChildrenClasses(Class<? extends Instantiable<?>> 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 substitution
    
    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

findQName

isOperationMethod

resolveOperationOutputClass

resolveOperationInputClass

getQName

isAugmentationChild

getModelRootPackageName

getModelRootPackageName

getQNameModule

getQNameModule

getModuleInfo

getModuleInfoClassName

isBindingClass

isNotificationCallback

isNotification

loadModuleInfos

loadModuleInfos

isOperationType

getChildrenClasses

getChildrenClassToMethod

getModuleQName

getAugmentations

isSubstitutionFor