Package org.opendaylight.yangtools.yang.model.api
@Export
package org.opendaylight.yangtools.yang.model.api
Definition of structures and DOM like API of effected YANG schema.
This package is structured into following logical units:
- YANG Meta model
- Meta model of YANG, which defines basic concepts and building blocks of YANG models
such as
ModelStatement. - YANG Statement model
- Concrete java model of YANG statements, which defines basic relationship between statements and represents these statements.
- YANG Effective model
- Effective model of processed YANG models, which represents semantic interpretation of YANG models and provides convenience views for interpreting models.
YANG Effective model
Effective model statement mapping
- anyxml
AnyxmlSchemaNode- argument
ExtensionDefinition.getArgument()- augment
AugmentationSchemaNode- base
IdentityrefTypeDefinition.getIdentities()- belongs-to
SubmoduleStatement.getBelongsTo()- bit
BitsTypeDefinition.BitBitsTypeDefinition.getBits()- case
CaseSchemaNode- choice
ChoiceSchemaNode- config
DataSchemaNode.isConfiguration()- contact
ModuleLike.getContact()- container
ContainerSchemaNode- default
TypeDefinition.getDefaultValue()- description
DocumentedNode.getDescription()DocumentedNode.getDescription()- enum
EnumTypeDefinition.EnumPairEnumTypeDefinition.getValues()- error-app-tag
ConstraintMetaDefinition.getErrorAppTag()- error-message
ConstraintMetaDefinition.getErrorMessage()- extension
ExtensionDefinition- deviation
Deviation- deviate
DeviateKind- feature
FeatureDefinition- fraction-digits
DecimalTypeDefinition.getFractionDigits()- grouping
GroupingDefinition- identity
IdentitySchemaNode- if-feature
IfFeatureStatement- import
ModuleImport- include
IncludeStatement- input
OperationDefinition.getInput()- key
ListSchemaNode.getKeyDefinition()- leaf
LeafSchemaNode- leaf-list
LeafListSchemaNode- length
LengthConstraintLengthRestrictedTypeDefinition.getLengthConstraint()- list
ListSchemaNode- mandatory
MandatoryAware.isMandatory()- max-elements
ElementCountConstraint.getMinElements()- min-elements
ElementCountConstraint.getMaxElements()- module
Module- must
MustConstraintAware.getMustConstraints()MustDefinition- namespace
QNameModuleAware.getNamespace()- notification
NotificationDefinition- ordered-by
UserOrderedAware.isUserOrdered()UserOrderedAware.isUserOrdered()- organization
ModuleLike.getOrganization()- output
OperationDefinition.getOutput()- path
LeafrefTypeDefinition.getPathStatement()- pattern
PatternConstraintStringTypeDefinition- position
BitsTypeDefinition.Bit.getPosition()- prefix
ModuleLike.getPrefix()ModuleImport.getPrefix()- presence
ContainerSchemaNode.isPresenceContainer()- range
RangeConstraintRangeRestrictedTypeDefinition.getRangeConstraint()- reference
DocumentedNode.getReference()- refine
RefineStatement- require-instance
RequireInstanceRestrictedTypeDefinition.requireInstance()- revision
QNameModuleAware.getRevision()- revision-date
ModuleImport.getRevision()- rpc
RpcDefinition- status
DocumentedNode.WithStatus.getStatus()- submodule
SubmoduleStatement- type
TypeDefinitionTypedDataSchemaNode.getType()TypedDataSchemaNode.getType()- typedef
TypeDefinition- unique
UniqueEffectiveStatement- units
TypeDefinition.getUnits()- uses
UsesNodeDataNodeContainer.getUses()- value
EnumTypeDefinition.EnumPair.getValue()- when
WhenConditionAware.getWhenCondition()- yang-version
ModuleLike.getYangVersion()- yin-element
ExtensionDefinition.isYinElement()- add
DeviateKind.ADD- current
Status.CURRENT- delete
DeviateKind.DELETE- deprecated
Status.DEPRECATED- false
Boolean.FALSE- max
- Not exposed
- min
- Not exposed
- not-supported
DeviateKind.NOT_SUPPORTED- obsolete
Status.OBSOLETE- replace
DeviateKind.REPLACE- system
UserOrderedAware.isUserOrdered()- true
Boolean.TRUE- unbounded
- Not exposed
- user
UserOrderedAware.isUserOrdered()
YANG Base Type Mapping
- Int8 built-in type
Int8TypeDefinition- Int16 built-in type
Int16TypeDefinition- Int32 built-in type
Int32TypeDefinition- Int64 built-in type
Int64TypeDefinition- Uint8 built-in type
Uint8TypeDefinition- Uint16 built-in type
Uint16TypeDefinition- Uint32 built-in type
Uint32TypeDefinition- Uint64 built-in type
Uint64TypeDefinition- Decimal64 built-in type
DecimalTypeDefinition- Boolean built-in type
BooleanTypeDefinition- Enumeration built-in type
EnumTypeDefinition- Bits Built-In Type
BitsTypeDefinition- The binary Built-In Type
BinaryTypeDefinition- The leafref Built-In Type
LeafrefTypeDefinition- The identityref Built-In Type
IdentityrefTypeDefinition- The empty Built-In Type
EmptyTypeDefinition- The union Built-In Type
UnionTypeDefinition- The instance-identifier Built-In Type
InstanceIdentifierTypeDefinition
-
ClassDescriptionRepresents YANG
actionstatement.Node which can containActionDefinition.Deprecated, for removal: This API element is subject to removal in a future version.The only user of this trait is MD-SAL's binding component.The "anydata" statement defines an interior node in the schema tree.The "anyxml" interface defines an interior node in the schema tree.AugmentationSchema represents augment definition.Interface for all nodes which are possible targets of augmentation.The CaseSchemaNode interface is used to define branches of the ChoiceSchemaNode.A ChoiceSchemaNode defines a set of alternatives.Contains methods which retrieve values for description, error message, error app tag and reference (to some external definition, resource or similar).Common interface for common container-like constructs.Base class supportingOperationDefinition.toContainerLike()andNotificationDefinition.toContainerLike().The ContainerSchemaNode is used to define an interior data node in the schema tree.Deprecated.Node which can contains other nodes.Data Schema Node represents abstract supertype from which all data tree definitions are derived.Interface describing YANG 'deviate' statement.Enumeration describingdeviateYANG statement argument.Interface describing YANG 'deviation' statement.Node which can have documentation assigned.EffectiveStatement-based result of YANG parser compilation.Marker interface for objects which have an equivalent EffectiveStatement.A base class of anEffectiveModelContextcontext reasoning with regards to what logical sequence ofEffectiveStatements were considered.Contains method which returns various data constraints for a list-like YANG element (e.g. min or max number of elements).Common interface for list-like nodes, which can optionally have constraints on the number of direct children.Contains the methods for getting the data which are part of the YANGextensoionstatement.Interface describing YANG 'feature' statement.Interface describing YANG 'grouping' statement.Interface describing YANG 'identity' statement.Interface describing YANG 'leaf-list' statement.Interface describing YANGleafstatement.Interface describing YANG 'list' statement.Mix-in interface forSchemaNodes which can have amandatorystatement.This interface contains the methods for getting the data from the YANG module.Interface describing YANG 'import' statement.This interface contains common methods for getting the schema contents from a YANG module or submodule.Mix-in interface for nodes which can define must constraints.Contains methods for accessing constraint declaration for valid data in form of XPath expressions.
YANG example:
must "ifType !Interface describing YANG 'notification' statement.Common interface for an operation, such as anRpcDefinitionor anActionDefinition.An expression as defined in RFC7950 Section 9.9.2, i.e. the argument of apathstatement.Steps of a PathExpression which is a combination ofderef()function call and a relative path, corresponding to Errata 5617.Steps of a PathExpression which is a LocationPath, corresponding to RFC7950 base specification.Abstract base class for expressing steps of a PathExpression.Interface describing YANG 'rpc' statement.The interface represents static view of compiled yang files, contains the methods for obtaining all the top level context data (data from all modules) like YANG notifications, extensions, operations...SchemaNode represents a node in schema tree.AnEffectiveStatementInferenceconsisting purely of steps along theschema treeaxis, so that it represents aschema tree nodebased on resolution ofabsolute-schema-nodeidas specified by RFC7950 section 6.5.Enumeration describing YANG 'status' statement.This interface contains the methods for getting the data from the YANG submodule.Marker interface for SchemaNodes which store simple data, for which we have type information.ADataSchemaNodewhich holds values of the same type.TypeDefinition<T extends TypeDefinition<?>>YANG statementtypedefcontains also substatementsdefault- default value which is compatible withtype,type- base type from which istypedefderived,units- textual information about units associated with this type. This interface contains the methods for getting the values of the arguments of substatements mentioned above.Contains the methods for getting the details about the unknown node.Common interface forDataSchemaNodes which can have anordered-bysubstatement.Contains the methods for getting data and checking properties of the YANGusessubstatement.Mix-in interface for nodes which can be conditional on a when statement.Mapping for both RFC6020 and RFC7950 statements.