Record Class McpProgressToken

java.lang.Object
java.lang.Record
com.soklet.McpProgressToken
@Immutable public record McpProgressToken(@NonNull McpValue value) extends Record
Immutable wrapper for MCP progress tokens.
Author:
Mark Allen

  • Constructor Details

    • McpProgressToken

      public McpProgressToken(@NonNull McpValue value)
      Creates an instance of a McpProgressToken record class.
      Parameters:
      value - the value for the value record component

  • Method Details

    • fromString

      public static @NonNull McpProgressToken fromString(@NonNull String value)
      Creates a string-backed progress token.
      Parameters:
      value - the string progress token
      Returns:
      the progress token wrapper

    • fromNumber

      public static @NonNull McpProgressToken fromNumber(@NonNull BigDecimal value)
      Creates a number-backed progress token.
      Parameters:
      value - the numeric progress token
      Returns:
      the progress token wrapper

    • asString

      public @NonNull Optional<String> asString()
      Reads the progress token as a string when it is string-backed.
      Returns:
      the string progress token, if this wrapper holds one

    • asNumber

      public @NonNull Optional<BigDecimal> asNumber()
      Reads the progress token as a number when it is number-backed.
      Returns:
      the numeric progress token, if this wrapper holds one

    • 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.

    • value

      public @NonNull McpValue value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component