Module io.modelcontextprotocol.sdk.mcp
Package io.modelcontextprotocol.spec

Record Class McpSchema.ProgressNotification

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.ProgressNotification
Enclosing class:
McpSchema
public static record McpSchema.ProgressNotification(String progressToken, double progress, Double total) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProgressNotification(String progressToken, double progress, Double total)
    Creates an instance of a ProgressNotification record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    double
    progress()
    Returns the value of the progress record component.
    String
    progressToken()
    Returns the value of the progressToken record component.
    final String
    toString()
    Returns a string representation of this record class.
    Double
    total()
    Returns the value of the total record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ProgressNotification

      public ProgressNotification(String progressToken, double progress, Double total)
      Creates an instance of a ProgressNotification record class.
      Parameters:
      progressToken - the value for the progressToken record component
      progress - the value for the progress record component
      total - the value for the total 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.

    • progressToken

      public String progressToken()
      Returns the value of the progressToken record component.
      Returns:
      the value of the progressToken record component

    • progress

      public double progress()
      Returns the value of the progress record component.
      Returns:
      the value of the progress record component

    • total

      public Double total()
      Returns the value of the total record component.
      Returns:
      the value of the total record component