Class McpProgressUpdate.Builder

java.lang.Object

com.soklet.McpProgressUpdate.Builder

Enclosing class:

McpProgressUpdate

@NotThreadSafe
public static final class McpProgressUpdate.Builder
extends Object

Mutable builder for immutable McpProgressUpdate values.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull McpProgressUpdate	build()
@NonNull McpProgressUpdate.Builder	message(@NonNull String message)	Supplies an optional human-readable progress message.
@NonNull McpProgressUpdate.Builder	total(@NonNull Double total)	Supplies the total amount of work, when known.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

total

public @NonNull McpProgressUpdate.Builder total(@NonNull Double total)

Supplies the total amount of work, when known.

Parameters:

total - finite total value

Returns:

this builder

Throws:

NullPointerException - if total is null

IllegalArgumentException - if total is not finite

message

public @NonNull McpProgressUpdate.Builder message(@NonNull String message)

Supplies an optional human-readable progress message.

Parameters:

message - progress message

Returns:

this builder

Throws:

NullPointerException - if message is null

IllegalArgumentException - if message contains unpaired UTF-16 surrogates

build

public @NonNull McpProgressUpdate build()

Returns:

immutable progress update