Package com.vaadin.flow.component.ai.common

Record Class AIAttachment

java.lang.Object

java.lang.Record

com.vaadin.flow.component.ai.common.AIAttachment

Record Components:

name - the display name of the attachment (e.g., file name), not null

mimeType - the MIME type of the attachment (e.g., "image/png", "application/pdf"), not null

data - the raw file data, not null

All Implemented Interfaces:

Serializable

public record AIAttachment(String name, String mimeType, byte[] data)
extends Record
implements Serializable

Represents an attachment that can be sent to an LLM and displayed in messages.

This record holds the raw file data for sending to the LLM provider.

Author:

Vaadin Ltd

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AIAttachment(String name, String mimeType, byte[] data)	Creates a new attachment.

Method Summary

Modifier and Type	Method	Description
byte[]	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	mimeType()	Returns the value of the mimeType 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

AIAttachment

public AIAttachment(String name,
 String mimeType,
 byte[] data)

Creates a new attachment.

Parameters:

name - the display name of the attachment

mimeType - the MIME type of the attachment

data - the raw file data

Throws:

NullPointerException - if any parameter is null

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

mimeType

public String mimeType()

Returns the value of the mimeType record component.

Returns:

the value of the mimeType record component

data

public byte[] data()

Returns the value of the data record component.

Returns:

the value of the data record component