TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.hyades.execution.trace
Class TraceCorrelator

java.lang.Object
  extended byorg.eclipse.hyades.collection.correlation.BaseCorrelatorDataImpl
      extended byorg.eclipse.hyades.execution.trace.TraceCorrelator
All Implemented Interfaces:
ICorrelatorData

public class TraceCorrelator
extends BaseCorrelatorDataImpl

This is the trace correlator holding information about each method invocation.


Field Summary
 
Fields inherited from class org.eclipse.hyades.collection.correlation.BaseCorrelatorDataImpl
application
 
Constructor Summary
TraceCorrelator()
           
 
Method Summary
 java.lang.String getAgentIdRef()
           
 java.lang.Class getClazz()
           
 java.lang.String getInvokedMethod()
           
 java.lang.String getMethod()
           
 java.lang.String getNodeIdRef()
           
 int getObject()
           
 java.lang.Class[] getParmClasses()
           
 java.lang.String[] getParmNames()
           
 java.lang.Object[] getParmValues()
           
 java.lang.String getProcessIdRef()
           
 java.lang.Class getReturnClass()
           
 java.lang.Object getReturnValue()
           
 int getThreadIdRef()
           
 void invalidate()
          Invalidates this correlator by resetting it to an initialized correlator.
 int readBinary(byte[] buffer, int offset, int length)
          Converts an array of bytes into a correlator.
 void setAgentIdRef(java.lang.String agentIdRef)
           
 void setClazz(java.lang.Class clazz)
           
 void setInvocation(int object, java.lang.Class clazz, java.lang.String method, java.lang.Class[] parmClasses, java.lang.Object[] parmValues, java.lang.Class returnClass)
          Sets a common set of parameters for an invocation.
 void setMethod(java.lang.String method)
           
 void setNodeIdRef(java.lang.String nodeIdRef)
           
 void setObject(int object)
           
 void setParmClasses(java.lang.Class[] parmClasses)
           
 void setParmNames(java.lang.String[] parmNames)
           
 void setParmValues(java.lang.Object[] parmValues)
           
 void setProcessIdRef(java.lang.String processIdRef)
           
 void setReturnClass(java.lang.Class returnType)
           
 void setReturnValue(java.lang.Object returnValue)
           
 void setThreadIdRef(int threadIdRef)
           
 int writeBinary(byte[] buffer, int offset, int length)
          Converts this correlator into an array of bytes, and saves them in the buffer.
 
Methods inherited from class org.eclipse.hyades.collection.correlation.BaseCorrelatorDataImpl
convertBytesToInteger, convertIntegerToBytes, getApplication, getApplicationCounter, getOperationCounter, readXML, setApplicationCounter, setOperationCounter, writeXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TraceCorrelator

public TraceCorrelator()
Method Detail

readBinary

public int readBinary(byte[] buffer,
                      int offset,
                      int length)
               throws InsufficientBufferLengthException
Description copied from interface: ICorrelatorData
Converts an array of bytes into a correlator.

Specified by:
readBinary in interface ICorrelatorData
Overrides:
readBinary in class BaseCorrelatorDataImpl
Throws:
InsufficientBufferLengthException
See Also:
ICorrelatorData.readBinary(byte[], int, int)

writeBinary

public int writeBinary(byte[] buffer,
                       int offset,
                       int length)
                throws InsufficientBufferLengthException
Description copied from interface: ICorrelatorData
Converts this correlator into an array of bytes, and saves them in the buffer.

Specified by:
writeBinary in interface ICorrelatorData
Overrides:
writeBinary in class BaseCorrelatorDataImpl
Throws:
InsufficientBufferLengthException
See Also:
ICorrelatorData.writeBinary(byte[], int, int)

invalidate

public void invalidate()
Description copied from class: BaseCorrelatorDataImpl
Invalidates this correlator by resetting it to an initialized correlator.

Overrides:
invalidate in class BaseCorrelatorDataImpl
See Also:
BaseCorrelatorDataImpl.invalidate()

setInvocation

public void setInvocation(int object,
                          java.lang.Class clazz,
                          java.lang.String method,
                          java.lang.Class[] parmClasses,
                          java.lang.Object[] parmValues,
                          java.lang.Class returnClass)
Sets a common set of parameters for an invocation.

Parameters:
object - the object on which the invocation was made
method - the name of the method
parmClasses - an ordered list of parameter classes
parmValues - an ordered list of parameter values
returnClass - the return type of the method, if any

getInvokedMethod

public java.lang.String getInvokedMethod()

getAgentIdRef

public java.lang.String getAgentIdRef()

getProcessIdRef

public java.lang.String getProcessIdRef()

setAgentIdRef

public void setAgentIdRef(java.lang.String agentIdRef)

setProcessIdRef

public void setProcessIdRef(java.lang.String processIdRef)

getThreadIdRef

public int getThreadIdRef()

setThreadIdRef

public void setThreadIdRef(int threadIdRef)

getClazz

public java.lang.Class getClazz()

getMethod

public java.lang.String getMethod()

getParmNames

public java.lang.String[] getParmNames()

getParmValues

public java.lang.Object[] getParmValues()

setClazz

public void setClazz(java.lang.Class clazz)

setMethod

public void setMethod(java.lang.String method)

setParmNames

public void setParmNames(java.lang.String[] parmNames)

setParmValues

public void setParmValues(java.lang.Object[] parmValues)

getReturnClass

public java.lang.Class getReturnClass()

getReturnValue

public java.lang.Object getReturnValue()

setReturnValue

public void setReturnValue(java.lang.Object returnValue)

getObject

public int getObject()

getParmClasses

public java.lang.Class[] getParmClasses()

setObject

public void setObject(int object)

setParmClasses

public void setParmClasses(java.lang.Class[] parmClasses)

setReturnClass

public void setReturnClass(java.lang.Class returnType)

getNodeIdRef

public java.lang.String getNodeIdRef()

setNodeIdRef

public void setNodeIdRef(java.lang.String nodeIdRef)

TPTP 4.2.0 Platform Project
Public API Specification