com.jrockit.mc.rjmx.flr.internal
Class RecordingDescriptor

java.lang.Object
  com.jrockit.mc.rjmx.flr.internal.RecordingDescriptor

All Implemented Interfaces:

IRecordingDescriptor

public final class RecordingDescriptor
extends java.lang.Object
implements IRecordingDescriptor

This class represents a handle to a server side JRockit Flight Recorder recording. It is immutable, and thus thread safe.

Author:

Marcus Hirt, Mattias Jo\xEBlson

Nested Class Summary

Nested classes/interfaces inherited from interface com.jrockit.mc.rjmx.flr.IRecordingDescriptor

IRecordingDescriptor.RecordingState

Method Summary

boolean	equals(java.lang.Object o)
IConnectionDescriptor	getConnectionDescriptor() An IConnectionDescriptor that describes the source of this recording.
java.util.Date	getDataEndTime() Returns the data end time for this recording.
java.util.Date	getDataStartTime() Returns the data start time for this recording.
long	getDuration() Returns the duration the recording was created with.
java.lang.Long	getId() Returns the id value of the recording.
long	getMaxAge() Returns the recordings maximum event age.
long	getMaxSize() Returns the recordings maximum size.
java.lang.String	getName() Returns the symbolic name of the recording.
javax.management.ObjectName	getObjectName() Returns the object name used to locate the MBean that is used to manage this recording.
java.util.Map	getOptions() Returns a Map with values that describes the various options in the recording.
java.util.Date	getStartTime() Returns the start time for this recording.
IRecordingDescriptor.RecordingState	getState() Returns the state of the recording when this RecordingDescriptor was created.
boolean	getToDisk() Returns whether the recording is stored to disk.
int	hashCode()
boolean	isContinuous() Returns the recording was created as continuous or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getId

public java.lang.Long getId()

Description copied from interface: IRecordingDescriptor

Returns the id value of the recording.

Specified by:

getId in interface IRecordingDescriptor

Returns:

the id value of the recording.

getName

public java.lang.String getName()

Description copied from interface: IRecordingDescriptor

Returns the symbolic name of the recording.

Specified by:

getName in interface IRecordingDescriptor

Returns:

the symbolic name of the recording.

getState

public IRecordingDescriptor.RecordingState getState()

Description copied from interface: IRecordingDescriptor

Returns the state of the recording when this RecordingDescriptor was created.

Specified by:

getState in interface IRecordingDescriptor

Returns:

the state of the recording when this RecordingDescriptor was created.

getOptions

public java.util.Map getOptions()

Description copied from interface: IRecordingDescriptor

Returns a Map with values that describes the various options in the recording. Options can, for instance, be duration and destFile.

Specified by:

getOptions in interface IRecordingDescriptor

Returns:

a Map with values that describes the various options in the recording.

getConnectionDescriptor

public IConnectionDescriptor getConnectionDescriptor()

Description copied from interface: IRecordingDescriptor

An IConnectionDescriptor that describes the source of this recording.

Specified by:

getConnectionDescriptor in interface IRecordingDescriptor

Returns:

a descriptor describing the recording source.

getObjectName

public javax.management.ObjectName getObjectName()

Description copied from interface: IRecordingDescriptor

Returns the object name used to locate the MBean that is used to manage this recording.

Specified by:

getObjectName in interface IRecordingDescriptor

Returns:

the object name used to locate the MBean that is used to manage this recording.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDataStartTime

public java.util.Date getDataStartTime()

Description copied from interface: IRecordingDescriptor

Returns the data start time for this recording.

Specified by:

getDataStartTime in interface IRecordingDescriptor

Returns:

the data start time for the recording

getDataEndTime

public java.util.Date getDataEndTime()

Description copied from interface: IRecordingDescriptor

Returns the data end time for this recording.

Specified by:

getDataEndTime in interface IRecordingDescriptor

Returns:

the data end time for the recording

getStartTime

public java.util.Date getStartTime()

Description copied from interface: IRecordingDescriptor

Returns the start time for this recording.

Specified by:

getStartTime in interface IRecordingDescriptor

Returns:

the start time for this recording, or null if not available

getDuration

public long getDuration()

Description copied from interface: IRecordingDescriptor

Returns the duration the recording was created with.

Specified by:

getDuration in interface IRecordingDescriptor

Returns:

the duration of the recording in ms (0 means continuous), or -1 if unavailable

isContinuous

public boolean isContinuous()

Description copied from interface: IRecordingDescriptor

Returns the recording was created as continuous or not.

Specified by:

isContinuous in interface IRecordingDescriptor

Returns:

true if the recording was created continuous, or false if not

getToDisk

public boolean getToDisk()

Description copied from interface: IRecordingDescriptor

Returns whether the recording is stored to disk.

Specified by:

getToDisk in interface IRecordingDescriptor

Returns:

true if the recording is stored to disk, false otherwise

getMaxAge

public long getMaxAge()

Description copied from interface: IRecordingDescriptor

Returns the recordings maximum event age.

Specified by:

getMaxAge in interface IRecordingDescriptor

Returns:

the maximum event age of the recording

getMaxSize

public long getMaxSize()

Description copied from interface: IRecordingDescriptor

Returns the recordings maximum size.

Specified by:

getMaxSize in interface IRecordingDescriptor

Returns:

the maximum size of the recording