Package org.eclipse.tracecompass.incubator.callstack.core.base

Class CallStackGroupDescriptor

java.lang.Object

org.eclipse.tracecompass.incubator.callstack.core.base.CallStackGroupDescriptor

All Implemented Interfaces:

IWeightedTreeGroupDescriptor, ICallStackGroupDescriptor

public class CallStackGroupDescriptor
extends Object
implements ICallStackGroupDescriptor

A basic group descriptor implementation.

Author:

Geneviève Bastien

Constructor Summary

Constructors

Constructor	Description
CallStackGroupDescriptor(String name, @Nullable ICallStackGroupDescriptor nextGroup, boolean isSymbolKeyGroup)	Constructor

Method Summary

Modifier and Type	Method	Description
String	getName()	Get the human-readable name for this group descriptor
@Nullable ICallStackGroupDescriptor	getNextGroup()	Get the group descriptor at the next level.
boolean	isSymbolKeyGroup()	Get whether the value of this group should be used as the key for the symbol provider.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CallStackGroupDescriptor

public CallStackGroupDescriptor(String name,
 @Nullable ICallStackGroupDescriptor nextGroup,
 boolean isSymbolKeyGroup)

Constructor

Parameters:

name - The name of this group

nextGroup - The next group of the hierarchy, ie the child of the group being constructed or null if this group is the leaf

isSymbolKeyGroup - Whether this level contains the symbol key

Method Details

getNextGroup

public @Nullable ICallStackGroupDescriptor getNextGroup()

Description copied from interface: IWeightedTreeGroupDescriptor

Get the group descriptor at the next level.

Specified by:

getNextGroup in interface ICallStackGroupDescriptor

Specified by:

getNextGroup in interface IWeightedTreeGroupDescriptor

Returns:

The next group or null if this is a leaf level

isSymbolKeyGroup

public boolean isSymbolKeyGroup()

Description copied from interface: ICallStackGroupDescriptor

Get whether the value of this group should be used as the key for the symbol provider. For instance, for some callstack, the group corresponding to the process ID would be the symbol key group.

Specified by:

isSymbolKeyGroup in interface ICallStackGroupDescriptor

Returns:

true if the values of this group are used as the symbol mapping key.

getName

public String getName()

Description copied from interface: IWeightedTreeGroupDescriptor

Get the human-readable name for this group descriptor

Specified by:

getName in interface IWeightedTreeGroupDescriptor

Returns:

The name of this group descriptor

toString

public String toString()

Overrides:

toString in class Object