PTP
Release 5.0

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

java.lang.Object
  extended by org.eclipse.ptp.debug.core.pdi.request.AbstractEventRequest
      extended by org.eclipse.ptp.debug.core.pdi.request.AbstractEventResultRequest
All Implemented Interfaces:
IPDISet, IPDIEventRequest, IPDIInternalEventRequest
Direct Known Subclasses:
AbstractDataReadMemoryRequest, AbstractEvaluateExpressionRequest, AbstractEvaluatePartialExpressionRequest, AbstractGetInfoThreadsRequest, AbstractGetStackInfoDepthRequest, AbstractListArgumentsRequest, AbstractListLocalVariablesRequest, AbstractListSignalsRequest, AbstractListStackFramesRequest, AbstractSetCurrentStackFrameRequest, AbstractSetThreadSelectRequest

public abstract class AbstractEventResultRequest
extends AbstractEventRequest
implements IPDIInternalEventRequest

Abstract base class of events that return results


Field Summary
protected  long DEFAULT_TIMEOUT
           
protected  Map<TaskSet,Object> results
           
 
Fields inherited from class org.eclipse.ptp.debug.core.pdi.request.AbstractEventRequest
message, status, tasks
 
Fields inherited from interface org.eclipse.ptp.debug.core.pdi.request.IPDIEventRequest
ACTION_NONE, ACTION_TERMINATED, CANCELLED, DONE, ERROR, RUNNING, UNKNOWN
 
Constructor Summary
AbstractEventResultRequest(TaskSet tasks)
           
 
Method Summary
 boolean completed(TaskSet cTasks, Object result)
          Returns whether tasks are completed and set result
protected  void doFinish()
           
protected  boolean findResult(TaskSet qTasks)
           
 int getResponseAction()
          Returns action type for action after completing this request
 Object getResult(TaskSet qTasks)
           
 Map<TaskSet,Object> getResultMap(TaskSet qTasks)
           
protected  void lockRequest(long timeout)
           
protected  void releaseRequest()
           
protected abstract  void storeResult(TaskSet rTasks, Object result)
           
protected  void storeUnknownResult(TaskSet rTasks, Object result)
           
protected  void waiting()
           
 void waitUntilCompleted(TaskSet qTasks)
           
 void waitUntilCompleted(TaskSet qTasks, org.eclipse.core.runtime.IProgressMonitor monitor)
           
 
Methods inherited from class org.eclipse.ptp.debug.core.pdi.request.AbstractEventRequest
cancel, doExecute, done, error, execute, getErrorMessage, getStatus, getTasks, setStatus, 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
cancel, done, error, execute, getErrorMessage, getName, getStatus, setStatus
 
Methods inherited from interface org.eclipse.ptp.debug.core.pdi.IPDISet
getTasks
 

Field Detail

results

protected Map<TaskSet,Object> results

DEFAULT_TIMEOUT

protected long DEFAULT_TIMEOUT
Constructor Detail

AbstractEventResultRequest

public AbstractEventResultRequest(TaskSet tasks)
Since:
4.0
Method Detail

completed

public boolean completed(TaskSet cTasks,
                         Object result)
Description copied from interface: IPDIEventRequest
Returns whether tasks are completed and set result

Specified by:
completed in interface IPDIEventRequest
Overrides:
completed in class AbstractEventRequest
Returns:
true if the tasks are completed

getResponseAction

public int getResponseAction()
Description copied from interface: IPDIEventRequest
Returns action type for action after completing this request

Specified by:
getResponseAction in interface IPDIEventRequest
Overrides:
getResponseAction in class AbstractEventRequest
Returns:
action type

getResult

public Object getResult(TaskSet qTasks)
                 throws PDIException
Specified by:
getResult in interface IPDIInternalEventRequest
Returns:
Throws:
PDIException
Since:
4.0

getResultMap

public Map<TaskSet,Object> getResultMap(TaskSet qTasks)
                                 throws PDIException
Specified by:
getResultMap in interface IPDIInternalEventRequest
Returns:
Throws:
PDIException
Since:
4.0

waitUntilCompleted

public void waitUntilCompleted(TaskSet qTasks)
                        throws PDIException
Specified by:
waitUntilCompleted in interface IPDIInternalEventRequest
Throws:
PDIException
Since:
4.0

waitUntilCompleted

public void waitUntilCompleted(TaskSet qTasks,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws PDIException
Specified by:
waitUntilCompleted in interface IPDIInternalEventRequest
Throws:
PDIException
Since:
4.0

doFinish

protected void doFinish()
                 throws PDIException
Specified by:
doFinish in class AbstractEventRequest
Throws:
PDIException
Since:
4.0

findResult

protected boolean findResult(TaskSet qTasks)
Parameters:
qTasks -
Returns:
Since:
4.0

lockRequest

protected void lockRequest(long timeout)
Parameters:
timeout -

releaseRequest

protected void releaseRequest()

storeResult

protected abstract void storeResult(TaskSet rTasks,
                                    Object result)
Parameters:
rTasks -
result -
Since:
4.0

storeUnknownResult

protected void storeUnknownResult(TaskSet rTasks,
                                  Object result)
Parameters:
rTasks -
result -
Since:
4.0

waiting

protected void waiting()

PTP
Release 5.0

Copyright (c) 2011 IBM Corporation and others. All Rights Reserved.