org.jecars.tools
Interface CARS_ToolInstanceEvent

All Known Implementing Classes:

CARS_DefaultToolInstanceEvent

public interface CARS_ToolInstanceEvent

CARS_ToolInstanceEvent

Version:

$Id: CARS_ToolInstanceEvent.java,v 1.1 2007/12/21 15:06:32 weertj Exp $

Field Summary

static int	EVENTTYPE_GENERALEXCEPTION
static int	EVENTTYPE_STATECHANGED
static int	EVENTTYPE_STATUSMESSAGE
static int	EVENTTYPE_TOOLINSTANCEEXCEPTION
static int	EVENTTYPE_TOOLMESSAGE
static int	EVENTTYPE_TOOLOUTPUTREPORT
static int	EVENTTYPE_UNKNOWN

Method Summary

boolean	getEventBlocking() Is this a blocking event?
java.lang.Throwable	getEventException() Get the exception of the tool instance, when event type is EVENTTYPE_GENERALEXCEPTION
java.util.logging.Level	getEventLevel() Get the event level, eq.
java.lang.String	getEventState() Get the state of the instance at the time this event was created
java.lang.String	getEventStringValue() Get event string value
int	getEventType() Get the type of this event
CARS_ToolInterface	getToolInstance() Get the tool instance which generated this event

Field Detail

EVENTTYPE_UNKNOWN

static final int EVENTTYPE_UNKNOWN

See Also:

Constant Field Values

EVENTTYPE_STATECHANGED

static final int EVENTTYPE_STATECHANGED

See Also:

Constant Field Values

EVENTTYPE_GENERALEXCEPTION

static final int EVENTTYPE_GENERALEXCEPTION

See Also:

Constant Field Values

EVENTTYPE_TOOLINSTANCEEXCEPTION

static final int EVENTTYPE_TOOLINSTANCEEXCEPTION

See Also:

Constant Field Values

EVENTTYPE_TOOLOUTPUTREPORT

static final int EVENTTYPE_TOOLOUTPUTREPORT

See Also:

Constant Field Values

EVENTTYPE_TOOLMESSAGE

static final int EVENTTYPE_TOOLMESSAGE

See Also:

Constant Field Values

EVENTTYPE_STATUSMESSAGE

static final int EVENTTYPE_STATUSMESSAGE

See Also:

Constant Field Values

Method Detail

getToolInstance

CARS_ToolInterface getToolInstance()

Get the tool instance which generated this event

Returns:

The tool instance

getEventState

java.lang.String getEventState()

Get the state of the instance at the time this event was created

Returns:

the STATE_*

getEventException

java.lang.Throwable getEventException()

Get the exception of the tool instance, when event type is EVENTTYPE_GENERALEXCEPTION

getEventStringValue

java.lang.String getEventStringValue()

Get event string value

getEventType

int getEventType()

Get the type of this event

Returns:

The type can be; EVENTTYPE_UNKNOWN = Unknown event type EVENTTYPE_STATECHANGED = The state of the tool instance is changed, call getEventState() for the new state EVENTTYPE_GENERALEXCEPTION = A general exception occured within the tool instance. call getEventException() for the thrown exception. EVENTTYPE_TOOLINSTANCEEXCEPTION = A general exception occured within the tool instance external execution. call getEventException() for the thrown exception. EVENTTYPE_TOOLOUTPUTREPORT = Output is generated by the tool getEventStringValue() EVENTTYPE_TOOLMESSAGE = Message is generated by the tool getEventStringValue() EVENTTYPE_STATUSMESSAGE = Short (1 line) message for user purpose

getEventLevel

java.util.logging.Level getEventLevel()

Get the event level, eq. java.util.Logger.Level

getEventBlocking

boolean getEventBlocking()

Is this a blocking event?