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

Interface RefineBuilder

All Superinterfaces:

DocumentedNodeBuilder

All Known Implementing Classes:

RefineHolderImpl

public interface RefineBuilder
extends DocumentedNodeBuilder

Mutable holder for information contained in refine Represents a local change to node introduced by uses statement e.g. change in documentation, configuration or properties.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultStr() Returns string representation of default value or null, if default value was not refined.
int	getLine() Line on which element was defined.
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.
String	getModuleName() Returns module (source) name in which refine statement was defined.
org.opendaylight.yangtools.yang.model.api.MustDefinition	getMust() Returns must definition associated with this builder.
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.
List<UnknownSchemaNodeBuilder>	getUnknownNodes() Returns list of unknown schema node builders, which are associated with refine statement.
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	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)

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

getDescription, getReference, getStatus, setDescription, setReference, setStatus

Method Detail

isConfiguration

Boolean isConfiguration()

Get value of config statement.

Returns:

value of config statement

setConfiguration

void setConfiguration(Boolean config)

Set config statement to the product.

Parameters:

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

isMandatory

Boolean isMandatory()

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

Returns:

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

setMandatory

void setMandatory(Boolean mandatory)

isPresence

Boolean isPresence()

Returns presence state of refined container.

Returns:

Presence state of refined container.

setPresence

void setPresence(Boolean presence)

getMust

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

Returns must definition associated with this builder.

Returns:

must definition associated with this builder.

setMust

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

Adds must definition to product of this builder.

Parameters:

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

getMinElements

Integer getMinElements()

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.

Returns:

number of minimum required elements.

setMinElements

void setMinElements(Integer minElements)

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

Parameters:

minElements - number of minimum required elements.

getMaxElements

Integer getMaxElements()

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.

Returns:

number of maximum required elements.

setMaxElements

void setMaxElements(Integer maxElements)

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

Parameters:

maxElements - number of maximum required elements.

getTargetPathString

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.

Returns:

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

getModuleName

String getModuleName()

Returns module (source) name in which refine statement was defined.

Returns:

module (source) name in which refine statement was defined.

getLine

int getLine()

Line on which element was defined.

Returns:

Line on which element was defined.

getUnknownNodes

List<UnknownSchemaNodeBuilder> getUnknownNodes()

Returns list of unknown schema node builders, which are associated with refine statement.

Returns:

Set of unknown schema node builders.

getDefaultStr

String getDefaultStr()

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

Returns:

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