Uses of Interface
org.opendaylight.yangtools.concepts.Immutable
Package
Description
Concepts used widely across OpenDaylight code base.
YANG metamodel extensions to support OpenDaylight extensions as defined in yang-ext.yang.
YANG parser support for metamodel extensions defined in
OpenConfig.
API exposed by generator plugins, i.e.
YANG metamodel extensions to support NETCONF, filters as defined in
RFC6241.
YANG metamodel extensions to support NACM, as defined in RFC6536.
YANG metamodel extensions to support metadata, as defined in
RFC7952.
YANG metamodel extensions to support mount-poing, as defined in
RFC8528.
Various utility classes.
Common YANG concepts and constants expressed in terms of Java.
Definition of normalized YANG DOM Model.
Intermediate representation of a YANG file.
Definition of structures and DOM like API of effected YANG schema.
Meta model of YANG model as was defined in RFC6020 and extracted by analysis
of YANG text.
Utility classes and implementations for concepts defined in yang-model-api.
YANG parser public API.
Statement library for YANG version 1 and 1.1, as defined in RFC6020 and RFC7950.
Provides base abstract classes, interfaces and common implementation used by the statement parser.
Provides API necessary for the processing of statement sources.
Contains the implementation of the parser reactor
CrossSourceStatementReactor
.Model of a RFC7950 XPath Expression.
-
Uses of Immutable in org.opendaylight.yangtools.concepts
Modifier and TypeInterfaceDescriptioninterface
HierarchicalIdentifier<T extends HierarchicalIdentifier<T>>
AnIdentifier
tied to some tree-like structure, similar to howPath
is tied to a conceptual file system.interface
General identifier interface.interface
A combination of bothIdentifier
andWritableObject
.Modifier and TypeClassDescriptionclass
CheckedValue<T,
E extends Exception> Utility holder similar toOptional
, except the empty case contains an Exception, which should be reported, for example via throwing it.class
Either<T,
U> Utility holder of a two-variant value.final class
NoOpListenerRegistration<T extends EventListener>
Implementation ofListenerRegistration
which does nothing in itsNoOpObjectRegistration.close()
method.class
Implementation ofObjectRegistration
which does nothing in itsNoOpObjectRegistration.close()
method. -
Uses of Immutable in org.opendaylight.yangtools.odlext.model.api
-
Uses of Immutable in org.opendaylight.yangtools.openconfig.model.api
-
Uses of Immutable in org.opendaylight.yangtools.plugin.generator.api
Modifier and TypeInterfaceDescriptioninterface
The contents of a generated file and itsGeneratedFileLifecycle
.Modifier and TypeClassDescriptionclass
Abstract base class forGeneratedFile
s.class
The contents of a generated file and itsGeneratedFileLifecycle
. -
Uses of Immutable in org.opendaylight.yangtools.rfc6241.model.api
-
Uses of Immutable in org.opendaylight.yangtools.rfc6536.model.api
-
Uses of Immutable in org.opendaylight.yangtools.rfc6643.model.api
Modifier and TypeClassDescriptionenum
final class
An OID, or ObjectIdentifier, as defined by ITU and ISO/IEC. -
Uses of Immutable in org.opendaylight.yangtools.rfc7952.model.api
Modifier and TypeInterfaceDescriptioninterface
ASchemaContext
which is alsoAnnotationSchemaNodeAware
. -
Uses of Immutable in org.opendaylight.yangtools.rfc8040.model.api
-
Uses of Immutable in org.opendaylight.yangtools.rfc8528.model.api
-
Uses of Immutable in org.opendaylight.yangtools.rfc8639.model.api
-
Uses of Immutable in org.opendaylight.yangtools.rfc8819.model.api
-
Uses of Immutable in org.opendaylight.yangtools.util
Modifier and TypeInterfaceDescriptioninterface
UnmodifiableMapPhase<K,
V> AMap
which cannot be modified and supports efficient conversion to aModifiableMapPhase
.Modifier and TypeClassDescriptionclass
An abstractIdentifier
backed by an immutable object.class
AbstractStringIdentifier<T extends AbstractStringIdentifier<T>>
UtilityIdentifier
backed by aUUID
.class
AbstractUUIDIdentifier<T extends AbstractUUIDIdentifier<T>>
UtilityIdentifier
backed by aUUID
.final class
EmptyDeque<E>
A specialized always-empty implementation ofDeque
.class
Template for instantiatingUnmodifiableMapPhase
instances with a fixed set of keys.class
ImmutableOffsetMap<K,
V> Implementation of theMap
interface which stores a set of immutable mappings using a key-to-offset map and a backing array.class
Template for instantiatingImmutableOffsetMap
instances with a fixed set of keys.class
SharedSingletonMap<K,
V> Implementation of theMap
interface which stores a single mapping.class
Template for instantiatingSharedSingletonMap
instances with a fixed key.class
SingletonSet<E>
ASet
containing a single value.final class
UnmodifiableMap<K,
V> An unmodifiable view over aMap
. -
Uses of Immutable in org.opendaylight.yangtools.yang.common
Modifier and TypeInterfaceDescriptioninterface
CanonicalValue<T extends CanonicalValue<T>>
A typed value in its internal Java representation.interface
CanonicalValueSupport<T extends CanonicalValue<T>>
Support for aCanonicalValue
subclasses.interface
CanonicalValueValidator<T extends CanonicalValue<T>,
V extends T> CanonicalValue
validator interface.interface
Interface for mapping betweenString
prefixes andQNameModule
namespaces.Modifier and TypeClassDescriptionclass
AbstractCanonicalValueSupport<T extends CanonicalValue<T>>
Base implementation ofCanonicalValueSupport
.class
AbstractCanonicalValueValidator<T extends DerivedString<T>,
V extends T> Abstract base class for implementing validators.class
Abstract superclass for sharing QName references, which can either be resolvedQName
s or unresolvedUnresolvedQName.Unqualified
andUnresolvedQName.Qualified
s.final record
Name of an individual YANG annotation, as defined in RFC7952.final class
A BiMap-based implementation ofYangNamespaceContext
.class
CachingDerivedString<T extends CachingDerivedString<T>>
A opportunistically-cachingDerivedString
.class
A violation of aCanonicalValue
validation.static class
static class
class
Dedicated type for YANG's 'type decimal64' type.static final class
class
DerivedString<T extends DerivedString<T>>
Abstract base class for objects which are string-equivalent to canonical string representation specified in a YANG model.final class
Dedicated singleton type for YANG'stype empty
value.final record
The name (label) of a YANG schema mount instance, as defined in RFC8528.final class
The QName from XML consists of local name of element and XML namespace, but for our use, we added module revision to it.final class
AXMLNamespace
bound to a particular modelRevision
.final class
Dedicated object identifying a YANG module revision.class
Dedicated type for YANG'stype uint16
type.static final class
class
Dedicated type for YANG'stype uint32
type.static final class
class
Dedicated type for YANG'stype uint64
type.static final class
class
Dedicated type for YANG'stype uint8
type.static final class
class
AQName
equivalent which has not been resolved.static final class
An unresolved, qualifiedQName
.static final class
An unresolved, unqualifiedQName
.final class
A simple type capture ofnamespace
statement's argument according to RFC6020.final record
Identifier of a RESTCONFyang-data
extension template instantiation. -
Uses of Immutable in org.opendaylight.yangtools.yang.data.api
Modifier and TypeClassDescriptionfinal class
Identifier of a RFC8342 (NMDA) datastore.class
Unique identifier of a particular node instance in the data tree.static final class
Simple path argument identifying aContainerNode
orLeafNode
leaf in particular subtree.static class
Composite path argument identifying aMapEntryNode
leaf overall data tree.static final class
static final class
Simple path argument identifying aLeafSetEntryNode
leaf overall data tree.static class
Path argument / component of InstanceIdentifier. -
Uses of Immutable in org.opendaylight.yangtools.yang.data.api.schema
Modifier and TypeInterfaceDescriptioninterface
A piece ofNormalizedAnydata
with a corresponding piece ofNormalizedMetadata
.interface
The contents of ananydata
node in a normalized format.interface
RFC7952 metadata counterpart to aNormalizedNode
.interface
Normalized representation of a YANG mount point.interface
RFC8528 mount point counterpart to aNormalizedNode
structure.interface
A tuple of normalizedNormalizedTuple.data()
, with correspondingNormalizedTuple.metadata()
andNormalizedTuple.mountPoints()
. -
Uses of Immutable in org.opendaylight.yangtools.yang.data.api.schema.stream
Modifier and TypeClassDescriptionfinal record
The result of aNormalizedNodeStreamWriter
stream, i.e. -
Uses of Immutable in org.opendaylight.yangtools.yang.data.impl.schema
Modifier and TypeClassDescriptionclass
Immutable implementation ofNormalizedMetadata
.final record
An immutableNormalizedMountPoint
.class
Immutable implementation ofNormalizedMountpoints
. -
Uses of Immutable in org.opendaylight.yangtools.yang.data.impl.schema.builder.impl
Modifier and TypeClassDescriptionprotected static final class
protected static final class
protected static final class
protected static final class
protected static final class
protected static final class
protected static final class
protected static final class
-
Uses of Immutable in org.opendaylight.yangtools.yang.data.impl.schema.nodes
Modifier and TypeClassDescriptionclass
AbstractImmutableDataContainerNode<K extends YangInstanceIdentifier.PathArgument,
N extends DataContainerNode> class
AbstractImmutableNormalizedSimpleValueNode<K extends YangInstanceIdentifier.PathArgument,
N extends NormalizedNode, V> class
AbstractImmutableNormalizedValueNode<K extends YangInstanceIdentifier.PathArgument,
N extends NormalizedNode, V> -
Uses of Immutable in org.opendaylight.yangtools.yang.data.spi.node
Modifier and TypeClassDescriptionclass
AbstractNormalizedNode<I extends YangInstanceIdentifier.PathArgument,
T extends NormalizedNode> Abstract base class forNormalizedNode
implementations.final class
-
Uses of Immutable in org.opendaylight.yangtools.yang.data.tree.api
-
Uses of Immutable in org.opendaylight.yangtools.yang.data.tree.impl.node
Modifier and TypeClassDescriptionfinal class
The concept of a version, either node version, or a subtree version. -
Uses of Immutable in org.opendaylight.yangtools.yang.data.tree.leafref
-
Uses of Immutable in org.opendaylight.yangtools.yang.data.util
Modifier and TypeClassDescriptionprotected static final record
Definition of a MountPoint, as known to RFC8528. -
Uses of Immutable in org.opendaylight.yangtools.yang.ir
Modifier and TypeClassDescriptionclass
static final class
An argument composed of multiple concatenated parts.static class
An argument composed of a single string.class
static final class
static final class
class
A single YANG statement in its raw string form. -
Uses of Immutable in org.opendaylight.yangtools.yang.model.api
Modifier and TypeInterfaceDescriptioninterface
EffectiveStatement
-based result of YANG parser compilation.interface
A base class of anEffectiveModelContext
context reasoning with regards to what logical sequence ofEffectiveStatement
s were considered.interface
This interface contains the methods for getting the data from the YANG module.interface
This interface contains common methods for getting the schema contents from a YANG module or submodule.interface
An expression as defined in RFC7950 Section 9.9.2, i.e.interface
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...interface
AnEffectiveStatementInference
consisting purely of steps along theschema tree
axis, so that it represents aschema tree node
based on resolution ofabsolute-schema-nodeid
as specified by RFC7950 section 6.5.interface
This interface contains the methods for getting the data from the YANG submodule.Modifier and TypeClassDescriptionenum
Mapping for both RFC6020 and RFC7950 statements. -
Uses of Immutable in org.opendaylight.yangtools.yang.model.api.meta
Modifier and TypeInterfaceDescriptioninterface
ADeclarationReference
to something which resembles file.interface
ADeclarationReference
to a position within a some text document.interface
Reference to a statement declaration.interface
Definition / model of YANGDeclaredStatement
andEffectiveStatement
.Modifier and TypeClassDescriptionclass
Abstract utility class to handle StatementArgumentDefinition aspect ofStatementDefinition
.class
Definition of an argument to a YANG statement.final class
DefaultStatementDefinition<A,
D extends DeclaredStatement<A>, E extends EffectiveStatement<A, D>> Default implementation of theStatementDefinition
contract. -
Uses of Immutable in org.opendaylight.yangtools.yang.model.api.stmt
Modifier and TypeClassDescriptionclass
A set of features.class
A resolvedif-feature
expression, implementing aPredicate
.final class
An intermediate capture of the argument topattern
statement.class
Represents unique path to every schema node inside the schema node identifier namespace.static class
An absolute schema node identifier.static class
A descendant schema node identifier.class
-
Uses of Immutable in org.opendaylight.yangtools.yang.model.export
Modifier and TypeClassDescriptionfinal class
Utility class for formattingDeclaredStatement
s.final class
A YANG text snippet generated from aDeclaredStatement
. -
Uses of Immutable in org.opendaylight.yangtools.yang.model.repo.api
Modifier and TypeInterfaceDescriptioninterface
Common interface for schema source representations.interface
A YANGSchemaSourceRepresentation
.interface
A YINSchemaSourceRepresentation
.interface
YIN text schema source representation.Modifier and TypeClassDescriptionfinal class
SchemaContextFactory configuration class.final record
Base class of YANG Schema source identifiers.class
AYangTextSchemaSource
with content readily available.final class
class
YANG text schema source representation.class
UtilityYinXmlSchemaSource
exposing a W3CDOMSource
representation of YIN model.class
YIN text schema source representation. -
Uses of Immutable in org.opendaylight.yangtools.yang.model.spi
Modifier and TypeClassDescriptionclass
AbstractEffectiveStatementInference<T extends EffectiveStatement<?,
?>> A simple capture of anAbstractEffectiveModelContextProvider
andEffectiveStatementInference
s.static class
AbstractEffectiveStatementInference.WithPath<T extends EffectiveStatement<?,
?>> A simple capture of anAbstractEffectiveStatementInference
and a list ofEffectiveStatement
s.class
Convenience base class forPathExpression
implementations.class
final class
Default implementation of a aSchemaTreeInference
.class
Simple subclass ofAbstractSchemaContext
which performs some amount of indexing to speed up common SchemaContext operations. -
Uses of Immutable in org.opendaylight.yangtools.yang.model.util
Modifier and TypeClassDescriptionfinal class
final class
UtilityYangNamespaceContext
backed by a SchemaContext, resolving namespaces to their module names.static final class
Semantic binding ofEffectiveStatementInference
produced bySchemaInferenceStack
. -
Uses of Immutable in org.opendaylight.yangtools.yang.parser.api
Modifier and TypeClassDescriptionfinal class
A configuration ofYangParser
wiring for use withYangParserFactory
. -
Uses of Immutable in org.opendaylight.yangtools.yang.parser.rfc7950.stmt
Modifier and TypeClassDescriptionclass
AbstractEffectiveModule<D extends DeclaredStatement<UnresolvedQName.Unqualified>,
E extends DataTreeAwareEffectiveStatement<UnresolvedQName.Unqualified, D>> -
Uses of Immutable in org.opendaylight.yangtools.yang.parser.spi.meta
Modifier and TypeInterfaceDescriptioninterface
Effective view of aStmtContext
for the purposes of creating anEffectiveStatement
.static interface
EffectiveStmtCtx.Current<A,
D extends DeclaredStatement<A>> Minimum amount of state required to build an accurate effective view of a statement.static interface
Minimum amount of parent state required to build an accurate effective view of a particular child.static interface
EffectiveStmtCtx.UndeclaredCurrent<A,
D extends DeclaredStatement<A>> A restricted version ofEffectiveStmtCtx.Current
, which does not expose the raw argument or the declared statement.Modifier and TypeClassDescriptionclass
Significant state captured by anEffectiveStatement
at its instantiation site.final class
ParserNamespace<K,
V> ParserNamespace
serves as common superclass for namespaces used during parser operation.final class
SimpleEffectiveStatementState
for use with typicalSchemaTreeEffectiveStatement
s.static class
StatementSupport.StatementPolicy<A,
D extends DeclaredStatement<A>> A baseline class for implementing theStatementFactory.canReuseCurrent(Current, Current, List)
contract in a manner which is consistent with a statement'sStatementSupport.CopyPolicy
.final class
-
Uses of Immutable in org.opendaylight.yangtools.yang.parser.spi.source
Modifier and TypeClassDescriptionclass
Reference of statement source present in textual source format.final class
An implicit sub-statement, which is implied to be always present in its parent, even if it does not appear in model source.class
Reference of statement source. -
Uses of Immutable in org.opendaylight.yangtools.yang.parser.stmt.reactor
-
Uses of Immutable in org.opendaylight.yangtools.yang.xpath.api
Modifier and TypeInterfaceDescriptioninterface
An object referencing a QName, either resolved or unresolved.interface
AQNameReferent
referencing a resolved QName.interface
AQNameReferent
referencing an unresolved QName.interface
Common interface for all YANG XPath constant expressions.interface
Common base interface for all YANG Expression components.interface
An XPath expression.static interface
A Qualified-bound expression.static interface
An Unqualified-bound expression.Modifier and TypeClassDescriptionclass
A binary expression formed of aYangBinaryExpr.getLeftExpr()
, anYangBinaryExpr.getOperator()
and aYangBinaryExpr.getRightExpr()
.enum
Expressions which evaluate to a logicaltrue
orfalse
.class
class
Function call invocation.final class
An XPath literal expression.class
static final class
static class
A step along an axis.static final class
static class
static class
final class
AYangExpr
combining aYangNaryOperator
with a set of expressions.final class
class
A number-bearing expression.class
class
An XPath QName expression.static final class
static final class
final class