com.jrockit.mc.flightrecorder.spi
Interface IEventType

All Known Implementing Classes:

EventType

public interface IEventType

Interface for an event type. An event type describes static metadata about an event. It also contains the IFields that can be used to access event values.

Author:

Erik Gahlin

Method Summary

int	getBitField() Gets the bit field for the event type.
java.awt.Color	getColor() Returns the color associated with the event type.
java.lang.String	getDescription() Return a description of the event type.
IField	getField(java.lang.String identifier) Returns a field for the event type, or null if not available.
java.util.Collection<java.lang.String>	getFieldIdentifiers() Returns the fields for the event type.
java.util.Collection<IField>	getFields() Returns the fields for the event type.
java.lang.Integer	getId() Returns an identifier for the event type.
java.lang.String	getName() Return a human readable name for the event type.
java.lang.String	getPath() Return a symbolic name for the event type.
IProducer	getProducer() Returns the producer for the event type.
void	setBitField(int i) Sets the the bit field for the event type.

Method Detail

getName

java.lang.String getName()

Return a human readable name for the event type.

Returns:

the name

getPath

java.lang.String getPath()

Return a symbolic name for the event type. The path can be use used to identify the event type in hierarchal way.

Returns:

the path for the event type.

getDescription

java.lang.String getDescription()

Return a description of the event type.

Returns:

a description of the event type.

getBitField

int getBitField()

Gets the bit field for the event type.

Returns:

the bit field

setBitField

void setBitField(int i)

Sets the the bit field for the event type.

getProducer

IProducer getProducer()

Returns the producer for the event type.

Returns:

the producer for the event type.

getFields

java.util.Collection<IField> getFields()

Returns the fields for the event type.

Returns:

all fields for the event type.

getField

IField getField(java.lang.String identifier)

Returns a field for the event type, or null if not available.

Parameters:

identifier - the identifier for the field

Returns:

a field

getColor

java.awt.Color getColor()

Returns the color associated with the event type.

Returns:

the color for the event type.

getId

java.lang.Integer getId()

Returns an identifier for the event type. The identifier must be unique for the producer.

Returns:

the identifier

getFieldIdentifiers

java.util.Collection<java.lang.String> getFieldIdentifiers()

Returns the fields for the event type.

Returns:

all fields for the event type.