com.jrockit.mc.flightrecorder.spi
Interface ITrackGroup

All Known Implementing Classes:

TrackGroup

public interface ITrackGroup

A container that holds tracks.

Author:

Erik gahlin

Method Summary

java.util.List<ITrackGroup>	getAllGroups() Return all groups and sub groups.
java.util.Collection<ITrack>	getAllTracks() Return all tracks that belong to the track group and it's children.
java.lang.String	getDescription() Returns a description of the track
ITrackGroup	getGroup(java.lang.String symbolName) Returns a group given a symbolic name
java.util.List<ITrackGroup>	getGroups()
java.lang.Integer	getId() A machine identifier for the track
java.lang.String	getIdentifier() Returns a symbolic name for the track group.
java.lang.String	getName() A human readable name of the track
ITrackGroup	getParent() Returns the parent, or null if it's the root group
java.lang.String	getPath() Returns the path of the track
java.lang.Object	getProperty(java.lang.String key) Returns a property value for.
ITimeRange	getRange() The time range the track group spans.
java.util.List<ITrack>	getTracks() Return all tracks that belong to the track group.

Method Detail

getParent

ITrackGroup getParent()

Returns the parent, or null if it's the root group

Returns:

the parent group, or null if not available.

getDescription

java.lang.String getDescription()

Returns a description of the track

Returns:

a description, or null if not available.

getGroups

java.util.List<ITrackGroup> getGroups()

getTracks

java.util.List<ITrack> getTracks()

Return all tracks that belong to the track group.

Returns:

the tracks.

getId

java.lang.Integer getId()

A machine identifier for the track

Returns:

the identifier.

getName

java.lang.String getName()

A human readable name of the track

Returns:

the name, or null if not available.

getIdentifier

java.lang.String getIdentifier()

Returns a symbolic name for the track group. You should not rely on that the symbol name is unique. See getId(). Valid character are those that make up a java identifier.

Returns:

the symbol name for the track, or null if not available.

See Also:

Character.isJavaIdentifierPart(char), Character.isJavaIdentifierStart(char)

getAllTracks

java.util.Collection<ITrack> getAllTracks()

Return all tracks that belong to the track group and it's children.

Returns:

all the track under the group.

getGroup

ITrackGroup getGroup(java.lang.String symbolName)

Returns a group given a symbolic name

Returns:

the symbolic name for the group

getAllGroups

java.util.List<ITrackGroup> getAllGroups()

Return all groups and sub groups.

Returns:

all the groups

getProperty

java.lang.Object getProperty(java.lang.String key)

Returns a property value for.

Parameters:

key - the key to look up the value with.

Returns:

the value, or null, if not available.

getRange

ITimeRange getRange()

The time range the track group spans. It's valid for the time span to be shorter than of any track or track group belong to track.

Returns:

the time range

getPath

java.lang.String getPath()

Returns the path of the track

Returns:

the path