org.opendaylight.yangtools.yang.parser.builder.impl

Class ChoiceBuilder

java.lang.Object

org.opendaylight.yangtools.yang.parser.builder.util.AbstractBuilder

org.opendaylight.yangtools.yang.parser.builder.util.AbstractSchemaNodeBuilder

org.opendaylight.yangtools.yang.parser.builder.impl.ChoiceBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>, AugmentationTargetBuilder, Builder, DataSchemaNodeBuilder, DocumentedNodeBuilder, GroupingMember, SchemaNodeBuilder

public final class ChoiceBuilder
extends AbstractSchemaNodeBuilder
implements DataSchemaNodeBuilder, AugmentationTargetBuilder

Field Summary

Fields inherited from class org.opendaylight.yangtools.yang.parser.builder.util.AbstractSchemaNodeBuilder

description, qname, reference, schemaPath, status

Fields inherited from class org.opendaylight.yangtools.yang.parser.builder.util.AbstractBuilder

addedUnknownNodes, unknownNodes

Constructor Summary

Constructors

Constructor and Description
ChoiceBuilder(String moduleName, int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path)
ChoiceBuilder(String moduleName, int line, org.opendaylight.yangtools.yang.common.QName qname, org.opendaylight.yangtools.yang.model.api.SchemaPath path, org.opendaylight.yangtools.yang.model.api.ChoiceNode base)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAugmentation(AugmentationSchemaBuilder augment) Add augment, which points to this node.
void	addCase(DataSchemaNodeBuilder caseNode) Add case node to this choice.
org.opendaylight.yangtools.yang.model.api.ChoiceNode	build() Build DataSchemaNode object from this builder.
boolean	equals(Object obj)
List<AugmentationSchemaBuilder>	getAugmentationBuilders()
ChoiceCaseBuilder	getCaseNodeByName(String caseName) Get case by name.
Set<ChoiceCaseBuilder>	getCases()
ConstraintsBuilder	getConstraints() Get constraints of this builder.
String	getDefaultCase()
ChoiceBuilder	getOriginal() Get original builder definition from grouping, where it is defined.
int	hashCode()
boolean	isAddedByUses()
boolean	isAugmenting() Returns true if product of this builder is added by augmentation.
boolean	isConfiguration() Get value of config statement.
void	setAddedByUses(boolean addedByUses) Set if this node is added by uses.
void	setAugmenting(boolean augmenting) Set if the product of the builder node is introduced by augmentation.
void	setConfiguration(boolean configuration) Set config statement to the product.
void	setDefaultCase(String defaultCase)
void	setOriginal(SchemaNodeBuilder builder) Set original builder definition from grouping
String	toString()

Methods inherited from class org.opendaylight.yangtools.yang.parser.builder.util.AbstractSchemaNodeBuilder

getDescription, getPath, getQName, getReference, getStatus, setDescription, setPath, setReference, setStatus

Methods inherited from class org.opendaylight.yangtools.yang.parser.builder.util.AbstractBuilder

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getPath, getQName, setPath

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

getDescription, getReference, getStatus, setDescription, setReference, setStatus

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

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

Constructor Detail

ChoiceBuilder

public ChoiceBuilder(String moduleName,
             int line,
             org.opendaylight.yangtools.yang.common.QName qname,
             org.opendaylight.yangtools.yang.model.api.SchemaPath path)

ChoiceBuilder

public ChoiceBuilder(String moduleName,
             int line,
             org.opendaylight.yangtools.yang.common.QName qname,
             org.opendaylight.yangtools.yang.model.api.SchemaPath path,
             org.opendaylight.yangtools.yang.model.api.ChoiceNode base)

Method Detail

build

public org.opendaylight.yangtools.yang.model.api.ChoiceNode build()

Description copied from interface: DataSchemaNodeBuilder

Build DataSchemaNode object from this builder.

Specified by:

build in interface Builder

Specified by:

build in interface DataSchemaNodeBuilder

Specified by:

build in interface SchemaNodeBuilder

Returns:

instance of DataSchemaNode based on the state present in this builder.

getCases

public Set<ChoiceCaseBuilder> getCases()

getCaseNodeByName

public ChoiceCaseBuilder getCaseNodeByName(String caseName)

Get case by name.

Parameters:

caseName - name of case to search

Returns:

case with given name if present, null otherwise

addCase

public void addCase(DataSchemaNodeBuilder caseNode)

Add case node to this choice. If node is not declared with 'case' keyword, create new case builder and make this node child of newly created case.

Parameters:

caseNode - case node

isAugmenting

public boolean isAugmenting()

Description copied from interface: DataSchemaNodeBuilder

Returns true if product of this builder is added by augmentation.

Specified by:

isAugmenting in interface DataSchemaNodeBuilder

Returns:

true, if this node is added by augmentation, false otherwise

setAugmenting

public void setAugmenting(boolean augmenting)

Description copied from interface: DataSchemaNodeBuilder

Set if the product of the builder node is introduced by augmentation.

Specified by:

setAugmenting in interface DataSchemaNodeBuilder

isAddedByUses

public boolean isAddedByUses()

Specified by:

isAddedByUses in interface GroupingMember

Returns:

true, if this node is added by uses statement, false otherwise

setAddedByUses

public void setAddedByUses(boolean addedByUses)

Description copied from interface: GroupingMember

Set if this node is added by uses.

Specified by:

setAddedByUses in interface GroupingMember

getOriginal

public ChoiceBuilder getOriginal()

Description copied from interface: DataSchemaNodeBuilder

Get original builder definition from grouping, where it is defined.

Specified by:

getOriginal in interface DataSchemaNodeBuilder

Returns:

original builder definition from grouping if this node is added by uses, null otherwise

setOriginal

public void setOriginal(SchemaNodeBuilder builder)

Description copied from interface: DataSchemaNodeBuilder

Set original builder definition from grouping

Specified by:

setOriginal in interface DataSchemaNodeBuilder

Parameters:

builder - original builder definition from grouping

isConfiguration

public boolean isConfiguration()

Description copied from interface: DataSchemaNodeBuilder

Get value of config statement.

Specified by:

isConfiguration in interface DataSchemaNodeBuilder

Returns:

value of config statement

setConfiguration

public void setConfiguration(boolean configuration)

Description copied from interface: DataSchemaNodeBuilder

Set config statement to the product.

Specified by:

setConfiguration in interface DataSchemaNodeBuilder

Parameters:

configuration - true if config true was set, false if config false was set.

getConstraints

public ConstraintsBuilder getConstraints()

Description copied from interface: DataSchemaNodeBuilder

Get constraints of this builder.

Specified by:

getConstraints in interface DataSchemaNodeBuilder

Returns:

constraints of this builder

addAugmentation

public void addAugmentation(AugmentationSchemaBuilder augment)

Description copied from interface: AugmentationTargetBuilder

Add augment, which points to this node.

Specified by:

addAugmentation in interface AugmentationTargetBuilder

Parameters:

augment - augment which points to this node

getAugmentationBuilders

public List<AugmentationSchemaBuilder> getAugmentationBuilders()

getDefaultCase

public String getDefaultCase()

setDefaultCase

public void setDefaultCase(String defaultCase)

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSchemaNodeBuilder

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractSchemaNodeBuilder

toString

public String toString()

Overrides:

toString in class Object