com.ibm.xtools.comparemerge.core.command

Class CommandResult

java.lang.Object

com.ibm.xtools.comparemerge.core.command.CommandResult

public final class CommandResult
extends java.lang.Object

The result of a command execution. Command results have an associated status and return value (if applicable). A command result is returned each time a command is executed, undone, or redone by a command manager.

See Also:

IStatus

Constructor Summary

Constructors

Constructor and Description
CommandResult(org.eclipse.core.runtime.IStatus status) Constructs a new command result with the specified status and a default return value.
CommandResult(org.eclipse.core.runtime.IStatus status, java.lang.Object returnValue) Constructs a new command result with the specified status and return value.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getReturnValue() Retrieves the value of the returnValue instance variable.
org.eclipse.core.runtime.IStatus	getStatus() Retrieves the value of the status instance variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandResult

public CommandResult(org.eclipse.core.runtime.IStatus status)

Constructs a new command result with the specified status and a default return value.

Parameters:

status - The status for the new command result.

CommandResult

public CommandResult(org.eclipse.core.runtime.IStatus status,
                     java.lang.Object returnValue)

Constructs a new command result with the specified status and return value.

Parameters:

status - The status for the new command result.

returnValue - The return value for the new command result.

Method Detail

getReturnValue

public java.lang.Object getReturnValue()

Retrieves the value of the returnValue instance variable.

Returns:

The value of the returnValue instance variable.

getStatus

public org.eclipse.core.runtime.IStatus getStatus()

Retrieves the value of the status instance variable.

Returns:

The value of the status instance variable.