Record Class ParameterConstraint

java.lang.Object

java.lang.Record

zeroecho.core.ParameterConstraint

Record Components:

name - parameter name

kind - value kind

required - whether omission without a default is rejected

defaultValue - optional default

allowedValues - ordered allowed values, or an empty list

minimum - optional inclusive integer lower bound

maximum - optional inclusive integer upper bound

step - positive integer modulus

remainder - required nonnegative remainder smaller than step

public record ParameterConstraint(String name, ParameterConstraint.ValueKind kind, boolean required, Object defaultValue, List<?> allowedValues, Long minimum, Long maximum, long step, long remainder)
extends Record

Immutable machine-readable validation for one template argument. Numeric bounds are inclusive; an integer must satisfy floorMod(value, step) == remainder. Empty choices mean unrestricted values of the declared kind. Null defaults mean no default. Only immutable scalar values are accepted as defaults and choices.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ParameterConstraint.ValueKind	Machine-readable scalar kind; legacy types retain their presentation type.

Constructor Summary

Constructors

Constructor	Description
ParameterConstraint(String name, ParameterConstraint.ValueKind kind, boolean required, Object defaultValue, List<?> allowedValues, Long minimum, Long maximum, long step, long remainder)	Validates and snapshots the constraint.

Method Summary

Modifier and Type	Method	Description
List<?>	allowedValues()	Returns the value of the allowedValues record component.
Object	defaultValue()	Returns the value of the defaultValue record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
ParameterConstraint.ValueKind	kind()	Returns the value of the kind record component.
Long	maximum()	Returns the value of the maximum record component.
Long	minimum()	Returns the value of the minimum record component.
String	name()	Returns the value of the name record component.
long	remainder()	Returns the value of the remainder record component.
boolean	required()	Returns the value of the required record component.
long	step()	Returns the value of the step record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ParameterConstraint

public ParameterConstraint(String name,
 ParameterConstraint.ValueKind kind,
 boolean required,
 Object defaultValue,
 List<?> allowedValues,
 Long minimum,
 Long maximum,
 long step,
 long remainder)

Validates and snapshots the constraint.

Throws:

IllegalArgumentException - if the definition is inconsistent

NullPointerException - if name, kind or choices is null

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

kind

public ParameterConstraint.ValueKind kind()

Returns the value of the kind record component.

Returns:

the value of the kind record component

required

public boolean required()

Returns the value of the required record component.

Returns:

the value of the required record component

defaultValue

public Object defaultValue()

Returns the value of the defaultValue record component.

Returns:

the value of the defaultValue record component

allowedValues

public List<?> allowedValues()

Returns the value of the allowedValues record component.

Returns:

the value of the allowedValues record component

minimum

public Long minimum()

Returns the value of the minimum record component.

Returns:

the value of the minimum record component

maximum

public Long maximum()

Returns the value of the maximum record component.

Returns:

the value of the maximum record component

step

public long step()

Returns the value of the step record component.

Returns:

the value of the step record component

remainder

public long remainder()

Returns the value of the remainder record component.

Returns:

the value of the remainder record component