org.spongepowered.api.command

Class CommandResult

java.lang.Object

org.spongepowered.api.command.CommandResult

public class CommandResult
extends Object

Represents the result of a command in Sponge.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandResult.Builder A builder for CommandResults.

Method Summary

Modifier and Type	Method and Description
static CommandResult	affectedBlocks(int count) Returns a result indicating the command was processed with an amount of affected blocks.
static CommandResult	affectedEntities(int count) Returns a result indicating the command was processed with an amount of affected entities.
static CommandResult	affectedItems(int count) Returns a result indicating the command was processed with an amount of affected items.
static CommandResult.Builder	builder() Returns a CommandResult.Builder.
static CommandResult	empty() Returns a new CommandResult indicating that a command was processed.
Optional<Integer>	getAffectedBlocks() Gets the number of blocks affected by the command.
Optional<Integer>	getAffectedEntities() Gets the number of entities affected by the command.
Optional<Integer>	getAffectedItems() Gets the number of items affected by the command.
Optional<Integer>	getQueryResult() Gets the query result of the command, e.g.
Optional<Integer>	getSuccessCount() Gets the success count of the command.
static CommandResult	queryResult(int count) Returns a result indicating the command was processed with an amount of queries.
static CommandResult	success() Returns a result indicating the command was processed with a single success.
static CommandResult	successCount(int count) Returns a result indicating the command was processed with a single success.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static CommandResult.Builder builder()

Returns a CommandResult.Builder.

Returns:

A new command result builder

empty

public static CommandResult empty()

Returns a new CommandResult indicating that a command was processed.

Returns:

The command result

success

public static CommandResult success()

Returns a result indicating the command was processed with a single success.

Returns:

The result

successCount

public static CommandResult successCount(int count)

Returns a result indicating the command was processed with a single success.

Parameters:

count - The success count

Returns:

The result

affectedBlocks

public static CommandResult affectedBlocks(int count)

Returns a result indicating the command was processed with an amount of affected blocks.

Parameters:

count - The amount of blocks affected

Returns:

The result

affectedEntities

public static CommandResult affectedEntities(int count)

Returns a result indicating the command was processed with an amount of affected entities.

Parameters:

count - The amount of entities affected

Returns:

The result

affectedItems

public static CommandResult affectedItems(int count)

Returns a result indicating the command was processed with an amount of affected items.

Parameters:

count - The amount of items affected

Returns:

The result

queryResult

public static CommandResult queryResult(int count)

Returns a result indicating the command was processed with an amount of queries.

Parameters:

count - The amount of queries

Returns:

The result

getSuccessCount

public Optional<Integer> getSuccessCount()

Gets the success count of the command.

Returns:

The success count of the command

getAffectedBlocks

public Optional<Integer> getAffectedBlocks()

Gets the number of blocks affected by the command.

Returns:

The number of blocks affected by the command, if such a count exists

getAffectedEntities

public Optional<Integer> getAffectedEntities()

Gets the number of entities affected by the command.

Returns:

The number of entities affected by the command, if such a count exists

getAffectedItems

public Optional<Integer> getAffectedItems()

Gets the number of items affected by the command.

Returns:

The number of items affected by the command, if such a count exists

getQueryResult

public Optional<Integer> getQueryResult()

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

Returns:

The query result of the command, if one exists