Package net.thevpc.naru.ext.models.stream

Record Class NaruSseReader.Event

java.lang.Object

java.lang.Record

net.thevpc.naru.ext.models.stream.NaruSseReader.Event

Record Components:

name - the event: field, or null when the server did not name the event -- which for OpenAI-compatible streams means the default message type

data - the data: lines joined with \n, never null but possibly empty

id - the id: field, or null

Enclosing class:

NaruSseReader

public static record NaruSseReader.Event(String name, String data, String id)
extends Record

One dispatched server-sent event.

Constructor Summary

Constructors

Constructor	Description
Event(String name, String data, String id)	Creates an instance of a Event record class.

Method Summary

Modifier and Type	Method	Description
String	data()	Returns the value of the data 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	id()	Returns the value of the id record component.
String	name()	Returns the value of the name record component.
static NaruSseReader.Event	of(String data)
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

Event

public Event(String name,
 String data,
 String id)

Creates an instance of a Event record class.

Parameters:

name - the value for the name record component

data - the value for the data record component

id - the value for the id record component

Method Details

of

public static NaruSseReader.Event of(String data)

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.

Returns:

the value of the name record component

data

public String data()

Returns the value of the data record component.

Returns:

the value of the data record component

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component