Package org.springframework.ai.tool.definition

Record Class DefaultToolDefinition

java.lang.Object

java.lang.Record

org.springframework.ai.tool.definition.DefaultToolDefinition

All Implemented Interfaces:

ToolDefinition

public record DefaultToolDefinition(String name, String description, String inputTypeSchema)
extends Record
implements ToolDefinition

Default implementation of ToolDefinition.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultToolDefinition.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultToolDefinition(String name, String description, String inputTypeSchema)	Creates an instance of a DefaultToolDefinition record class.

Method Summary

Modifier and Type	Method	Description
static DefaultToolDefinition.Builder	builder()	Create a default ToolDefinition builder.
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	inputTypeSchema()	Returns the value of the inputTypeSchema record component.
String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultToolDefinition

public DefaultToolDefinition(String name,
 String description,
 String inputTypeSchema)

Creates an instance of a DefaultToolDefinition record class.

Parameters:

name - the value for the name record component

description - the value for the description record component

inputTypeSchema - the value for the inputTypeSchema record component

Method Details

builder

public static DefaultToolDefinition.Builder builder()

Description copied from interface: ToolDefinition

Create a default ToolDefinition builder.

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.

Specified by:

name in interface ToolDefinition

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 ToolDefinition

Returns:

the value of the description record component

inputTypeSchema

public String inputTypeSchema()

Returns the value of the inputTypeSchema record component.

Specified by:

inputTypeSchema in interface ToolDefinition

Returns:

the value of the inputTypeSchema record component