Package org.opendaylight.yangtools.binding.runtime.spi

Class ForwardingBindingRuntimeContext

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.yangtools.binding.runtime.spi.ForwardingBindingRuntimeContext

All Implemented Interfaces:

BindingRuntimeContext, Immutable

Direct Known Subclasses:

GlobalBindingRuntimeContext

@Beta
public abstract class ForwardingBindingRuntimeContext
extends ForwardingObject
implements BindingRuntimeContext

Constructor Summary

Constructors

Constructor	Description
ForwardingBindingRuntimeContext()

Method Summary

Modifier and Type	Method	Description
protected abstract BindingRuntimeContext	delegate()
ActionRuntimeType	getActionDefinition(Class<? extends Action<?,?,?>> cls)
<T extends Augmentation<?>> AugmentRuntimeType	getAugmentationDefinition(Class<T> augClass)	Returns schema of augmentation.
Class<?>	getClassForSchema(SchemaNodeIdentifier.Absolute schema)
Class<? extends BaseIdentity>	getIdentityClass(QName input)
RpcRuntimeType	getRpcDefinition(Class<? extends Rpc<?,?>> cls)
Class<? extends RpcInput>	getRpcInput(QName rpcName)
Class<? extends RpcOutput>	getRpcOutput(QName rpcName)
CompositeRuntimeType	getSchemaDefinition(Class<?> cls)	Returns defining DataSchemaNode for supplied class.
BindingRuntimeTypes	getTypes()
RuntimeType	getTypeWithSchema(Class<?> type)	Returns schema (DataSchemaNode, AugmentationSchemaNode or TypeDefinition) from which supplied class was generated.
Class<? extends YangData<?>>	getYangDataClass(YangDataName templateName)
<T> Class<T>	loadClass(JavaTypeName typeName)

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opendaylight.yangtools.binding.runtime.api.BindingRuntimeContext

loadClass, modelContext

Constructor Details

ForwardingBindingRuntimeContext

public ForwardingBindingRuntimeContext()

Method Details

delegate

protected abstract BindingRuntimeContext delegate()

Specified by:

delegate in class ForwardingObject

getTypes

public BindingRuntimeTypes getTypes()

Specified by:

getTypes in interface BindingRuntimeContext

getAugmentationDefinition

public <T extends Augmentation<?>>
AugmentRuntimeType getAugmentationDefinition(Class<T> augClass)

Description copied from interface: BindingRuntimeContext

Returns schema of augmentation.

Returned schema is schema definition from which augmentation class was generated. This schema is isolated from other augmentations. This means it contains augmentation definition as was present in original YANG module.

Children of returned schema does not contain any additional augmentations, which may be present in runtime for them, thus returned schema is unsuitable for use for validation of data.

Specified by:

getAugmentationDefinition in interface BindingRuntimeContext

Type Parameters:

T - Augmentation class type

Parameters:

augClass - Augmentation class

Returns:

Schema of augmentation or null if augmentation is not known in this context

getSchemaDefinition

public CompositeRuntimeType getSchemaDefinition(Class<?> cls)

Description copied from interface: BindingRuntimeContext

Returns defining DataSchemaNode for supplied class.

Returned schema is schema definition from which class was generated. This schema may be isolated from augmentations, if supplied class represent node, which was child of grouping or augmentation.

For getting augmentation schema from augmentation class use BindingRuntimeContext.getAugmentationDefinition(Class) instead.

Specified by:

getSchemaDefinition in interface BindingRuntimeContext

Parameters:

cls - Class which represents list, container, choice or case.

Returns:

Schema node, from which class was generated.

getActionDefinition

public ActionRuntimeType getActionDefinition(Class<? extends Action<?,?,?>> cls)

Specified by:

getActionDefinition in interface BindingRuntimeContext

getRpcDefinition

public RpcRuntimeType getRpcDefinition(Class<? extends Rpc<?,?>> cls)

Specified by:

getRpcDefinition in interface BindingRuntimeContext

getTypeWithSchema

public RuntimeType getTypeWithSchema(Class<?> type)

Description copied from interface: BindingRuntimeContext

Returns schema (DataSchemaNode, AugmentationSchemaNode or TypeDefinition) from which supplied class was generated. Returned schema may be augmented with additional information, which was not available at compile type (e.g. third party augmentations).

Specified by:

getTypeWithSchema in interface BindingRuntimeContext

Parameters:

type - Binding Class for which schema should be retrieved.

Returns:

Instance of generated type (definition of Java API), along with DataSchemaNode, AugmentationSchemaNode or TypeDefinition which was used to generate supplied class.

getClassForSchema

public Class<?> getClassForSchema(SchemaNodeIdentifier.Absolute schema)

Specified by:

getClassForSchema in interface BindingRuntimeContext

getIdentityClass

public Class<? extends BaseIdentity> getIdentityClass(QName input)

Specified by:

getIdentityClass in interface BindingRuntimeContext

loadClass

public <T> Class<T> loadClass(JavaTypeName typeName)
                       throws ClassNotFoundException

Specified by:

loadClass in interface BindingRuntimeContext

Throws:

ClassNotFoundException

getRpcInput

public Class<? extends RpcInput> getRpcInput(QName rpcName)

Specified by:

getRpcInput in interface BindingRuntimeContext

getRpcOutput

public Class<? extends RpcOutput> getRpcOutput(QName rpcName)

Specified by:

getRpcOutput in interface BindingRuntimeContext

getYangDataClass

public Class<? extends YangData<?>> getYangDataClass(YangDataName templateName)

Specified by:

getYangDataClass in interface BindingRuntimeContext