org.opendaylight.yangtools.yang.parser.builder.api

Interface AugmentationSchemaBuilder

All Superinterfaces:

Builder, DataNodeContainerBuilder, DocumentedNodeBuilder, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

All Known Implementing Classes:

AugmentationSchemaBuilderImpl

public interface AugmentationSchemaBuilder
extends DataNodeContainerBuilder, DocumentedNodeBuilder

Builder for AugmentationSchema, which represents 'augment' statement.

Method Summary

Methods

Modifier and Type	Method and Description
void	addWhenCondition(String whenCondition) Adds string representation of when condition.
org.opendaylight.yangtools.yang.model.api.AugmentationSchema	build() Returns an instance of product - DataNodeContainer Returns an instance of data node container with children and properties constructed as per this builder state, all nested builders are also built and their product is set to DataNodeContainer.
int	getOrder() Returns position of defining augment statement as was present in schema source.
org.opendaylight.yangtools.yang.model.api.SchemaPath	getTargetPath() Get path to target node.
String	getTargetPathAsString() Returns target path representation as was present in schema source.
String	getWhenCondition() Returns when condition 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.
boolean	isResolved() Get information about augmentation process.
void	setResolved(boolean resolved) Set information about augmentation process.

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.DataNodeContainerBuilder

addChildNode, addChildNode, addChildNode, addChildNodeToContext, addGrouping, addTypedef, addUsesNode, getChildNodeBuilders, getChildNodes, getDataChildByName, getGroupingBuilders, getGroupings, getPath, getQName, getTypeDefinitionBuilders, getTypeDefinitions, getUsesNodeBuilders

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.Builder

addUnknownNodeBuilder, getLine, getModuleName, getParent, getUnknownNodes, setModuleName, setParent

Methods inherited from interface org.opendaylight.yangtools.yang.parser.builder.api.DocumentedNodeBuilder

getDescription, getReference, getStatus, setDescription, setReference, setStatus

Method Detail

getWhenCondition

String getWhenCondition()

Returns when condition 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.

Returns:

when condition as string

addWhenCondition

void addWhenCondition(String whenCondition)

Adds string representation of when condition. 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.

Parameters:

whenCondition -

getTargetPathAsString

String getTargetPathAsString()

Returns target path representation as was present in schema source.

Returns:

path to target node as String

getTargetPath

org.opendaylight.yangtools.yang.model.api.SchemaPath getTargetPath()

Get path to target node.

Note that individual parts of path contain only prefix relative to current context and name of node.

Returns:

path to target node as SchemaPath

build

org.opendaylight.yangtools.yang.model.api.AugmentationSchema build()

Description copied from interface: DataNodeContainerBuilder

Returns an instance of product - DataNodeContainer Returns an instance of data node container with children and properties constructed as per this builder state, all nested builders are also built and their product is set to DataNodeContainer.

Specified by:

build in interface Builder

Specified by:

build in interface DataNodeContainerBuilder

Returns:

Instance of DataNodeContainer

isResolved

boolean isResolved()

Get information about augmentation process.

Returns:

true, if augmentation process was performed already, false otherwise

setResolved

void setResolved(boolean resolved)

Set information about augmentation process.

Parameters:

resolved -

getOrder

int getOrder()

Returns position of defining augment statement as was present in schema source.

Returns:

Position of definiing augment statement in source code.