com.starbase.starteam
Class CommandAbortedException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--java.lang.RuntimeException
                    |
                    +--com.starbase.starteam.ServerException
                          |
                          +--com.starbase.starteam.CommandAbortedException

All Implemented Interfaces:

java.io.Serializable

public class CommandAbortedException

extends ServerException

The CommandAbortedException class is intended to be used to cause a command to be aborted in NetMonitor.

See Also:

NetMonitor, ServerCommandListener, ServerCommandEvent, Serialized Form

Constructor Summary

CommandAbortedException(java.lang.String sErrorMessage)
Creates a new exception that can be used to be thrown to intentionally cause NetMonitor to abort before or after a particular command is executed.

Method Summary

boolean	equals(java.lang.Object source) returns true if this object instance is equal to the source
java.lang.String	getMessage() Returns the detail message string of this throwable.
int	hashCode() returns a unique hash for all instances of this type
com.borland.starteam.impl.CommandAbortedException	unwrapCAE() Given an instance of the StarTeam class, gets the underlying instance of the StarTeam.Impl.

Methods inherited from class com.starbase.starteam.ServerException

forError, getAuxData, getAuxKeys, getClassName, getErrorCode, getErrorMessage, getErrorSource, getLogEntry, getNonLocalizedMessage, getTimeLogged, isLogged, setErrorMessage, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandAbortedException

public CommandAbortedException(java.lang.String sErrorMessage)

Creates a new exception that can be used to be thrown to intentionally cause NetMonitor to abort before or after a particular command is executed.

Parameters:

sErrorMessage - the error message for this exception

See Also:

ServerCommandListener#start(), ServerCommandListener#end()

Method Detail

unwrapCAE

public com.borland.starteam.impl.CommandAbortedException unwrapCAE()

Given an instance of the StarTeam class, gets the underlying instance of the StarTeam.Impl. Provides applications implemented primarily with the StarTeam APIs access to StarTeam.Impl specific features.

equals

public boolean equals(java.lang.Object source)

returns true if this object instance is equal to the source

Overrides:

equals in class ServerException

Parameters:

source - Object the source to comapre with

Returns:

boolean true if this object is equal to the source

hashCode

public int hashCode()

returns a unique hash for all instances of this type

Overrides:

hashCode in class ServerException

Returns:

int a unique hash for all instances of this type

getMessage

public java.lang.String getMessage()

Returns the detail message string of this throwable.

Overrides:

getMessage in class ServerException

Returns:

the detail message string of this Throwable instance (which may be null).