org.opendaylight.yangtools.yang.model.api

Interface IdentitySchemaNode

All Superinterfaces:

DocumentedNode, DocumentedNode.WithStatus, SchemaNode

public interface IdentitySchemaNode
extends SchemaNode

Interface describing YANG 'identity' statement.

The 'identity' statement is used to define a new globally unique, abstract, and untyped identity. Its only purpose is to denote its name, semantics, and existence. The built-in datatype "identityref" can be used to reference identities within a data model.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method and Description
@NonNull Set<IdentitySchemaNode>	getBaseIdentities() Return base identities of this identity.
@NonNull Set<IdentitySchemaNode>	getDerivedIdentities() Get identities derived from this identity.

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.SchemaNode

getPath, getQName

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus

getStatus

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

getDescription, getReference, getUnknownSchemaNodes

Method Detail

getBaseIdentities

@NonNull Set<IdentitySchemaNode> getBaseIdentities()

Return base identities of this identity. The semantics of differ between RFC6020 and RFC7950 here. YANG 1.0 uses single inheritance, where there can be 0..1 base identities. YANG 1.1 uses multiple inheritance, where there can be 0..N base identities.

Callers should be prepared to handle multiple base identities.

Returns:

set of existing identities from which the new identity is derived or an empty Set if the identity is a root identity.

getDerivedIdentities

@NonNull Set<IdentitySchemaNode> getDerivedIdentities()

Get identities derived from this identity.

Returns:

collection of identities derived from this identity