Package org.openjdk.jmc.flightrecorder.writer

Class RecordingImpl

java.lang.Object

org.openjdk.jmc.flightrecorder.writer.api.Recording

org.openjdk.jmc.flightrecorder.writer.RecordingImpl

All Implemented Interfaces:

AutoCloseable

public final class RecordingImpl
extends Recording

The main entry point to JFR recording functionality. Allows to define custom types and initiate chunks for writing user events.

Constructor Summary

Constructors

Constructor	Description
RecordingImpl(OutputStream output, RecordingSettings settings)

Method Summary

Modifier and Type	Method	Description
void	close()
TypeImpl	getType(String typeName)	Try retrieving a previously registered custom type.
TypeImpl	getType(Types.JDK type)	A convenience method to easily get to JDK registered custom types in type-safe manner.
TypesImpl	getTypes()
TypeImpl	registerAnnotationType(String name)	Try registering a user annotation type.
TypeImpl	registerAnnotationType(String name, Consumer<TypeStructureBuilder> builderCallback)	Try registering a user annotation type.
TypeImpl	registerEventType(String name)	Try registering a user event type with no additional attributes.
TypeImpl	registerEventType(String name, Consumer<TypeStructureBuilder> builderCallback)	Try registering a user event type.
TypeImpl	registerType(String name, String supertype, Consumer<TypeStructureBuilder> builderCallback)	Try registering a custom type.
TypeImpl	registerType(String name, Consumer<TypeStructureBuilder> builderCallback)	Try registering a custom type.
RecordingImpl	rotateChunk()
RecordingImpl	writeEvent(TypedValue event)	Write a custom event

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecordingImpl

public RecordingImpl(OutputStream output,
                     RecordingSettings settings)

Method Detail

rotateChunk

public RecordingImpl rotateChunk()

Specified by:

rotateChunk in class Recording

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in class Recording

Throws:

IOException

writeEvent

public RecordingImpl writeEvent(TypedValue event)

Description copied from class: Recording

Write a custom event

Specified by:

writeEvent in class Recording

Parameters:

event - the event value

Returns:

this for chaining

registerEventType

public TypeImpl registerEventType(String name)

Description copied from class: Recording

Try registering a user event type with no additional attributes. If a same-named event already exists it will be returned.

Specified by:

registerEventType in class Recording

Parameters:

name - the event name

Returns:

a user event type of the given name

registerEventType

public TypeImpl registerEventType(String name,
                                  Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Recording

Try registering a user event type. If a same-named event already exists it will be returned.

Specified by:

registerEventType in class Recording

Parameters:

name - the event name

builderCallback - will be called with the active TypeStructureBuilder when the event is newly registered

Returns:

a user event type of the given name

registerAnnotationType

public TypeImpl registerAnnotationType(String name)

Description copied from class: Recording

Try registering a user annotation type. If a same-named annotation already exists it will be returned.

Specified by:

registerAnnotationType in class Recording

Parameters:

name - the annotation name

Returns:

a user annotation type of the given name

registerAnnotationType

public TypeImpl registerAnnotationType(String name,
                                       Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Recording

Try registering a user annotation type. If a same-named annotation already exists it will be returned.

Specified by:

registerAnnotationType in class Recording

Parameters:

name - the annotation name

builderCallback - will be called with the active TypeStructureBuilder when the annotation is newly registered

Returns:

a user annotation type of the given name

registerType

public TypeImpl registerType(String name,
                             Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Recording

Try registering a custom type. If a same-named type already exists it will be returned.

Specified by:

registerType in class Recording

Parameters:

name - the type name

builderCallback - will be called with the active TypeStructureBuilder when the type is newly registered

Returns:

a custom type of the given name

registerType

public TypeImpl registerType(String name,
                             String supertype,
                             Consumer<TypeStructureBuilder> builderCallback)

Description copied from class: Recording

Try registering a custom type. If a same-named type already exists it will be returned.

Specified by:

registerType in class Recording

Parameters:

name - the type name

supertype - the super type name

builderCallback - will be called with the active TypeStructureBuilder when the type is newly registered

Returns:

a custom type of the given name

getType

public TypeImpl getType(Types.JDK type)

Description copied from class: Recording

A convenience method to easily get to JDK registered custom types in type-safe manner.

Specified by:

getType in class Recording

Parameters:

type - the type

Returns:

the previously registered JDK type

getType

public TypeImpl getType(String typeName)

Description copied from class: Recording

Try retrieving a previously registered custom type.

Specified by:

getType in class Recording

Parameters:

typeName - the type name

Returns:

the previously registered custom type

getTypes

public TypesImpl getTypes()

Specified by:

getTypes in class Recording

Returns:

the associated Types instance