Module org.opendaylight.yangtools.binding.runtime.api

Package org.opendaylight.yangtools.binding.runtime.api

Interface BindingRuntimeTypes

All Superinterfaces:

Immutable, RuntimeTypeContainer

@Beta
public interface BindingRuntimeTypes
extends RuntimeTypeContainer, Immutable

The result of BindingGenerator run. Contains mapping between Types and SchemaNodes.

Method Summary

Modifier and Type	Method	Description
@NonNull Set<CaseRuntimeType>	allCaseChildren(ChoiceRuntimeType choiceType)	Lookup to all CaseRuntimeTypes related to a ChoiceRuntimeType.
Optional<ModuleRuntimeType>	findModule(QNameModule module)
Optional<RuntimeType>	findSchema(org.opendaylight.yangtools.binding.model.api.JavaTypeName typeName)
Optional<YangDataRuntimeType>	findYangData(YangDataName templateName)
@Nullable IdentityRuntimeType	identityChild(@NonNull QName qname)	Lookup IdentityRuntimeType by its QNamme.
@NonNull EffectiveModelContext	modelContext()	Return the EffectiveModelContext underlying this object.
default @Nullable RuntimeType	schemaTreeChild(SchemaNodeIdentifier.Absolute path)

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

bindingChild, bindingChild, schemaTreeChild

Method Details

modelContext

@NonNull EffectiveModelContext modelContext()

Return the EffectiveModelContext underlying this object.

Returns:

the EffectiveModelContext underlying this object

identityChild

@Nullable IdentityRuntimeType identityChild(@NonNull QName qname)

Lookup IdentityRuntimeType by its QNamme.

Parameters:

qname - Identity name

Returns:

IdentityRuntimeType or null

Throws:

NullPointerException - if qname is null

findSchema

Optional<RuntimeType> findSchema(org.opendaylight.yangtools.binding.model.api.JavaTypeName typeName)

findModule

Optional<ModuleRuntimeType> findModule(QNameModule module)

findYangData

Optional<YangDataRuntimeType> findYangData(YangDataName templateName)

schemaTreeChild

default @Nullable RuntimeType schemaTreeChild(SchemaNodeIdentifier.Absolute path)

allCaseChildren

@NonNull Set<CaseRuntimeType> allCaseChildren(ChoiceRuntimeType choiceType)

Lookup to all CaseRuntimeTypes related to a ChoiceRuntimeType. This is important when dealing with sharing incurred by Binding Spec's reuse of constructs defined in a grouping.

As an example, consider ChoiceRuntimeType and CaseRuntimeType relationship to GeneratedTypes in the following model:

   
     grouping grp {
       container foo {
         choice bar;
       }
     }

     container foo {
       uses grp;
     }

     container bar {
       uses grp;
     }

     augment /foo/foo/bar {
       case baz
     }

     augment /bar/foo/bar {
       case xyzzy;
     }
   
 

YANG view of what is valid in /foo/foo/bar differs from what is valid in /bar/foo/bar, but this difference is not reflected in generated Java constructs. More notably, the two augments being in different modules. Since choice bar's is part of a reusable construct, grouping one, DataObjects' copy builders can propagate them without translating them to the appropriate manifestation -- and they can do nothing about that as they lack the complete view of the effective model.

This method provides a bridge between a particular instantiation of a choice to CaseRuntimeTypes valid in all instantiations.

Parameters:

choiceType - A ChoiceRuntimeType

Returns:

The set of CaseRuntimeTypes known to this instance

Throws:

NullPointerException - if ChoiceRuntimeType is null