org.eclipse.ptp.debug.core.pdi.request
Class AbstractEventRequest

java.lang.Object
  org.eclipse.ptp.debug.core.pdi.request.AbstractEventRequest

All Implemented Interfaces:

IPDISet, IPDIEventRequest

Direct Known Subclasses:

AbstractEventResultRequest

public abstract class AbstractEventRequest
extends java.lang.Object
implements IPDIEventRequest

Field Summary

protected java.lang.String	message
protected int	status
protected TaskSet	tasks

Fields inherited from interface org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest

ACTION_NONE, ACTION_TERMINATED, CANCELLED, DONE, ERROR, RUNNING, UNKNOWN

Constructor Summary

AbstractEventRequest(TaskSet tasks)

Method Summary

void	cancel() Cancels this request.
boolean	completed(TaskSet cTasks, java.lang.Object result) Returns whether tasks are completed and set result
protected abstract void	doExecute(IPDIDebugger debugger)
protected abstract void	doFinish()
void	done() Indicates this request is complete.
void	error(java.lang.String message) Indicates this request has an error.
void	execute(IPDIDebugger debugger) Indicates this request is executing.
java.lang.String	getErrorMessage() Returns error message of this request
int	getResponseAction() Returns action type for action after completing this request
int	getStatus() Returns the current status of this request
TaskSet	getTasks() Returns a list of Task IDs
void	setStatus(int status) Sets current status of this request
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest

getName

Field Detail

status

protected int status

tasks

protected TaskSet tasks

message

protected java.lang.String message

Constructor Detail

AbstractEventRequest

public AbstractEventRequest(TaskSet tasks)

Since:

4.0

Method Detail

cancel

public void cancel()

Description copied from interface: IPDIEventRequest

Cancels this request. A request may be cancelled by the originator of request or a client fulfilling a request. Optionally a cancelled status may be set on this request with more details. A client fulfilling a request must still call done() to indicate the request is complete.

Specified by:

cancel in interface IPDIEventRequest

completed

public boolean completed(TaskSet cTasks,
                         java.lang.Object result)

Description copied from interface: IPDIEventRequest

Returns whether tasks are completed and set result

Specified by:

completed in interface IPDIEventRequest

Returns:

true if the tasks are completed

Since:

4.0

done

public void done()

Description copied from interface: IPDIEventRequest

Indicates this request is complete. Clients must call this method whether the request succeeds, fails, or is cancelled to indicate that processing is complete. Only clients fulfilling a request should call this method. Clients making a request are not intended to call this method.

Specified by:

done in interface IPDIEventRequest

error

public void error(java.lang.String message)

Description copied from interface: IPDIEventRequest

Indicates this request has an error.

Specified by:

error in interface IPDIEventRequest

Parameters:

message - error message

execute

public void execute(IPDIDebugger debugger)

Description copied from interface: IPDIEventRequest

Indicates this request is executing.

Specified by:

execute in interface IPDIEventRequest

getErrorMessage

public java.lang.String getErrorMessage()

Description copied from interface: IPDIEventRequest

Returns error message of this request

Specified by:

getErrorMessage in interface IPDIEventRequest

Returns:

error message of this request

getResponseAction

public int getResponseAction()

Description copied from interface: IPDIEventRequest

Returns action type for action after completing this request

Specified by:

getResponseAction in interface IPDIEventRequest

Returns:

action type

getStatus

public int getStatus()

Description copied from interface: IPDIEventRequest

Returns the current status of this request

Specified by:

getStatus in interface IPDIEventRequest

Returns:

the current status of this request

getTasks

public TaskSet getTasks()

Description copied from interface: IPDISet

Returns a list of Task IDs

Specified by:

getTasks in interface IPDISet

Returns:

TaskSet of all processes

Since:

4.0

setStatus

public void setStatus(int status)

Description copied from interface: IPDIEventRequest

Sets current status of this request

Specified by:

setStatus in interface IPDIEventRequest

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

doExecute

protected abstract void doExecute(IPDIDebugger debugger)
                           throws PDIException

Parameters:

debugger -

Throws:

PDIException

doFinish

protected abstract void doFinish()
                          throws PDIException

Throws:

PDIException