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

Interface ConstraintsBuilder

All Superinterfaces:

org.opendaylight.yangtools.concepts.Builder<org.opendaylight.yangtools.yang.model.api.ConstraintDefinition>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

All Known Implementing Classes:

ConstraintsBuilderImpl

public interface ConstraintsBuilder
extends org.opendaylight.yangtools.concepts.Builder<org.opendaylight.yangtools.yang.model.api.ConstraintDefinition>

Method Summary

Methods

Modifier and Type	Method and Description
void	addMustDefinition(org.opendaylight.yangtools.yang.model.api.MustDefinition must) Adds must definition to product of this builder.
void	addWhenCondition(String whenCondition) Sets when condition associated with this constraints.
int	getLine() Return line on which constraints were defined.
Integer	getMaxElements() Returns number of maximum required elements.
Integer	getMinElements() Returns number of minimum required elements.
String	getModuleName() Returns module name in which constraint is defined.
Set<org.opendaylight.yangtools.yang.model.api.MustDefinition>	getMustDefinitions() Returns must definition associated with this builder.
String	getWhenCondition() Returns when condition associated with this constraints.
boolean	isMandatory() Returns true if associated node is mandatory.
void	setMandatory(boolean mandatory) Sets mandatory status of parent node
void	setMaxElements(Integer maxElements) Sets number of maximum required elements.
void	setMinElements(Integer minElements) Sets number of minimum required elements.
org.opendaylight.yangtools.yang.model.api.ConstraintDefinition	toInstance() Build constraint definition

Method Detail

getModuleName

String getModuleName()

Returns module name in which constraint is defined.

Returns:

module name

getLine

int getLine()

Return line on which constraints were defined.

Returns:

line

getMinElements

Integer getMinElements()

Returns number of minimum required elements. 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 required elements. 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.

getMustDefinitions

Set<org.opendaylight.yangtools.yang.model.api.MustDefinition> getMustDefinitions()

Returns must definition associated with this builder.

Returns:

must definition associated with this builder.

addMustDefinition

void addMustDefinition(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.

getWhenCondition

String getWhenCondition()

Returns when condition associated with this constraints.

Returns:

when condition associated with this constraints.

addWhenCondition

void addWhenCondition(String whenCondition)

Sets when condition associated with this constraints.

Parameters:

whenCondition - when condition.

isMandatory

boolean isMandatory()

Returns true if associated node is mandatory.

Returns:

true if associated node is mandatory.

setMandatory

void setMandatory(boolean mandatory)

Sets mandatory status of parent node

Parameters:

mandatory -

toInstance

org.opendaylight.yangtools.yang.model.api.ConstraintDefinition toInstance()

Build constraint definition

Specified by:

toInstance in interface org.opendaylight.yangtools.concepts.Builder<org.opendaylight.yangtools.yang.model.api.ConstraintDefinition>

Returns:

instance of ConstraintDefinition created from this builder