Record Class TemplateParameter

java.lang.Object

java.lang.Record

zeroecho.core.TemplateParameter

Record Components:

name - machine-readable parameter name used as the map key (e.g., "keySizeBits")

displayName - human-readable label for UIs and error messages

type - the Java type of the parameter value (e.g., Integer.class)

description - brief description of constraints and purpose

public record TemplateParameter(String name, String displayName, Class<?> type, String description)
extends Record

Describes a single user-supplied parameter accepted by a ParameterSetDescriptor.Template.

Each TemplateParameter carries presentation metadata and a Java type. Machine-readable domain constraints, required flags and defaults are exposed separately by ParameterSetDescriptor.Template.constraints(). Descriptions explain purpose; clients must not parse them to discover validation rules.

Since:

1.0

Constructor Summary

Constructors

Constructor	Description
TemplateParameter(String name, String displayName, Class<?> type, String description)	Validates the record fields on construction.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
String	displayName()	Returns the value of the displayName 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.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
Class<?>	type()	Returns the value of the type record component.

Methods inherited from class Object

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

Constructor Details

TemplateParameter

public TemplateParameter(String name,
 String displayName,
 Class<?> type,
 String description)

Validates the record fields on construction.

Throws:

NullPointerException - if any field is null

IllegalArgumentException - if the name, label or description is blank

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. All components in this record class are compared with Objects::equals(Object,Object).

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

displayName

public String displayName()

Returns the value of the displayName record component.

Returns:

the value of the displayName record component

type

public Class<?> type()

Returns the value of the type record component.

Returns:

the value of the type record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component