org.opendaylight.yangtools.yang.model.api

Interface IdentitySchemaNode

All Superinterfaces:

DocumentedNode, DocumentedNode.WithStatus, SchemaNode

All Known Implementing Classes:

IdentityEffectiveStatementImpl

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
default Set<IdentitySchemaNode>	getBaseIdentities() The YANG 1.0 (RFC6020) implementation of IdentitySchemaNode always returns an ImmutableSet containing just one base identity or an empty ImmutableSet as it does not support multiple base identities.
IdentitySchemaNode	getBaseIdentity() Deprecated. use getBaseIdentities() instead.
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

getBaseIdentity

@Deprecated
IdentitySchemaNode getBaseIdentity()

Deprecated. use getBaseIdentities() instead.

Return the base identity.

Returns:

an existing identity, from which the new identity is derived or null, if the identity is defined from scratch.

getBaseIdentities

@Nonnull
default Set<IdentitySchemaNode> getBaseIdentities()

The YANG 1.0 (RFC6020) implementation of IdentitySchemaNode always returns an ImmutableSet containing just one base identity or an empty ImmutableSet as it does not support multiple base identities. Starting with YANG 1.1 (RFC7950), the identity can be derived from multiple base identities.

Returns:

set of existing identities from which the new identity is derived or an empty ImmutableSet if the identity is defined from scratch.

getDerivedIdentities

Set<IdentitySchemaNode> getDerivedIdentities()

Get identities derived from this identity.

Returns:

collection of identities derived from this identity