org.opendaylight.yangtools.yang.model.api

Interface ConstraintDefinition

All Known Implementing Classes:

EmptyConstraintDefinition

public interface ConstraintDefinition

Contains method which returns various data constraints for some YANG element (e.g. min or max number of elements). Not all constraints are allowed for all YANG element therefore if the constraint doesn't have sense for some element then the method returns null value.

Method Summary

Modifier and Type	Method and Description
Integer	getMaxElements() Returns the maximum admissible number of data elements for node where this constraint is specified.
Integer	getMinElements() Returns the minimum required number of data elements for node where this constraint is specified.
Set<MustDefinition>	getMustConstraints() Specifies the rules which the node which contains must YANG substatement has to match.
RevisionAwareXPath	getWhenCondition() Specifies the condition when the data node which contains when YANG substatement has to be present.
boolean	isMandatory() Expreses if the presence of the data element for which this constraint is specified is|isn't required.

Method Detail

getWhenCondition

RevisionAwareXPath getWhenCondition()

Specifies the condition when the data node which contains when YANG substatement has to be present. If XPath expression is evaluated as true then the data node has to be present.

Returns:

XPath expression.

getMustConstraints

Set<MustDefinition> getMustConstraints()

Specifies the rules which the node which contains must YANG substatement has to match.

Returns:

set of MustDefinition (XPath) instances which represents the concrete data constraints

isMandatory

boolean isMandatory()

Expreses if the presence of the data element for which this constraint is specified is|isn't required.

Contains the value of the mandatory YANG substatement. It is used with YANG statements leaf, choice, anyxml, deviate.

Returns:

boolean value:

• true - if mandatory YANG keyword argument = true
• false - if mandatory YANG keyword argument = false

getMinElements

@Nullable
Integer getMinElements()

Returns the minimum required number of data elements for node where this constraint is specified.

The returning value equals to value of the argument of the min-elements YANG substatement. It is used with YANG statements leaf-list, list, deviate.

Returns:

integer with minimal number of elements, or null if no minimum is defined

getMaxElements

@Nullable
Integer getMaxElements()

Returns the maximum admissible number of data elements for node where this constraint is specified.

The returning value equals to value of the argument of the max-elements YANG substatement. It is used with YANG statements leaf-list, list, deviate.

Returns:

integer with maximum number of elements, or null if no maximum is defined