Package com.tnsai.agents.async

Record Class ChatEvent.Token

java.lang.Object

java.lang.Record

com.tnsai.agents.async.ChatEvent.Token

All Implemented Interfaces:

ChatEvent

Enclosing interface:

ChatEvent

public static record ChatEvent.Token(Instant timestamp, String content, int index)
extends Record
implements ChatEvent

Token streamed event.

Nested Class Summary

Nested classes/interfaces inherited from interface com.tnsai.agents.async.ChatEvent

ChatEvent.Completed, ChatEvent.Error, ChatEvent.Started, ChatEvent.Token, ChatEvent.ToolCall, ChatEvent.ToolResult

Constructor Summary

Constructors

Constructor	Description
Token(String content, int index)
Token(Instant timestamp, String content, int index)	Creates an instance of a Token record class.

Method Summary

Modifier and Type	Method	Description
String	content()	Returns the value of the content 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.
boolean	isTerminal()	Returns true if this is a terminal event.
Instant	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Token

public Token(String content,
 int index)

Token

public Token(Instant timestamp,
 String content,
 int index)

Creates an instance of a Token record class.

Parameters:

timestamp - the value for the timestamp record component

content - the value for the content record component

index - the value for the index record component

Method Details

isTerminal

public boolean isTerminal()

Description copied from interface: ChatEvent

Returns true if this is a terminal event.

Specified by:

isTerminal in interface ChatEvent

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.

timestamp

public Instant timestamp()

Returns the value of the timestamp record component.

Specified by:

timestamp in interface ChatEvent

Returns:

the value of the timestamp record component

content

public String content()

Returns the value of the content record component.

Returns:

the value of the content record component

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index record component