org.opendaylight.yangtools.yang.model.api (yangtools 2.1.9-SNAPSHOT API)

Interface Summary
Interface	Description
ActionDefinition	Represents YANG action statement.
ActionNodeContainer	Node which can contain action nodes.
AddedByUsesAware	Deprecated This interface relates to declared model rather than to effective mode and as such should not exist.
AnyDataSchemaNode	The "anydata" statement defines an interior node in the schema tree.
AnyXmlSchemaNode	The "anyxml" interface defines an interior node in the schema tree.
AugmentationSchemaNode	AugmentationSchema represents augment definition.
AugmentationTarget	Interface for all nodes which are possible targets of augmentation.
CaseSchemaNode	The CaseSchemaNode interface is used to define branches of the ChoiceSchemaNode.
ChoiceSchemaNode	A ChoiceSchemaNode defines a set of alternatives.
ConstraintMetaDefinition	Contains methods which retrieve values for description, error message, error app tag and reference (to some external definition, resource or similar).
ContainerSchemaNode	The ContainerSchemaNode is used to define an interior data node in the schema tree.
CopyableNode	Deprecated Aside from the deprecated `AddedByUsesAware` contract, this interface adds only a trait related to now how we arrived at this effective node.
DataNodeContainer	Node which can contains other nodes.
DataSchemaNode	Data Schema Node represents abstract supertype from which all data tree definitions are derived.
DerivableSchemaNode	Schema Node which may be derived from other schema node using augmentation or uses statement.
DeviateDefinition	Interface describing YANG 'deviate' statement.
Deviation	Interface describing YANG 'deviation' statement.
DocumentedNode	Node which can have documentation assigned.
DocumentedNode.WithStatus
ElementCountConstraintAware	Common interface for list-like nodes, which can optionally have constraints on the number of direct children.
ExtensionDefinition	Contains the methods for getting the data which are part of the YANG `extensoion` statement.
FeatureDefinition	Interface describing YANG 'feature' statement.
GroupingDefinition	Interface describing YANG 'grouping' statement.
IdentitySchemaNode	Interface describing YANG 'identity' statement.
LeafListSchemaNode	Interface describing YANG 'leaf-list' statement.
LeafSchemaNode	Interface describing YANG `leaf` statement.
ListSchemaNode	Interface describing YANG 'list' statement.
MandatoryAware	Mix-in interface for `SchemaNode`s which can have a `mandatory` statement.
Module	This interface contains the methods for getting the data from the YANG module. Example of YANG module module module_name{ yang-version "1"; namespace "urn:module:namespace"; prefix "prefix"; description "description test"; reference "reference test"; organization "John Doe, john.doe@email.com"; contact "http://www.opendaylight.org/"; feature feature-test{ description "description of some feature"; } notification notification-test; rpc rpc-test; identity identity-test; extension extension-test; revision 2011-08-27 { import other_module { prefix "other_module_prefix" revision-date 2011-08-27 } container cont { } augment "/cont" { ; } }
ModuleImport	Interface describing YANG 'import' statement.
MustConstraintAware	Mix-in interface for nodes which can define must constraints.
MustDefinition	Contains methods for accessing constraint declaration for valid data in form of XPath expressions. YANG example: `must "ifType != 'ethernet' or (ifType = 'ethernet' and ifMTU = 1500)";`
NamespaceRevisionAware
NotificationDefinition	Interface describing YANG 'notification' statement.
NotificationNodeContainer
OperationDefinition	Common interface for an operation.
RevisionAwareXPath	Contains methods for getting data (concrete XPath) and metadata (is XPath absolute) from XPath instance.
RpcDefinition	Interface describing YANG 'rpc' statement.
SchemaContext	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...
SchemaContextListener	Interface for listeners interested in updates of the global schema context.
SchemaContextProvider
SchemaNode	SchemaNode represents a node in schema tree.
TypeAware	Marker interface for SchemaNodes which store simple data, for which we have type information.
TypedDataSchemaNode	A `DataSchemaNode` which holds values of the same type.
TypeDefinition<T extends TypeDefinition<?>>	YANG statement `typedef` contains also substatements `default` - default value which is compatible with `type`, `type` - base type from which is `typedef` derived, `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.
UniqueConstraint	Interface describing YANG 'unique' constraint.
UnknownSchemaNode	Contains the methods for getting the details about the unknown node.
UsesNode	Contains the methods for getting data and checking properties of the YANG `uses` substatement.
WhenConditionAware	Mix-in interface for nodes which can be conditional on a when statement.

Class Summary
Class	Description
ElementCountConstraint	Contains method which returns various data constraints for a list-like YANG element (e.g.
SchemaPath	Represents unique path to the every node inside the module.

Enum Summary
Enum	Description
DeviateKind	Enum describing YANG deviation 'deviate' statement.
Status	Enumeration describing YANG 'status' statement.
YangStmtMapping	Mapping for both RFC6020 and RFC7950 statements.

Package org.opendaylight.yangtools.yang.model.api Description

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.Bit; BitsTypeDefinition.getBits()
case: CaseSchemaNode
choice: ChoiceSchemaNode
config: DataSchemaNode.isConfiguration()
contact: Module.getContact()
container: ContainerSchemaNode
default: TypeDefinition.getDefaultValue()
description: DocumentedNode.getDescription(); DocumentedNode.getDescription()
enum: EnumTypeDefinition.EnumPair; EnumTypeDefinition.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: LengthConstraint; LengthRestrictedTypeDefinition.getLengthConstraint()
list: ListSchemaNode
mandatory: MandatoryAware.isMandatory()
max-elements: ElementCountConstraint.getMinElements()
min-elements: ElementCountConstraint.getMaxElements()
module: Module
must: MustConstraintAware.getMustConstraints(); MustDefinition
namespace: Module.getNamespace()
notification: NotificationDefinition
ordered-by: ListSchemaNode.isUserOrdered(); LeafListSchemaNode.isUserOrdered()
organization: Module.getOrganization()
output: OperationDefinition.getOutput()
path: LeafrefTypeDefinition.getPathStatement()
pattern: PatternConstraint; StringTypeDefinition
position: BitsTypeDefinition.Bit.getPosition()
prefix: Module.getPrefix(); ModuleImport.getPrefix()
presence: ContainerSchemaNode.isPresenceContainer()
range: RangeConstraint; RangeRestrictedTypeDefinition.getRangeConstraint()
reference: DocumentedNode.getReference()
refine: RefineStatement
require-instance: RequireInstanceRestrictedTypeDefinition.requireInstance()
revision: Module.getRevision()
revision-date: ModuleImport.getRevision()
rpc: RpcDefinition
status: DocumentedNode.WithStatus.getStatus()
submodule: SubmoduleStatement
type: TypeDefinition; TypedDataSchemaNode.getType(); TypedDataSchemaNode.getType()
typedef: TypeDefinition
unique: UniqueConstraint
units: TypeDefinition.getUnits()
uses: UsesNode; DataNodeContainer.getUses()
value: EnumTypeDefinition.EnumPair.getValue()
when: WhenConditionAware.getWhenCondition()
yang-version: Module.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: ListSchemaNode.isUserOrdered()
true: Boolean.TRUE
unbounded: Not exposed
user: ListSchemaNode.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