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

Class RefineHolderImpl

java.lang.Object

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

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

All Implemented Interfaces:

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

public final class RefineHolderImpl
extends AbstractBuilder
implements RefineBuilder

Field Summary

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

addedUnknownNodes, unknownNodes

Constructor Summary

Constructors

Constructor and Description
RefineHolderImpl(String moduleName, int line, String name)

Method Summary

Methods

Modifier and Type	Method and Description
Object	build() Build YANG data model node.
boolean	equals(Object obj)
String	getDefaultStr() Returns string representation of default value or null, if default value was not refined.
String	getDescription() Returns description of resulting schema node as was defined by description statement.
Integer	getMaxElements() Returns number of maximum elements or NULL if maximum elements was not overriden.
Integer	getMinElements() Returns number of minimum required elements or NULL if minimum elements was not overriden.
org.opendaylight.yangtools.yang.model.api.MustDefinition	getMust() Returns must definition associated with this builder.
String	getReference() Get reference of this node.
org.opendaylight.yangtools.yang.model.api.Status	getStatus() Get status of this node.
String	getTargetPathString() Returns string representation of path to refine target, which is relative to grouping root This string representation does not need to contain prefixes, since parent uses element introduces elements with namespace local to parent module.
int	hashCode()
Boolean	isConfiguration() Get value of config statement.
Boolean	isMandatory() Returns mandatory state of node or NULL if state was not refined.
Boolean	isPresence() Returns presence state of refined container.
void	setConfiguration(Boolean config) Set config statement to the product.
void	setDefaultStr(String defaultStr)
void	setDescription(String description) Set description to this node.
void	setMandatory(Boolean mandatory)
void	setMaxElements(Integer maxElements) Sets number of maximum required elements.
void	setMinElements(Integer minElements) Sets number of minimum required elements.
void	setMust(org.opendaylight.yangtools.yang.model.api.MustDefinition must) Adds must definition to product of this builder.
void	setPresence(Boolean presence)
void	setReference(String reference) Set reference to this node.
void	setStatus(org.opendaylight.yangtools.yang.model.api.Status status) Set status to this node.
String	toString()

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.RefineBuilder

getLine, getModuleName, getUnknownNodes

Constructor Detail

RefineHolderImpl

public RefineHolderImpl(String moduleName,
                int line,
                String name)

Method Detail

getDefaultStr

public String getDefaultStr()

Description copied from interface: RefineBuilder

Returns string representation of default value or null, if default value was not refined.

Specified by:

getDefaultStr in interface RefineBuilder

Returns:

string representation of default value or null, if default value was not refined.

setDefaultStr

public void setDefaultStr(String defaultStr)

getDescription

public String getDescription()

Description copied from interface: DocumentedNodeBuilder

Returns description of resulting schema node as was defined by description statement.

Specified by:

getDescription in interface DocumentedNodeBuilder

Returns:

description statement

setDescription

public void setDescription(String description)

Description copied from interface: DocumentedNodeBuilder

Set description to this node.

Specified by:

setDescription in interface DocumentedNodeBuilder

getReference

public String getReference()

Description copied from interface: DocumentedNodeBuilder

Get reference of this node.

Specified by:

getReference in interface DocumentedNodeBuilder

Returns:

reference statement

setReference

public void setReference(String reference)

Description copied from interface: DocumentedNodeBuilder

Set reference to this node.

Specified by:

setReference in interface DocumentedNodeBuilder

isConfiguration

public Boolean isConfiguration()

Description copied from interface: RefineBuilder

Get value of config statement.

Specified by:

isConfiguration in interface RefineBuilder

Returns:

value of config statement

setConfiguration

public void setConfiguration(Boolean config)

Description copied from interface: RefineBuilder

Set config statement to the product.

Specified by:

setConfiguration in interface RefineBuilder

Parameters:

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

isMandatory

public Boolean isMandatory()

Description copied from interface: RefineBuilder

Returns mandatory state of node or NULL if state was not refined.

Specified by:

isMandatory in interface RefineBuilder

Returns:

mandatory state of node or NULL if state was not refined.

setMandatory

public void setMandatory(Boolean mandatory)

Specified by:

setMandatory in interface RefineBuilder

isPresence

public Boolean isPresence()

Description copied from interface: RefineBuilder

Returns presence state of refined container.

Specified by:

isPresence in interface RefineBuilder

Returns:

Presence state of refined container.

setPresence

public void setPresence(Boolean presence)

Specified by:

setPresence in interface RefineBuilder

getMust

public org.opendaylight.yangtools.yang.model.api.MustDefinition getMust()

Description copied from interface: RefineBuilder

Returns must definition associated with this builder.

Specified by:

getMust in interface RefineBuilder

Returns:

must definition associated with this builder.

setMust

public void setMust(org.opendaylight.yangtools.yang.model.api.MustDefinition must)

Description copied from interface: RefineBuilder

Adds must definition to product of this builder.

Specified by:

setMust in interface RefineBuilder

Parameters:

must - must definition which should be associated with parent node.

getMinElements

public Integer getMinElements()

Description copied from interface: RefineBuilder

Returns number of minimum required elements or NULL if minimum elements was not overriden. This constraint has meaning only if associated node is list or leaf-list.

Specified by:

getMinElements in interface RefineBuilder

Returns:

number of minimum required elements.

setMinElements

public void setMinElements(Integer minElements)

Description copied from interface: RefineBuilder

Sets number of minimum required elements. This constraint has meaning only if associated node is list or leaf-list.

Specified by:

setMinElements in interface RefineBuilder

Parameters:

minElements - number of minimum required elements.

getMaxElements

public Integer getMaxElements()

Description copied from interface: RefineBuilder

Returns number of maximum elements or NULL if maximum elements was not overriden. This constraint has meaning only if associated node is list or leaf-list.

Specified by:

getMaxElements in interface RefineBuilder

Returns:

number of maximum required elements.

setMaxElements

public void setMaxElements(Integer maxElements)

Description copied from interface: RefineBuilder

Sets number of maximum required elements. This constraint has meaning only if associated node is list or leaf-list.

Specified by:

setMaxElements in interface RefineBuilder

Parameters:

maxElements - number of maximum required elements.

toString

public String toString()

Overrides:

toString in class Object

getStatus

public org.opendaylight.yangtools.yang.model.api.Status getStatus()

Description copied from interface: DocumentedNodeBuilder

Get status of this node.

Specified by:

getStatus in interface DocumentedNodeBuilder

Returns:

status statement

setStatus

public void setStatus(org.opendaylight.yangtools.yang.model.api.Status status)

Description copied from interface: DocumentedNodeBuilder

Set status to this node.

Specified by:

setStatus in interface DocumentedNodeBuilder

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

build

public Object build()

Description copied from interface: Builder

Build YANG data model node. This method should create an instance of YANG data model node. After creating an instance, this instance should be returned for each call without repeating build process.

Specified by:

build in interface Builder

Returns:

YANG data model node

getTargetPathString

public String getTargetPathString()

Description copied from interface: RefineBuilder

Returns string representation of path to refine target, which is relative to grouping root This string representation does not need to contain prefixes, since parent uses element introduces elements with namespace local to parent module.

Specified by:

getTargetPathString in interface RefineBuilder

Returns:

string representation of path to refine target, which is relative to grouping root