Convenience class for applying event settings to a recording.

An EventSettings object for a recording can be obtained by invoking the Recording#enable(String) method which is configured using method chaining.

The following example shows how to use the EventSettings class.

try (Recording r = new Recording()) {
    r.enable("jdk.CPULoad")
     .withPeriod(Duration.ofSeconds(1));
    r.enable("jdk.FileWrite")
     .withoutStackTrace()
     .withThreshold(Duration.ofNanos(10));
    r.start();
    Thread.sleep(10_000);
    r.stop();
    r.dump(Files.createTempFile("recording", ".jfr"));
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	EventSettings.DelegatedEventSettings
private static class	EventSettings.InternalAccess

Access	Constructor and Description
pack-priv	EventSettings()

Method Summary

Modifier and Type	Method and Description
pack-priv abstract Map<String, String>	Returns: a settings `Map`, not `null` toMap() Creates a settings `Map` for the event that is associated with this event setting.
public abstract EventSettings	Returns: event settings object for further configuration, not `null` with(String the name of the setting (for example, `"threshold"`) name, String the value to set (for example `"20 ms"` not `null`) value) Sets a setting value for the event that is associated with this event setting.
public final EventSettings	Returns: event settings object for further configuration, not `null` withoutStackTrace() Disables stack traces for the event that is associated with this event setting.
public final EventSettings	Returns: event settings object for further configuration, not `null` withoutThreshold() Specifies that a threshold is not used.
public final EventSettings	Returns: event settings object for further configuration, not `null` withPeriod(Duration the duration, not `null` duration) Sets the interval for the event that is associated with this event setting.
public final EventSettings	Returns: event settings object for further configuration, not `null` withStackTrace() Enables stack traces for the event that is associated with this event setting.
public final EventSettings	Returns: event settings object for further configuration, not `null` withThreshold(Duration the duration, or `null` if no duration is used duration) Sets the threshold for the event that is associated with this event setting.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

EventSettings	back to summary
pack-priv EventSettings()

Method Detail

toMap back to summary

toMap	back to summary
pack-priv abstract Map<String, String> toMap() Creates a settings `Map` for the event that is associated with this event setting. Returns:Map<String, String> a settings `Map`, not `null`

pack-priv abstract Map<String, String> toMap()

Creates a settings Map for the event that is associated with this event setting.

Returns:Map<String, String>: a settings Map, not null

with back to summary

with	back to summary
public abstract EventSettings with(String name, String value) Sets a setting value for the event that is associated with this event setting. Parameters name:String the name of the setting (for example, `"threshold"`) value:String the value to set (for example `"20 ms"` not `null`) Returns:EventSettings event settings object for further configuration, not `null`

public abstract EventSettings with(String name, String value)

Sets a setting value for the event that is associated with this event setting.

Parameters

name:String: the name of the setting (for example, "threshold")
value:String: the value to set (for example "20 ms" not null)

Returns:EventSettings

event settings object for further configuration, not null

withoutStackTrace back to summary

withoutStackTrace	back to summary
public final EventSettings withoutStackTrace() Disables stack traces for the event that is associated with this event setting. Equivalent to invoking the `with("stackTrace", "false")` method. Returns:EventSettings event settings object for further configuration, not `null`

public final EventSettings withoutStackTrace()

Disables stack traces for the event that is associated with this event setting.

Equivalent to invoking the with("stackTrace", "false") method.

Returns:EventSettings: event settings object for further configuration, not null

withoutThreshold back to summary

withoutThreshold	back to summary
public final EventSettings withoutThreshold() Specifies that a threshold is not used. This is a convenience method, equivalent to invoking the `with("threshold", "0 s")` method. Returns:EventSettings event settings object for further configuration, not `null`

public final EventSettings withoutThreshold()

Specifies that a threshold is not used.

This is a convenience method, equivalent to invoking the with("threshold", "0 s") method.

Returns:EventSettings: event settings object for further configuration, not null

withPeriod back to summary

withPeriod	back to summary
public final EventSettings withPeriod(Duration duration) Sets the interval for the event that is associated with this event setting. Parameters duration:Duration the duration, not `null` Returns:EventSettings event settings object for further configuration, not `null`

public final EventSettings withPeriod(Duration duration)

Sets the interval for the event that is associated with this event setting.

Parameters

duration:Duration: the duration, not null

Returns:EventSettings

event settings object for further configuration, not null

withStackTrace back to summary

withStackTrace	back to summary
public final EventSettings withStackTrace() Enables stack traces for the event that is associated with this event setting. Equivalent to invoking the `with("stackTrace", "true")` method. Returns:EventSettings event settings object for further configuration, not `null`

public final EventSettings withStackTrace()

Enables stack traces for the event that is associated with this event setting.

Equivalent to invoking the with("stackTrace", "true") method.

Returns:EventSettings: event settings object for further configuration, not null

withThreshold back to summary

withThreshold	back to summary
public final EventSettings withThreshold(Duration duration) Sets the threshold for the event that is associated with this event setting. Parameters duration:Duration the duration, or `null` if no duration is used Returns:EventSettings event settings object for further configuration, not `null`

public final EventSettings withThreshold(Duration duration)

Sets the threshold for the event that is associated with this event setting.

Parameters

duration:Duration: the duration, or null if no duration is used

Returns:EventSettings

event settings object for further configuration, not null

jdk.jfr back to summary

pack-priv Class EventSettings.DelegatedEventSettings

Class Inheritance

extends EventSettings

java.lang.Object
jdk.jfr.EventSettings
jdk.jfr.EventSettings.DelegatedEventSettings

Field Summary

Modifier and Type	Field and Description
private final EventSettingsModifier	delegate

Constructor Summary

Access	Constructor and Description
pack-priv	DelegatedEventSettings(EventSettingsModifier modifier)

Method Summary

Modifier and Type	Method and Description
pack-priv Map<String, String>	toMap() Implements abstract jdk.jfr.EventSettings.toMap. Creates a settings `Map` for the event that is associated with this event setting.
public EventSettings	with(String name, String value) Implements abstract jdk.jfr.EventSettings.with. Sets a setting value for the event that is associated with this event setting.

Inherited from jdk.jfr.EventSettings:: withoutStackTrace withoutThreshold withPeriod withStackTrace withThreshold

Field Detail

delegate	back to summary
private final EventSettingsModifier delegate

Constructor Detail

DelegatedEventSettings	back to summary
pack-priv DelegatedEventSettings(EventSettingsModifier modifier)

Method Detail

toMap back to summary

toMap	back to summary
pack-priv Map<String, String> toMap() Implements abstract jdk.jfr.EventSettings.toMap. Doc from jdk.jfr.EventSettings.toMap. Creates a settings `Map` for the event that is associated with this event setting. Annotations @Override

pack-priv Map<String, String> toMap()

Implements abstract jdk.jfr.EventSettings.toMap.

Doc from jdk.jfr.EventSettings.toMap.

Creates a settings Map for the event that is associated with this event setting.

Annotations

@Override

with	back to summary
public EventSettings with(String name, String value) Implements abstract jdk.jfr.EventSettings.with. Doc from jdk.jfr.EventSettings.with. Sets a setting value for the event that is associated with this event setting. Annotations @Override

with

back to summary

public EventSettings with(String name, String value)

Implements abstract jdk.jfr.EventSettings.with.

Doc from jdk.jfr.EventSettings.with.

Sets a setting value for the event that is associated with this event setting.

Annotations

@Override

jdk.jfr back to summary

private final Class EventSettings.InternalAccess

Class Inheritance

extends PrivateAccess

java.lang.Object
jdk.jfr.internal.PrivateAccess
jdk.jfr.EventSettings.InternalAccess

Constructor Summary

Access	Constructor and Description
private	InternalAccess()

Method Summary

Modifier and Type	Method and Description
public String	getFieldName(ValueDescriptor v) Implements abstract jdk.jfr.internal.PrivateAccess.getFieldName.
public PlatformEventType	getPlatformEventType(EventType eventType) Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformEventType.
public PlatformRecorder	getPlatformRecorder() Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformRecorder.
public PlatformRecording	getPlatformRecording(Recording r) Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformRecording.
public Type	getType(Object o) Implements abstract jdk.jfr.internal.PrivateAccess.getType.
public boolean	isConstantPool(ValueDescriptor v) Implements abstract jdk.jfr.internal.PrivateAccess.isConstantPool.
public boolean	isUnsigned(ValueDescriptor v) Implements abstract jdk.jfr.internal.PrivateAccess.isUnsigned.
public boolean	isVisible(EventType t) Implements abstract jdk.jfr.internal.PrivateAccess.isVisible.
public AnnotationElement	newAnnotation(Type annotationType, List<Object> values, boolean boot) Implements abstract jdk.jfr.internal.PrivateAccess.newAnnotation.
public Configuration	newConfiguration(String name, String label, String description, String provider, Map<String, String> settings, String contents) Implements abstract jdk.jfr.internal.PrivateAccess.newConfiguration.
public EventSettings	newEventSettings(EventSettingsModifier esm) Implements abstract jdk.jfr.internal.PrivateAccess.newEventSettings.
public EventType	newEventType(PlatformEventType platformEventType) Implements abstract jdk.jfr.internal.PrivateAccess.newEventType.
public Recording	newRecording(Boolean register) Implements abstract jdk.jfr.internal.PrivateAccess.newRecording.
public SettingDescriptor	newSettingDescriptor(Type type, String name, String defaultValue, List<AnnotationElement> annotations) Implements abstract jdk.jfr.internal.PrivateAccess.newSettingDescriptor.
public ValueDescriptor	newValueDescriptor(String name, Type fieldType, List<AnnotationElement> annos, int dimension, boolean constantPool, String fieldName) Implements abstract jdk.jfr.internal.PrivateAccess.newValueDescriptor.
public ValueDescriptor	newValueDescriptor(Class<?> type, String name) Implements abstract jdk.jfr.internal.PrivateAccess.newValueDescriptor.
public void	setAnnotations(ValueDescriptor v, List<AnnotationElement> a) Implements abstract jdk.jfr.internal.PrivateAccess.setAnnotations.
public void	setAnnotations(SettingDescriptor s, List<AnnotationElement> a) Implements abstract jdk.jfr.internal.PrivateAccess.setAnnotations.

Inherited from jdk.jfr.internal.PrivateAccess:: getInstance setPrivateAccess

Constructor Detail

InternalAccess	back to summary
private InternalAccess()

Method Detail

getFieldName	back to summary
public String getFieldName(ValueDescriptor v) Implements abstract jdk.jfr.internal.PrivateAccess.getFieldName. Annotations @Override

getFieldName

back to summary

public String getFieldName(ValueDescriptor v)

Implements abstract jdk.jfr.internal.PrivateAccess.getFieldName.

Annotations

@Override

getPlatformEventType	back to summary
public PlatformEventType getPlatformEventType(EventType eventType) Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformEventType. Annotations @Override

getPlatformEventType

back to summary

public PlatformEventType getPlatformEventType(EventType eventType)

Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformEventType.

Annotations

@Override

getPlatformRecorder	back to summary
public PlatformRecorder getPlatformRecorder() Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformRecorder. Annotations @Override

getPlatformRecorder

back to summary

public PlatformRecorder getPlatformRecorder()

Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformRecorder.

Annotations

@Override

getPlatformRecording	back to summary
public PlatformRecording getPlatformRecording(Recording r) Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformRecording. Annotations @Override

getPlatformRecording

back to summary

public PlatformRecording getPlatformRecording(Recording r)

Implements abstract jdk.jfr.internal.PrivateAccess.getPlatformRecording.

Annotations

@Override

getType	back to summary
public Type getType(Object o) Implements abstract jdk.jfr.internal.PrivateAccess.getType. Annotations @Override

getType

back to summary

public Type getType(Object o)

Implements abstract jdk.jfr.internal.PrivateAccess.getType.

Annotations

@Override

isConstantPool	back to summary
public boolean isConstantPool(ValueDescriptor v) Implements abstract jdk.jfr.internal.PrivateAccess.isConstantPool. Annotations @Override

isConstantPool

back to summary

public boolean isConstantPool(ValueDescriptor v)

Implements abstract jdk.jfr.internal.PrivateAccess.isConstantPool.

Annotations

@Override

isUnsigned	back to summary
public boolean isUnsigned(ValueDescriptor v) Implements abstract jdk.jfr.internal.PrivateAccess.isUnsigned. Annotations @Override

isUnsigned

back to summary

public boolean isUnsigned(ValueDescriptor v)

Implements abstract jdk.jfr.internal.PrivateAccess.isUnsigned.

Annotations

@Override

isVisible	back to summary
public boolean isVisible(EventType t) Implements abstract jdk.jfr.internal.PrivateAccess.isVisible. Annotations @Override

isVisible

back to summary

public boolean isVisible(EventType t)

Implements abstract jdk.jfr.internal.PrivateAccess.isVisible.

Annotations

@Override

newAnnotation	back to summary
public AnnotationElement newAnnotation(Type annotationType, List<Object> values, boolean boot) Implements abstract jdk.jfr.internal.PrivateAccess.newAnnotation. Annotations @Override

newAnnotation

back to summary

public AnnotationElement newAnnotation(Type annotationType, List<Object> values, boolean boot)

Implements abstract jdk.jfr.internal.PrivateAccess.newAnnotation.

Annotations

@Override

newConfiguration	back to summary
public Configuration newConfiguration(String name, String label, String description, String provider, Map<String, String> settings, String contents) Implements abstract jdk.jfr.internal.PrivateAccess.newConfiguration. Annotations @Override

newConfiguration

back to summary

public Configuration newConfiguration(String name, String label, String description, String provider, Map<String, String> settings, String contents)

Implements abstract jdk.jfr.internal.PrivateAccess.newConfiguration.

Annotations

@Override

newEventSettings	back to summary
public EventSettings newEventSettings(EventSettingsModifier esm) Implements abstract jdk.jfr.internal.PrivateAccess.newEventSettings. Annotations @Override

newEventSettings

back to summary

public EventSettings newEventSettings(EventSettingsModifier esm)

Implements abstract jdk.jfr.internal.PrivateAccess.newEventSettings.

Annotations

@Override

newEventType	back to summary
public EventType newEventType(PlatformEventType platformEventType) Implements abstract jdk.jfr.internal.PrivateAccess.newEventType. Annotations @Override

newEventType

back to summary

public EventType newEventType(PlatformEventType platformEventType)

Implements abstract jdk.jfr.internal.PrivateAccess.newEventType.

Annotations

@Override

newRecording	back to summary
public Recording newRecording(Boolean register) Implements abstract jdk.jfr.internal.PrivateAccess.newRecording. Annotations @Override

newRecording

back to summary

public Recording newRecording(Boolean register)

Implements abstract jdk.jfr.internal.PrivateAccess.newRecording.

Annotations

@Override

newSettingDescriptor	back to summary
public SettingDescriptor newSettingDescriptor(Type type, String name, String defaultValue, List<AnnotationElement> annotations) Implements abstract jdk.jfr.internal.PrivateAccess.newSettingDescriptor. Annotations @Override

newSettingDescriptor

back to summary

public SettingDescriptor newSettingDescriptor(Type type, String name, String defaultValue, List<AnnotationElement> annotations)

Implements abstract jdk.jfr.internal.PrivateAccess.newSettingDescriptor.

Annotations

@Override

newValueDescriptor	back to summary
public ValueDescriptor newValueDescriptor(String name, Type fieldType, List<AnnotationElement> annos, int dimension, boolean constantPool, String fieldName) Implements abstract jdk.jfr.internal.PrivateAccess.newValueDescriptor. Annotations @Override

newValueDescriptor

back to summary

public ValueDescriptor newValueDescriptor(String name, Type fieldType, List<AnnotationElement> annos, int dimension, boolean constantPool, String fieldName)

Implements abstract jdk.jfr.internal.PrivateAccess.newValueDescriptor.

Annotations

@Override

newValueDescriptor	back to summary
public ValueDescriptor newValueDescriptor(Class<?> type, String name) Implements abstract jdk.jfr.internal.PrivateAccess.newValueDescriptor. Annotations @Override

newValueDescriptor

back to summary

public ValueDescriptor newValueDescriptor(Class<?> type, String name)

Implements abstract jdk.jfr.internal.PrivateAccess.newValueDescriptor.

Annotations

@Override

setAnnotations	back to summary
public void setAnnotations(ValueDescriptor v, List<AnnotationElement> a) Implements abstract jdk.jfr.internal.PrivateAccess.setAnnotations. Annotations @Override

setAnnotations

back to summary

public void setAnnotations(ValueDescriptor v, List<AnnotationElement> a)

Implements abstract jdk.jfr.internal.PrivateAccess.setAnnotations.

Annotations

@Override

setAnnotations	back to summary
public void setAnnotations(SettingDescriptor s, List<AnnotationElement> a) Implements abstract jdk.jfr.internal.PrivateAccess.setAnnotations. Annotations @Override

setAnnotations

back to summary

public void setAnnotations(SettingDescriptor s, List<AnnotationElement> a)

Implements abstract jdk.jfr.internal.PrivateAccess.setAnnotations.

Annotations

@Override

public abstract Class EventSettings

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class EventSettings.DelegatedEventSettings

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class EventSettings.InternalAccess

Constructor Summary

Method Summary

Constructor Detail

Method Detail