Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.ReadResourceResult

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.ReadResourceResult

Record Components:

contents - The contents of the resource

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Result

Enclosing class:

McpSchema

public static record McpSchema.ReadResourceResult(List<McpSchema.ResourceContents> contents, Map<String,Object> meta)
extends Record
implements McpSchema.Result

The server's response to a resources/read request from the client.

Constructor Summary

Constructors

Constructor	Description
ReadResourceResult(List<McpSchema.ResourceContents> contents)
ReadResourceResult(List<McpSchema.ResourceContents> contents, Map<String,Object> meta)	Creates an instance of a ReadResourceResult record class.

Method Summary

Modifier and Type	Method	Description
List<McpSchema.ResourceContents>	contents()	Returns the value of the contents 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.
Map<String,Object>	meta()	Returns the value of the meta 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

ReadResourceResult

public ReadResourceResult(List<McpSchema.ResourceContents> contents)

ReadResourceResult

public ReadResourceResult(List<McpSchema.ResourceContents> contents,
 Map<String,Object> meta)

Creates an instance of a ReadResourceResult record class.

Parameters:

contents - the value for the contents record component

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

contents

public List<McpSchema.ResourceContents> contents()

Returns the value of the contents record component.

Returns:

the value of the contents record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Specified by:

meta in interface McpSchema.Result

Returns:

the value of the meta record component