org.spongepowered.api.command

Class CommandResult.Builder

java.lang.Object

org.spongepowered.api.command.CommandResult.Builder

Enclosing class:

CommandResult

public static class CommandResult.Builder
extends Object

A builder for CommandResults.

Method Summary

Modifier and Type	Method and Description
CommandResult.Builder	affectedBlocks(Integer affectedBlocks) Sets the amount of blocks affected by the command.
CommandResult.Builder	affectedEntities(Integer affectedEntities) Sets the amount of entities affected by the command.
CommandResult.Builder	affectedItems(Integer affectedItems) Sets the amount of items affected by the command.
CommandResult	build() Builds the CommandResult.
CommandResult.Builder	queryResult(Integer queryResult) Sets the query result of the command, e.g.
CommandResult.Builder	successCount(Integer successCount) Sets if the command has been processed.

Methods inherited from class java.lang.Object

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

Method Detail

successCount

public CommandResult.Builder successCount(@Nullable
                                          Integer successCount)

Sets if the command has been processed.

Parameters:

successCount - If the command has been processed

Returns:

This builder, for chaining

affectedBlocks

public CommandResult.Builder affectedBlocks(@Nullable
                                            Integer affectedBlocks)

Sets the amount of blocks affected by the command.

Parameters:

affectedBlocks - The amount of blocks affected by the command

Returns:

This builder, for chaining

affectedEntities

public CommandResult.Builder affectedEntities(@Nullable
                                              Integer affectedEntities)

Sets the amount of entities affected by the command.

Parameters:

affectedEntities - The amount of entities affected by the command

Returns:

This builder, for chaining

affectedItems

public CommandResult.Builder affectedItems(@Nullable
                                           Integer affectedItems)

Sets the amount of items affected by the command.

Parameters:

affectedItems - The amount of items affected by the command

Returns:

This builder, for chaining

queryResult

public CommandResult.Builder queryResult(@Nullable
                                         Integer queryResult)

Sets the query result of the command, e.g. the time of the day, an amount of money or a player's amount of XP.

Parameters:

queryResult - The query result of the command

Returns:

This builder, for chaining

build

public CommandResult build()

Builds the CommandResult.

Returns:

A CommandResult with the specified settings