com.xmlmind.xmledit.control

Class CommandResult

java.lang.Object

com.xmlmind.xmledit.control.CommandResult

public class CommandResult
extends Object

Result object returned by Command.executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandResult.Status

Field Summary

Fields

Modifier and Type	Field and Description
static CommandResult	CANCELED A ready-to-use CANCELED CommandResult having no value and no details.
Object	details Optional details about the command execution.
static CommandResult	DONE A ready-to-use DONE CommandResult having no value and no details.
static CommandResult	FAILED A ready-to-use FAILED CommandResult having no value and no details.
CommandResult.Status	status Status of the command execution.
static CommandResult	STOPPED A ready-to-use STOPPED CommandResult having no value and no details.
Object	value Result of the command execution.

Constructor Summary

Constructors

Constructor and Description
CommandResult(CommandResult.Status status, Object value, Object details) Constructs a CommandResult containing specified information.

Method Summary

Modifier and Type	Method and Description
static CommandResult	done(Object value) Convenience method: equivalent to new CommandResult(Status.DONE, value, null).
static CommandResult	failed(Object value) Convenience method: equivalent to new CommandResult(Status.FAILED, value, null).
static boolean	isDone(CommandResult result) Convenience method: tests whether specified result is successful.
static CommandResult	stopped(Object value) Convenience method: equivalent to new CommandResult(Status.STOPPED, value, null).
static CommandResult	success(Object value, String... details) Convenience method: equivalent to new CommandResult(Status.DONE, value, details).

Methods inherited from class java.lang.Object

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

Field Detail

status

public final CommandResult.Status status

Status of the command execution.

value

public final Object value

Result of the command execution. May be null, which means: nothing useful.

How to interpret value depends on status:

DONE

The result object or null.

STOPPED

null or some data which normally should be displayed in a dialog box (e.g. a list of choices letting the user specify what she/he wants).

If this interactive command can also be executed non-interactively, one possiblity is (1) to let the user specify what she/he wants possibly using means other than a dialog box (2) to create the corresponding "complete parameter" and finally (3) to invoke the command again, this time passing it this "complete parameter" as argument.

CANCELED

Should be null.

FAILED

An error message or null.

details

public final Object details

Optional details about the command execution. Generally null.

DONE

public static final CommandResult DONE

A ready-to-use DONE CommandResult having no value and no details.

STOPPED

public static final CommandResult STOPPED

A ready-to-use STOPPED CommandResult having no value and no details.

CANCELED

public static final CommandResult CANCELED

A ready-to-use CANCELED CommandResult having no value and no details.

FAILED

public static final CommandResult FAILED

A ready-to-use FAILED CommandResult having no value and no details.

Constructor Detail

CommandResult

public CommandResult(CommandResult.Status status,
                     Object value,
                     Object details)

Constructs a CommandResult containing specified information.

Method Detail

isDone

public static boolean isDone(CommandResult result)

Convenience method: tests whether specified result is successful.

Parameters:

result - result to be tested; may be null which is considered to be a non-successful result.

done

public static CommandResult done(Object value)

Convenience method: equivalent to new CommandResult(Status.DONE, value, null).

success

public static CommandResult success(Object value,
                                    String... details)

Convenience method: equivalent to new CommandResult(Status.DONE, value, details).

If the command execution is successful and the command is repeatable and/or recordable then details field of the result is expected to be one of:

null

The repeat/record parameter is simply the parameter used as an argument of this method.

An Object

The repeat/record parameter is the string value of this object.

An array of 2 Strings

First string is the repeat/record parameter. Second string is the description of the command to be displayed by repeat commands.

stopped

public static CommandResult stopped(Object value)

Convenience method: equivalent to new CommandResult(Status.STOPPED, value, null).

failed

public static CommandResult failed(Object value)

Convenience method: equivalent to new CommandResult(Status.FAILED, value, null).

A a command which reports an error in its Command.executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) method should both:

1. if the command runs interactively, display the value error message using an alert dialog box;
2. pass the value error message to this method.