Package ai.agentscentral.core.tool

Record Class EnumToolParameter

java.lang.Object

java.lang.Record

ai.agentscentral.core.tool.EnumToolParameter

Record Components:

index -

type -

name -

description -

required -

jvmName -

enumValues -

All Implemented Interfaces:

ToolParameter

public record EnumToolParameter(int index, Class<?> type, String name, String description, boolean required, String jvmName, Set<String> enumValues)
extends Record
implements ToolParameter

EnumToolParameter

Author:

Rizwan Idrees

Constructor Summary

Constructors

Constructor	Description
EnumToolParameter(int index, Class<?> type, String name, String description, boolean required, String jvmName, Set<String> enumValues)	Creates an instance of a EnumToolParameter record class.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns the value of the description record component.
Set<String>	enumValues()	Returns the value of the enumValues 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.
int	index()	Returns the value of the index record component.
String	jvmName()	Returns the value of the jvmName record component.
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.
Class<?>	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

EnumToolParameter

public EnumToolParameter(int index,
 Class<?> type,
 String name,
 String description,
 boolean required,
 String jvmName,
 Set<String> enumValues)

Creates an instance of a EnumToolParameter record class.

Parameters:

index - the value for the index record component

type - the value for the type record component

name - the value for the name record component

description - the value for the description record component

required - the value for the required record component

jvmName - the value for the jvmName record component

enumValues - the value for the enumValues 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.

index

public int index()

Returns the value of the index record component.

Specified by:

index in interface ToolParameter

Returns:

the value of the index record component

type

public Class<?> type()

Returns the value of the type record component.

Specified by:

type in interface ToolParameter

Returns:

the value of the type record component

name

public String name()

Returns the value of the name record component.

Specified by:

name in interface ToolParameter

Returns:

the value of the name record component

description

public String description()

Returns the value of the description record component.

Specified by:

description in interface ToolParameter

Returns:

the value of the description record component

required

public boolean required()

Returns the value of the required record component.

Specified by:

required in interface ToolParameter

Returns:

the value of the required record component

jvmName

public String jvmName()

Returns the value of the jvmName record component.

Returns:

the value of the jvmName record component

enumValues

public Set<String> enumValues()

Returns the value of the enumValues record component.

Returns:

the value of the enumValues record component