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

Class ContainerLikeCompat

java.lang.Object

com.google.common.collect.ForwardingObject

org.opendaylight.yangtools.yang.model.api.ContainerLikeCompat

All Implemented Interfaces:

ActionNodeContainer, AddedByUsesAware, AugmentationTarget, ContainerLike, CopyableNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, MustConstraintAware, NotificationNodeContainer, SchemaNode, WhenConditionAware

@Beta
public abstract class ContainerLikeCompat
extends ForwardingObject
implements ContainerLike

Base class supporting OperationDefinition.toContainerLike() and NotificationDefinition.toContainerLike(). This class is exposed only for the unlikely need users of those methods need to do tricks when encountering those containers.

Nested Class Summary

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

DocumentedNode.WithStatus

Constructor Summary

Constructors

Constructor	Description
ContainerLikeCompat()

Method Summary

Modifier and Type	Method	Description
abstract @NonNull SchemaNode	delegate()
final Optional<Boolean>	effectiveConfig()	Return the effective value of config substatement, if applicable.
final Set<ActionDefinition>	getActions()	Return the set of actions.
final Optional<String>	getDescription()	Returns the value of the argument of YANG description keyword.
final Set<@NonNull MustDefinition>	getMustConstraints()	Specifies the rules which the node which contains must YANG substatement has to match.
final Set<NotificationDefinition>	getNotifications()	Return the set of notifications in this container, keyed by QName.
final QName	getQName()	Returns QName of the instance of the type SchemaNode.
final Optional<String>	getReference()	Returns the value of the argument of YANG reference keyword.
final Status	getStatus()	Returns status of the instance of the type SchemaNode.
final Set<UsesNode>	getUses()	Returns grouping nodes used ny this container.
final Optional<? extends YangXPathExpression.QualifiedBound>	getWhenCondition()	Returns when statement.
final boolean	isAddedByUses()	Deprecated, for removal: This API element is subject to removal in a future version.
final boolean	isAugmenting()	Deprecated.

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

findAction

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

getAvailableAugmentations

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

dataChildByName, findDataChildByName, findDataChildByName, findDataTreeChild, findDataTreeChild, findDataTreeChild, getChildNodes, getDataChildByName, getGroupings, getTypeDefinitions

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

isConfiguration

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

getUnknownSchemaNodes

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

findNotification

Constructor Details

ContainerLikeCompat

public ContainerLikeCompat()

Method Details

delegate

public abstract @NonNull SchemaNode delegate()

Specified by:

delegate in class ForwardingObject

getDescription

public final Optional<String> getDescription()

Description copied from interface: DocumentedNode

Returns the value of the argument of YANG description keyword.

Specified by:

getDescription in interface DocumentedNode

Returns:

string with the description, or empty if description was not provided.

getReference

public final Optional<String> getReference()

Description copied from interface: DocumentedNode

Returns the value of the argument of YANG reference keyword.

Specified by:

getReference in interface DocumentedNode

Returns:

string with reference to some other document, or empty if reference was not provided.

getStatus

public final Status getStatus()

Description copied from interface: DocumentedNode.WithStatus

Returns status of the instance of the type SchemaNode.

Specified by:

getStatus in interface DocumentedNode.WithStatus

Returns:

status of this node which represents the argument of the YANG status substatement

getQName

public final QName getQName()

Description copied from interface: SchemaNode

Returns QName of the instance of the type SchemaNode.

Specified by:

getQName in interface SchemaNode

Returns:

QName with the name of the schema node

isAugmenting

@Deprecated
public final boolean isAugmenting()

Deprecated.

Description copied from interface: CopyableNode

Returns true if this node was added by augmentation, otherwise returns false.

Specified by:

isAugmenting in interface CopyableNode

Returns:

true if this node was added by augmentation, otherwise returns false

isAddedByUses

@Deprecated(forRemoval=true)
public final boolean isAddedByUses()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: AddedByUsesAware

Returns true if this node was added by uses statement, otherwise returns false.

Specified by:

isAddedByUses in interface AddedByUsesAware

Returns:

true if this node was added by uses statement, otherwise returns false

effectiveConfig

public final Optional<Boolean> effectiveConfig()

Description copied from interface: DataSchemaNode

Return the effective value of config substatement, if applicable.

Specified by:

effectiveConfig in interface DataSchemaNode

Returns:

Effective config value, or Optional.empty() not applicable.

getActions

public final Set<ActionDefinition> getActions()

Description copied from interface: ActionNodeContainer

Return the set of actions.

Specified by:

getActions in interface ActionNodeContainer

Returns:

set of action nodes

getNotifications

public final Set<NotificationDefinition> getNotifications()

Description copied from interface: NotificationNodeContainer

Return the set of notifications in this container, keyed by QName. RFC7950 specifies that AugmentationSchemaNodes, GroupingDefinitions, ListSchemaNodes and ContainerSchemaNodes can also contain NotificationDefinitions.

Specified by:

getNotifications in interface NotificationNodeContainer

Returns:

set of notification nodes

getUses

public final Set<UsesNode> getUses()

Description copied from interface: DataNodeContainer

Returns grouping nodes used ny this container.

Specified by:

getUses in interface DataNodeContainer

Returns:

Set of all uses nodes defined within this DataNodeContainer

getMustConstraints

public final Set<@NonNull MustDefinition> getMustConstraints()

Description copied from interface: MustConstraintAware

Specifies the rules which the node which contains must YANG substatement has to match.

Specified by:

getMustConstraints in interface MustConstraintAware

Returns:

collection of MustDefinition (XPath) instances which represents the concrete data constraints

getWhenCondition

public final Optional<? extends YangXPathExpression.QualifiedBound> getWhenCondition()

Description copied from interface: WhenConditionAware

Returns when statement.

If when condition is present node defined by the parent data definition statement is only valid when the returned XPath expression conceptually evaluates to "true" for a particular instance, then the node defined by the parent data definition statement is valid; otherwise, it is not.

Specified by:

getWhenCondition in interface WhenConditionAware

Returns:

XPath condition