Package com.tnsai.tools.method

Record Class ToolParameter

java.lang.Object

java.lang.Record

com.tnsai.tools.method.ToolParameter

Record Components:

name - the LLM-facing parameter name (defaults to the reflected Java parameter name when the -parameters compile flag is set)

description - human-readable description surfaced to the LLM

type - the parameter's static Java Type including generic information (e.g. List<String>)

required - whether the parameter must be present in every LLM call

defaultValue - default value string parsed to type when the LLM omits the parameter; empty string means no default

public record ToolParameter(String name, String description, Type type, boolean required, String defaultValue)
extends Record

Metadata for a single parameter of a ToolMethod.

Built by ToolMethodRegistry when scanning a POJO for Tool-annotated methods. Holds the LLM-facing name + description plus the static Java Type so the dispatcher can coerce the LLM's JSON argument to the right value.

Since:

0.5.7 (LangChain-style tool refactor — see issue #188)

Constructor Summary

Constructors

Constructor	Description
ToolParameter(String name, String description, Type type, boolean required, String defaultValue)	Creates an instance of a ToolParameter record class.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ToolParameter

public ToolParameter(String name,
 String description,
 Type type,
 boolean required,
 String defaultValue)

Creates an instance of a ToolParameter record class.

Parameters:

name - the value for the name record component

description - the value for the description record component

type - the value for the type record component

required - the value for the required record component

defaultValue - the value for the defaultValue record component

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 '=='.

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

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

type

public Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

required

public boolean required()

Returns the value of the required record component.

Returns:

the value of the required record component

defaultValue

public String defaultValue()

Returns the value of the defaultValue record component.

Returns:

the value of the defaultValue record component