Package io.openliberty.mcp.tools

Record Class ToolManager.ToolAnnotations

java.lang.Object
java.lang.Record
io.openliberty.mcp.tools.ToolManager.ToolAnnotations
Enclosing interface:
ToolManager
public static record ToolManager.ToolAnnotations(String title, boolean readOnlyHint, boolean destructiveHint, boolean idempotentHint, boolean openWorldHint) extends Record
The MCP annotations of a tool.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToolAnnotations(String title, boolean readOnlyHint, boolean destructiveHint, boolean idempotentHint, boolean openWorldHint)
    Creates an instance of a ToolAnnotations record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    destructiveHint()
    Returns the value of the destructiveHint 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.
    boolean
    idempotentHint()
    Returns the value of the idempotentHint record component.
    boolean
    openWorldHint()
    Returns the value of the openWorldHint record component.
    boolean
    readOnlyHint()
    Returns the value of the readOnlyHint record component.
    String
    title()
    Returns the value of the title record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ToolAnnotations

      public ToolAnnotations(String title, boolean readOnlyHint, boolean destructiveHint, boolean idempotentHint, boolean openWorldHint)
      Creates an instance of a ToolAnnotations record class.
      Parameters:
      title - the value for the title record component
      readOnlyHint - the value for the readOnlyHint record component
      destructiveHint - the value for the destructiveHint record component
      idempotentHint - the value for the idempotentHint record component
      openWorldHint - the value for the openWorldHint 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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

    • readOnlyHint

      public boolean readOnlyHint()
      Returns the value of the readOnlyHint record component.
      Returns:
      the value of the readOnlyHint record component

    • destructiveHint

      public boolean destructiveHint()
      Returns the value of the destructiveHint record component.
      Returns:
      the value of the destructiveHint record component

    • idempotentHint

      public boolean idempotentHint()
      Returns the value of the idempotentHint record component.
      Returns:
      the value of the idempotentHint record component

    • openWorldHint

      public boolean openWorldHint()
      Returns the value of the openWorldHint record component.
      Returns:
      the value of the openWorldHint record component