com.aquenos.cassandra.pvarchiver.server.archiving

Class ArchiveConfigurationCommandResult

java.lang.Object

com.aquenos.cassandra.pvarchiver.server.archiving.ArchiveConfigurationCommandResult

public final class ArchiveConfigurationCommandResult
extends Object

Result of an ArchiveConfigurationCommand. When an archive configuration command is executed, this result object is returned in order to provide an indication of whether the operation was successful or failed. In case of failure, an optional error message may be supplied.

Instances of this class must be created through the success(ArchiveConfigurationCommand) and failure(ArchiveConfigurationCommand, String) methods.

Author:

Sebastian Marsching

Method Summary

Modifier and Type	Method and Description
static ArchiveConfigurationCommandResult	create(ArchiveConfigurationCommand command, boolean success, String errorMessage) Creates a result representing the specified arguments.
boolean	equals(Object obj)
static ArchiveConfigurationCommandResult	failure(ArchiveConfigurationCommand command, String errorMessage) Creates a result that represents a failed execution of the specified command.
ArchiveConfigurationCommand	getCommand() Returns the command for which this object represents the result of the execution.
String	getErrorMessage() Returns the optional error message associated with this result.
int	hashCode()
boolean	isSuccess() Tells whether the execution of the command was successful.
static ArchiveConfigurationCommandResult	success(ArchiveConfigurationCommand command) Creates a result that represents a successful execution of the specified command.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static ArchiveConfigurationCommandResult create(ArchiveConfigurationCommand command,
                                                       boolean success,
                                                       String errorMessage)

Creates a result representing the specified arguments. This constructor is mainly provided for automated construction from a serialized representation (e.g. JSON). Code wanting to construct an instance of this class should typically prefer the success(ArchiveConfigurationCommand) and failure(ArchiveConfigurationCommand, String) methods.

Parameters:

command - command that was executed.

success - true if the execution was successful, false if it failed.

errorMessage - optional error message describing the cause of the failure. Must be null if success is true.

Returns:

configuration command result representing the specified arguments.

Throws:

IllegalArgumentException - if success is true and errorMessage is not null.

NullPointerException - if command is null.

See Also:

failure(ArchiveConfigurationCommand, String), success(ArchiveConfigurationCommand)

success

public static ArchiveConfigurationCommandResult success(ArchiveConfigurationCommand command)

Creates a result that represents a successful execution of the specified command.

Parameters:

command - command that was executed successfully.

Returns:

configuration command result representing the successful execution of the specified command.

Throws:

NullPointerException - if command is null.

failure

public static ArchiveConfigurationCommandResult failure(ArchiveConfigurationCommand command,
                                                        String errorMessage)

Creates a result that represents a failed execution of the specified command. If not null, the specified error message is attached to the result.

Parameters:

command - command whose execution failed.

errorMessage - optional error message describing the cause of the failure or null if no such message can be provided.

Returns:

configuration command result representing the failed execution of the specified command.

Throws:

NullPointerException - if command is null.

getCommand

public ArchiveConfigurationCommand getCommand()

Returns the command for which this object represents the result of the execution. The returned value is never null.

Returns:

command object that belongs to this result.

getErrorMessage

public String getErrorMessage()

Returns the optional error message associated with this result. If the execution of the command was successful (isSuccess() returns true), the returned value is always null. If the execution of the command failed, the return value might still be null if no error message was provided.

Returns:

error message associated with the failed execution of the command or null if no such message is available.

isSuccess

public boolean isSuccess()

Tells whether the execution of the command was successful.

Returns:

true if the command was executed successfully and false if the execution failed.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object