115 lines
3.2 KiB
Java
115 lines
3.2 KiB
Java
/*
|
|
* This file is part of the public ComputerCraft API - http://www.computercraft.info
|
|
* Copyright Daniel Ratcliffe, 2011-2020. This API may be redistributed unmodified and in full only.
|
|
* For help using the API, and posting your mods, visit the forums at computercraft.info.
|
|
*/
|
|
package dan200.computercraft.api.turtle;
|
|
|
|
import net.minecraft.util.Direction;
|
|
|
|
import javax.annotation.Nonnull;
|
|
import javax.annotation.Nullable;
|
|
|
|
/**
|
|
* Used to indicate the result of executing a turtle command.
|
|
*
|
|
* @see ITurtleCommand#execute(ITurtleAccess)
|
|
* @see ITurtleUpgrade#useTool(ITurtleAccess, TurtleSide, TurtleVerb, Direction)
|
|
*/
|
|
public final class TurtleCommandResult
|
|
{
|
|
private static final TurtleCommandResult EMPTY_SUCCESS = new TurtleCommandResult( true, null, null );
|
|
private static final TurtleCommandResult EMPTY_FAILURE = new TurtleCommandResult( false, null, null );
|
|
|
|
/**
|
|
* Create a successful command result with no result.
|
|
*
|
|
* @return A successful command result with no values.
|
|
*/
|
|
@Nonnull
|
|
public static TurtleCommandResult success()
|
|
{
|
|
return EMPTY_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
* Create a successful command result with the given result values.
|
|
*
|
|
* @param results The results of executing this command.
|
|
* @return A successful command result with the given values.
|
|
*/
|
|
@Nonnull
|
|
public static TurtleCommandResult success( @Nullable Object[] results )
|
|
{
|
|
if( results == null || results.length == 0 ) return EMPTY_SUCCESS;
|
|
return new TurtleCommandResult( true, null, results );
|
|
}
|
|
|
|
/**
|
|
* Create a failed command result with no error message.
|
|
*
|
|
* @return A failed command result with no message.
|
|
*/
|
|
@Nonnull
|
|
public static TurtleCommandResult failure()
|
|
{
|
|
return EMPTY_FAILURE;
|
|
}
|
|
|
|
/**
|
|
* Create a failed command result with an error message.
|
|
*
|
|
* @param errorMessage The error message to provide.
|
|
* @return A failed command result with a message.
|
|
*/
|
|
@Nonnull
|
|
public static TurtleCommandResult failure( @Nullable String errorMessage )
|
|
{
|
|
if( errorMessage == null ) return EMPTY_FAILURE;
|
|
return new TurtleCommandResult( false, errorMessage, null );
|
|
}
|
|
|
|
private final boolean success;
|
|
private final String errorMessage;
|
|
private final Object[] results;
|
|
|
|
private TurtleCommandResult( boolean success, String errorMessage, Object[] results )
|
|
{
|
|
this.success = success;
|
|
this.errorMessage = errorMessage;
|
|
this.results = results;
|
|
}
|
|
|
|
/**
|
|
* Determine whether the command executed successfully.
|
|
*
|
|
* @return If the command was successful.
|
|
*/
|
|
public boolean isSuccess()
|
|
{
|
|
return success;
|
|
}
|
|
|
|
/**
|
|
* Get the error message of this command result.
|
|
*
|
|
* @return The command's error message, or {@code null} if it was a success.
|
|
*/
|
|
@Nullable
|
|
public String getErrorMessage()
|
|
{
|
|
return errorMessage;
|
|
}
|
|
|
|
/**
|
|
* Get the resulting values of this command result.
|
|
*
|
|
* @return The command's result, or {@code null} if it was a failure.
|
|
*/
|
|
@Nullable
|
|
public Object[] getResults()
|
|
{
|
|
return results;
|
|
}
|
|
}
|