Package org.openjdk.jmc.flightrecorder.parser

Interface IParserExtension

All Known Implementing Classes:

FilterExtension, SyntheticAttributeExtension

public interface IParserExtension

Interface for Flight Recorder parser extensions. Implementations are normally stateless and their prime responsibility is to create and link IEventSinkFactory instances.

See the package documentation for a longer discussion on how parser extensions work.

Method Summary

Modifier and Type	Method	Description
default IConstantPoolExtension	createConstantPoolExtension()	creates an instance of IConstantPoolExtension at the beginning of the load of a recording
default IEventSinkFactory	getEventSinkFactory(IEventSinkFactory subFactory)	Get a new event sink factory for use during the reading of one Flight Recording.
default String	getValueInterpretation(String eventTypeId, String fieldId)	Override the value interpretation.

Method Detail

getValueInterpretation

default String getValueInterpretation(String eventTypeId,
                                      String fieldId)

Override the value interpretation. If not overridden the values types are automatically selected from the read metadata. This is only used for a special case in Mission Control code so normally null should be returned.

Parameters:

eventTypeId - event type ID to get interpretation for

fieldId - field ID within the event type to get interpretation for

Returns:

the identifier of the value interpretation or null to use the default interpretation

getEventSinkFactory

default IEventSinkFactory getEventSinkFactory(IEventSinkFactory subFactory)

Get a new event sink factory for use during the reading of one Flight Recording.

Note that it is the implementor's responsibility to make sure that the subfactory is used by the event sink factory. If the IEventSinkFactory.create call is not chained to the subfactory, then events will be lost.

Parameters:

subFactory - Subfactory to nest. Events created by the returned factory will normally be passed on to sinks created by the nested subfactory.

Returns:

a new event sink factory

createConstantPoolExtension

default IConstantPoolExtension createConstantPoolExtension()

creates an instance of IConstantPoolExtension at the beginning of the load of a recording

Returns:

an instance implementing IConstantPoolExtension