Record Class BuiltinToolFormat

java.lang.Object

java.lang.Record

com.github.copilot.generated.rpc.BuiltinToolFormat

@CopilotExperimental
@Generated("copilot-sdk-codegen")
public record BuiltinToolFormat(BuiltinToolFormatType type, String syntax, String definition)
extends Record

Custom grammar input format accepted by a built-in tool.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
BuiltinToolFormat(BuiltinToolFormatType type, String syntax, String definition)	Creates an instance of a BuiltinToolFormat record class.

Method Summary

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BuiltinToolFormat

public BuiltinToolFormat(BuiltinToolFormatType type,
 String syntax,
 String definition)

Creates an instance of a BuiltinToolFormat record class.

Parameters:

type - the value for the type record component

syntax - the value for the syntax record component

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

type

public BuiltinToolFormatType type()

Returns the value of the type record component.

Returns:

the value of the type record component

syntax

public String syntax()

Returns the value of the syntax record component.

Returns:

the value of the syntax record component

definition

public String definition()

Returns the value of the definition record component.

Returns:

the value of the definition record component