Class McpProgressUpdate

java.lang.Object

com.soklet.McpProgressUpdate

@ThreadSafe
public final class McpProgressUpdate
extends Object

Immutable progress update for one active MCP invocation.

Progress and total values are finite JSON numbers. Soklet associates the update with the initiating request's opaque progress token; applications do not copy or manage that token themselves.

String factories and setters reject unpaired UTF-16 surrogates with IllegalArgumentException; well-formed Unicode is preserved exactly.

Author:

Mark Allen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	McpProgressUpdate.Builder	Mutable builder for immutable McpProgressUpdate values.

Method Summary

Modifier and Type	Method	Description
boolean	equals(@Nullable Object other)
@NonNull Optional<@NonNull String>	getMessage()
@NonNull Double	getProgress()
@NonNull Optional<@NonNull Double>	getTotal()
int	hashCode()
static @NonNull McpProgressUpdate.Builder	withProgress(@NonNull Double progress)	Vends a builder primed with the current progress value.

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Details

withProgress

public static @NonNull McpProgressUpdate.Builder withProgress(@NonNull Double progress)

Vends a builder primed with the current progress value.

Parameters:

progress - finite progress value

Returns:

progress-update builder

Throws:

NullPointerException - if progress is null

IllegalArgumentException - if progress is not finite

getProgress

public @NonNull Double getProgress()

Returns:

finite progress value

getTotal

public @NonNull Optional<@NonNull Double> getTotal()

Returns:

finite total value, if supplied

getMessage

public @NonNull Optional<@NonNull String> getMessage()

Returns:

human-readable progress message, if supplied

equals

public boolean equals(@Nullable Object other)

Overrides:

equals in class Object

Returns:

whether every progress property is structurally equal

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

structural progress-update hash code