Package io.modelcontextprotocol.spec

Record Class McpSchema.BooleanSchema

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.BooleanSchema

Record Components:

title - Optional title for the boolean field

description - Optional description for the boolean field

defaultValue - Optional default value

Enclosing class:

McpSchema

public static record McpSchema.BooleanSchema(String title, String description, Boolean defaultValue)
extends Record

Schema for a boolean field in a form-based elicitation request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpSchema.BooleanSchema.Builder

Constructor Summary

Constructors

Constructor	Description
BooleanSchema(String title, String description, Boolean defaultValue)	Creates an instance of a BooleanSchema record class.

Method Summary

Modifier and Type	Method	Description
static McpSchema.BooleanSchema.Builder	builder()
Boolean	defaultValue()	Returns the value of the defaultValue record component.
String	description()	Returns the value of the description 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	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.
String	type()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BooleanSchema

public BooleanSchema(String title,
 String description,
 Boolean defaultValue)

Creates an instance of a BooleanSchema record class.

Parameters:

title - the value for the title record component

description - the value for the description record component

defaultValue - the value for the defaultValue record component

Method Details

type

public String type()

builder

public static McpSchema.BooleanSchema.Builder builder()

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.

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

defaultValue

public Boolean defaultValue()

Returns the value of the defaultValue record component.

Returns:

the value of the defaultValue record component