Package org.mcpjava.server.progress

Interface ProgressNotification.Builder

All Superinterfaces:

MetaCarrier.Builder<ProgressNotification.Builder>

Enclosing interface:

ProgressNotification

public static interface ProgressNotification.Builder
extends MetaCarrier.Builder<ProgressNotification.Builder>

Builder for creating progress notifications.

Method Summary

Modifier and Type	Method	Description
ProgressNotification	build()	Builds the progress notification.
ProgressNotification.Builder	setMessage(String message)	Sets the progress message.
ProgressNotification.Builder	setProgress(double progress)	Sets the current progress value.
ProgressNotification.Builder	setProgress(long progress)	Sets the current progress value.
ProgressNotification.Builder	setTotal(double total)	Sets the total expected value.
ProgressNotification.Builder	setTotal(long total)	Sets the total expected value.

Methods inherited from interface org.mcpjava.server.MetaCarrier.Builder

putMetadata, setMetadata

Method Details

setProgress

ProgressNotification.Builder setProgress(long progress)

Sets the current progress value.

Parameters:

progress - the progress value

Returns:

this builder

setProgress

ProgressNotification.Builder setProgress(double progress)

Sets the current progress value.

Parameters:

progress - the progress value

Returns:

this builder

setTotal

ProgressNotification.Builder setTotal(long total)

Sets the total expected value.

Parameters:

total - the total value

Returns:

this builder

setTotal

ProgressNotification.Builder setTotal(double total)

Sets the total expected value.

Parameters:

total - the total value

Returns:

this builder

setMessage

ProgressNotification.Builder setMessage(String message)

Sets the progress message.

Parameters:

message - the message

Returns:

this builder

build

ProgressNotification build()

Builds the progress notification.

Returns:

the progress notification