com.linkedin.parseq.trace

Class ShallowTraceImp

java.lang.Object

com.linkedin.parseq.trace.ShallowTraceImp

All Implemented Interfaces:

ShallowTrace

public class ShallowTraceImp
extends java.lang.Object
implements ShallowTrace

A shallow trace is a trace without any relationship information. Use ShallowTraceBuilder to construct new instances of this class.

This class is immutable and thread-safe.

Author:

Chris Pettitt ([email protected]), Chi Chan ([email protected]), Jaroslaw Odzga ([email protected])

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Get the set of attributes related to this trace.
java.lang.Long	getEndNanos() Returns the time at which the task was finished in nanoseconds.
boolean	getHidden() Returns if the trace will be hidden from the visualizations.
java.lang.Long	getId() Id of this trace.
java.lang.String	getName() Returns the task name for this trace
java.lang.Long	getPendingNanos() Returns the time at which the task finished its run method in nanoseconds.
ResultType	getResultType() Returns the result type of the task.
java.lang.Long	getStartNanos() Returns the time at which the task was started in nanoseconds.
boolean	getSystemHidden() Returns if the trace will be system hidden from the visualizations.
java.lang.String	getTaskType() Returns type (sideEffect, seq, par, timer etc) of the task
java.lang.String	getValue() Returns a String representation of the value or error produced by the traced task.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

Description copied from interface: ShallowTrace

Returns the task name for this trace

Specified by:

getName in interface ShallowTrace

Returns:

the task name for this trace

getHidden

public boolean getHidden()

Description copied from interface: ShallowTrace

Returns if the trace will be hidden from the visualizations.

Specified by:

getHidden in interface ShallowTrace

Returns:

if the trace is hidden

getSystemHidden

public boolean getSystemHidden()

Description copied from interface: ShallowTrace

Returns if the trace will be system hidden from the visualizations.

Specified by:

getSystemHidden in interface ShallowTrace

Returns:

if the trace is system hidden.

getValue

public java.lang.String getValue()

Description copied from interface: ShallowTrace

Returns a String representation of the value or error produced by the traced task. If the task was unfinished then the string representation will be null.

Specified by:

getValue in interface ShallowTrace

Returns:

String representation of the task's value

getResultType

public ResultType getResultType()

Description copied from interface: ShallowTrace

Returns the result type of the task.

Specified by:

getResultType in interface ShallowTrace

Returns:

the result type of the task

getStartNanos

public java.lang.Long getStartNanos()

Description copied from interface: ShallowTrace

Returns the time at which the task was started in nanoseconds. If the task had not yet started, this method will return null.

Specified by:

getStartNanos in interface ShallowTrace

Returns:

the time at which this task was started or null

getPendingNanos

public java.lang.Long getPendingNanos()

Description copied from interface: ShallowTrace

Returns the time at which the task finished its run method in nanoseconds. If the task has not finished its run method yet this method will return null.

Specified by:

getPendingNanos in interface ShallowTrace

Returns:

the time at which this task finished its run method or null.

getEndNanos

public java.lang.Long getEndNanos()

Description copied from interface: ShallowTrace

Returns the time at which the task was finished in nanoseconds. If the task had not yet finished, this method will return null.

Specified by:

getEndNanos in interface ShallowTrace

Returns:

the time at which this task was finished or null

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Description copied from interface: ShallowTrace

Get the set of attributes related to this trace.

Specified by:

getAttributes in interface ShallowTrace

Returns:

the map of attributes related to this trace.

getId

public java.lang.Long getId()

Description copied from interface: ShallowTrace

Id of this trace.

Specified by:

getId in interface ShallowTrace

Returns:

Id of this trace.

getTaskType

public java.lang.String getTaskType()

Description copied from interface: ShallowTrace

Returns type (sideEffect, seq, par, timer etc) of the task

Specified by:

getTaskType in interface ShallowTrace

Returns:

type of the task

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object