Package org.springframework.ai.tool.metadata

Record Class DefaultToolMetadata

java.lang.Object

java.lang.Record

org.springframework.ai.tool.metadata.DefaultToolMetadata

All Implemented Interfaces:

ToolMetadata

public record DefaultToolMetadata(boolean returnDirect)
extends Record
implements ToolMetadata

Default implementation of ToolMetadata.

Since:

1.0.0

Author:

Thomas Vitale

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultToolMetadata.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultToolMetadata(boolean returnDirect)	Creates an instance of a DefaultToolMetadata record class.

Method Summary

Modifier and Type	Method	Description
static DefaultToolMetadata.Builder	builder()
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.
boolean	returnDirect()	Returns the value of the returnDirect 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

DefaultToolMetadata

public DefaultToolMetadata(boolean returnDirect)

Creates an instance of a DefaultToolMetadata record class.

Parameters:

returnDirect - the value for the returnDirect record component

Method Details

builder

public static DefaultToolMetadata.Builder 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 '=='.

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.

returnDirect

public boolean returnDirect()

Returns the value of the returnDirect record component.

Specified by:

returnDirect in interface ToolMetadata

Returns:

the value of the returnDirect record component