Package org.opendaylight.yangtools.yang.model.api

Class ElementCountConstraint

java.lang.Object

org.opendaylight.yangtools.yang.model.api.ElementCountConstraint

@Beta
public abstract class ElementCountConstraint
extends Object

Contains method which returns various data constraints for a list-like YANG element (e.g. min or max number of elements).

Method Summary

Modifier and Type	Method	Description
static @NonNull ElementCountConstraint	atLeast(int minElements)
static @NonNull ElementCountConstraint	atMost(int maxElements)
boolean	equals(Object obj)
static @NonNull Optional<ElementCountConstraint>	forNullable(@Nullable Integer minElements, @Nullable Integer maxElements)
abstract @Nullable Integer	getMaxElements()	Returns the maximum admissible number of data elements for node where this constraint is specified.
abstract @Nullable Integer	getMinElements()	Returns the minimum required number of data elements for node where this constraint is specified.
int	hashCode()
static @NonNull ElementCountConstraint	inRange(int minElements, int maxElements)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

atLeast

public static @NonNull ElementCountConstraint atLeast(int minElements)

atMost

public static @NonNull ElementCountConstraint atMost(int maxElements)

inRange

public static @NonNull ElementCountConstraint inRange(int minElements,
                                                      int maxElements)

forNullable

public static @NonNull Optional<ElementCountConstraint> forNullable(@Nullable Integer minElements,
                                                                    @Nullable Integer maxElements)

getMinElements

public abstract @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

public abstract @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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

toString

public final String toString()

Overrides:

toString in class Object