Package io.openliberty.mcp.content

Record Class TextContent

java.lang.Object

java.lang.Record

io.openliberty.mcp.content.TextContent

Record Components:

text - (must not be null)

_meta - the optional metadata (may be null)

annotations - the optional annotations (may be null)

All Implemented Interfaces:

Content

public record TextContent(String text, Map<MetaKey,Object> _meta, Content.Annotations annotations)
extends Record
implements Content

A text content provided to or from an LLM.

Nested Class Summary

Nested classes/interfaces inherited from interface io.openliberty.mcp.content.Content

Content.Annotations, Content.Type

Constructor Summary

Constructors

Constructor	Description
TextContent(String text)
TextContent(String text, Map<MetaKey,Object> _meta, Content.Annotations annotations)	Creates an instance of a TextContent record class.

Method Summary

Modifier and Type	Method	Description
Map<MetaKey,Object>	_meta()	Returns the value of the _meta record component.
Content.Annotations	annotations()	Returns the value of the annotations record component.
TextContent	asText()	Casts and returns this object as a text content, or throws an IllegalArgumentException if the content object does not represent a TextContent.
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	text()	Returns the value of the text record component.
final String	toString()	Returns a string representation of this record class.
Content.Type	type()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.openliberty.mcp.content.Content

asAudio, asImage, getType

Constructor Details

TextContent

public TextContent(String text)

TextContent

public TextContent(String text,
 Map<MetaKey,Object> _meta,
 Content.Annotations annotations)

Creates an instance of a TextContent record class.

Parameters:

text - the value for the text record component

_meta - the value for the _meta record component

annotations - the value for the annotations record component

Method Details

type

public Content.Type type()

Specified by:

type in interface Content

Returns:

the type of the content

asText

public TextContent asText()

Description copied from interface: Content

Casts and returns this object as a text content, or throws an IllegalArgumentException if the content object does not represent a TextContent.

Specified by:

asText in interface Content

Returns:

the text content

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.

text

public String text()

Returns the value of the text record component.

Returns:

the value of the text record component

_meta

public Map<MetaKey,Object> _meta()

Returns the value of the _meta record component.

Returns:

the value of the _meta record component

annotations

public Content.Annotations annotations()

Returns the value of the annotations record component.

Specified by:

annotations in interface Content

Returns:

the value of the annotations record component