Skip navigation links
A B C D E F G H I J L M N P R S T U V W 

A

addListener(FlightRecorderListener) - Static method in class jdk.jfr.FlightRecorder
Adds a recorder listener and captures the AccessControlContext to use when invoking the listener.
addPeriodicEvent(Class<? extends Event>, Runnable) - Static method in class jdk.jfr.FlightRecorder
Adds a hook for a periodic event.
AnnotationElement - Class in jdk.jfr
Describes event metadata, such as labels, descriptions and units.
AnnotationElement(Class<? extends Annotation>, Map<String, Object>) - Constructor for class jdk.jfr.AnnotationElement
Creates an annotation element to use for dynamically defined events.
AnnotationElement(Class<? extends Annotation>, Object) - Constructor for class jdk.jfr.AnnotationElement
Creates an annotation element to use for dynamically defined events.
AnnotationElement(Class<? extends Annotation>) - Constructor for class jdk.jfr.AnnotationElement
Creates an annotation element to use for dynamically defined events.

B

begin() - Method in class jdk.jfr.Event
Starts the timing of this event.
BITS - Static variable in annotation type jdk.jfr.DataAmount
Unit for bits
BooleanFlag - Annotation Type in jdk.jfr
Event field annotation, specifies that the value is a boolean flag, a true or false value
BYTES - Static variable in annotation type jdk.jfr.DataAmount
Unit for bytes

C

Category - Annotation Type in jdk.jfr
Event annotation, to associate the event type with a category, in the format of a human-readable path.
clone() - Method in class jdk.jfr.internal.Control
 
close() - Method in class jdk.jfr.Recording
Releases all data that is associated with this recording.
combine(Set<String>) - Method in class jdk.jfr.internal.Control
 
combine(Set<String>) - Method in class jdk.jfr.SettingControl
Combines the setting values for all running recordings into one value when multiple recordings are running at the same time,
commit() - Method in class jdk.jfr.Event
Writes the field values, time stamp, and event duration to the Flight Recorder system.
Configuration - Class in jdk.jfr
A collection of settings and metadata describing the configuration.
ContentType - Annotation Type in jdk.jfr
Meta annotation, specifies that an annotation represents a content type, such as a time span or a frequency.
Control - Class in jdk.jfr.internal
 
Control(AccessControlContext) - Constructor for class jdk.jfr.internal.Control
 
copy(boolean) - Method in class jdk.jfr.Recording
Returns a clone of this recording, with a new recording ID and name.
create(Path) - Static method in class jdk.jfr.Configuration
Reads a configuration from a file.
create(Reader) - Static method in class jdk.jfr.Configuration
Reads a configuration from a character stream.
create(List<AnnotationElement>, List<ValueDescriptor>) - Static method in class jdk.jfr.EventFactory
Creates an EventFactory object.

D

DataAmount - Annotation Type in jdk.jfr
Event field annotation, specifies that a value represents an amount of data (for example, bytes).
Description - Annotation Type in jdk.jfr
Annotation that describes an element by using a sentence or two.
disable(String) - Method in class jdk.jfr.Recording
Disables event with the specified name.
disable(Class<? extends Event>) - Method in class jdk.jfr.Recording
Disables event.
dump(Path) - Method in class jdk.jfr.Recording
Writes recording data to a file.

E

enable(String) - Method in class jdk.jfr.Recording
Enables the event with the specified name.
enable(Class<? extends Event>) - Method in class jdk.jfr.Recording
Enables event.
Enabled - Annotation Type in jdk.jfr
Event annotation, determines if an event should be enabled by default.
end() - Method in class jdk.jfr.Event
Ends the timing of this event.
Event - Class in jdk.jfr
Base class for events, to be subclassed in order to define events and their fields.
Event() - Constructor for class jdk.jfr.Event
Sole constructor, for invocation by subclass constructors, typically implicit.
EventFactory - Class in jdk.jfr
Class for defining an event at runtime.
EventSettings - Class in jdk.jfr
Convenience class for applying event settings to a recording.
EventType - Class in jdk.jfr
Describes an event, its fields, settings and annotations.
Experimental - Annotation Type in jdk.jfr
Annotation that specifies that an element is experimental and may change without notice.

F

FlightRecorder - Class in jdk.jfr
Class for accessing, controlling, and managing Flight Recorder.
FlightRecorderListener - Interface in jdk.jfr
Callback interface to monitor Flight Recorder's life cycle.
FlightRecorderPermission - Class in jdk.jfr
Permission for controlling access to Flight Recorder.
FlightRecorderPermission(String) - Constructor for class jdk.jfr.FlightRecorderPermission
Constructs a FlightRecorderPermission with the specified name.
Frequency - Annotation Type in jdk.jfr
Event field annotation, specifies that the value is a frequency, measured in Hz.

G

getAnnotation(Class<? extends Annotation>) - Method in class jdk.jfr.AnnotationElement
Returns the first annotation for the specified type if an AnnotationElement with the same name exists, else null.
getAnnotation(Class<A>) - Method in class jdk.jfr.EventType
Returns the first annotation for the specified type if an annotation element with the same name is directly present, otherwise null.
getAnnotation(Class<A>) - Method in class jdk.jfr.SettingDescriptor
Returns the first annotation for the specified type if an annotation element with the same name is available, null otherwise.
getAnnotation(Class<A>) - Method in class jdk.jfr.ValueDescriptor
Returns the first annotation for the specified type if an annotation element with the same name is directly present for this value descriptor, null otherwise.
getAnnotationElements() - Method in class jdk.jfr.AnnotationElement
Returns an immutable list of annotation elements for this AnnotationElement.
getAnnotationElements() - Method in class jdk.jfr.EventType
Returns an immutable list of annotation elements for this event type.
getAnnotationElements() - Method in class jdk.jfr.SettingDescriptor
Returns an immutable list of annotation elements for this value descriptor.
getAnnotationElements() - Method in class jdk.jfr.ValueDescriptor
Returns an immutable list of annotation elements for this value descriptor.
getCategoryNames() - Method in class jdk.jfr.EventType
Returns the list of human-readable names that makes up the categories for this event type (for example, "Java Application", "Statistics").
getConfiguration(String) - Static method in class jdk.jfr.Configuration
Returns a predefined configuration.
getConfigurations() - Static method in class jdk.jfr.Configuration
Returns an immutable list of predefined configurations for this Java Virtual Machine (JVM).
getContents() - Method in class jdk.jfr.Configuration
Returns a textual representation of the configuration (for example, the contents of a JFC file).
getContentType() - Method in class jdk.jfr.SettingDescriptor
Returns a textual identifier that specifies how a value that is represented by this SettingDescriptor object is interpreted or formatted.
getContentType() - Method in class jdk.jfr.ValueDescriptor
Returns a textual identifier that specifies how a value represented by this ValueDescriptor is interpreted or formatted.
getDefaultValue() - Method in class jdk.jfr.SettingDescriptor
Returns the default value for this setting descriptor.
getDescription() - Method in class jdk.jfr.Configuration
Returns a short sentence that describes the configuration (for example "Low overhead configuration safe for continuous use in production environments")
getDescription() - Method in class jdk.jfr.EventType
Returns a short sentence that describes the event class.
getDescription() - Method in class jdk.jfr.SettingDescriptor
Returns a sentence that describes the setting (for example "Record event with duration above or equal to threshold").
getDescription() - Method in class jdk.jfr.ValueDescriptor
Returns a sentence describing the value (for example, {@code "Maximum throughput in the transaction system.
getDestination() - Method in class jdk.jfr.Recording
Returns the destination file, where recording data is written when the recording stops, or null if no destination is set.
getDumpOnExit() - Method in class jdk.jfr.Recording
Returns whether this recording is dumped to disk when the JVM exits.
getDuration() - Method in class jdk.jfr.Recording
Returns the specified duration for this recording, or null if no duration is set.
getEventType() - Method in class jdk.jfr.EventFactory
Returns the event type that is associated with this event factory.
getEventType(Class<? extends Event>) - Static method in class jdk.jfr.EventType
Returns the event type for an event class, or null if it doesn't exist.
getEventTypes() - Method in class jdk.jfr.FlightRecorder
Returns an immutable list that contains all currently registered events.
getField(String) - Method in class jdk.jfr.EventType
Returns the field with the specified name, or null if it doesn't exist.
getFields() - Method in class jdk.jfr.EventType
Returns an immutable list of descriptors that describe the event fields of this event type.
getFields() - Method in class jdk.jfr.ValueDescriptor
Returns an immutable list of value descriptors if the type is complex, else an empty list.
getFlightRecorder() - Static method in class jdk.jfr.FlightRecorder
Returns the Flight Recorder for the platform.
getId() - Method in class jdk.jfr.EventType
Returns a unique ID for this event type in the Java Virtual Machine (JVM).
getId() - Method in class jdk.jfr.Recording
Returns a unique ID for this recording.
getLabel() - Method in class jdk.jfr.Configuration
Returns a human-readable name (for example, "Continuous" or "Profiling"}.
getLabel() - Method in class jdk.jfr.EventType
Returns a human-readable name (for example, "CPU Load").
getLabel() - Method in class jdk.jfr.SettingDescriptor
Returns a human-readable name that describes the setting (for example, "Threshold").
getLabel() - Method in class jdk.jfr.ValueDescriptor
Returns a human-readable name that describes the value (for example, "Maximum Throughput").
getMaxAge() - Method in class jdk.jfr.Recording
Returns the length of time that the data is kept in the disk repository before it is removed.
getMaxSize() - Method in class jdk.jfr.Recording
Returns the maximum size, measured in bytes, at which data is no longer kept in the disk repository.
getName() - Method in class jdk.jfr.Configuration
Returns an identifying name (for example, "default" or "profile").
getName() - Method in class jdk.jfr.EventType
Returns an identifier for the event (for example, "jdk.CPULoad").
getName() - Method in class jdk.jfr.Recording
Returns the name of this recording.
getName() - Method in class jdk.jfr.SettingDescriptor
Returns the name of the setting (for example, "threshold").
getName() - Method in class jdk.jfr.ValueDescriptor
Returns the name of the value (for example, "maxThroughput").
getProvider() - Method in class jdk.jfr.Configuration
Returns who created the configuration (for example "OpenJDK").
getRecordings() - Method in class jdk.jfr.FlightRecorder
Returns an immutable list of the available recordings.
getSettingDescriptors() - Method in class jdk.jfr.EventType
Returns an immutable list of the setting descriptors that describe the available event settings for this event type.
getSettings() - Method in class jdk.jfr.Configuration
Returns the settings that specifies how a recording is configured.
getSettings() - Method in class jdk.jfr.Recording
Returns settings used by this recording.
getSize() - Method in class jdk.jfr.Recording
Returns the current size of this recording in the disk repository, measured in bytes.
getStartTime() - Method in class jdk.jfr.Recording
Returns the time when this recording was started.
getState() - Method in class jdk.jfr.Recording
Returns the recording state that this recording is currently in.
getStopTime() - Method in class jdk.jfr.Recording
Returns the time when this recording was stopped.
getStream(Instant, Instant) - Method in class jdk.jfr.Recording
Creates a data stream for a specified interval.
getTypeId() - Method in class jdk.jfr.AnnotationElement
Returns the type ID for this AnnotationElement.
getTypeId() - Method in class jdk.jfr.SettingDescriptor
Returns a unique ID for the type in the Java Virtual Machine (JVM).
getTypeId() - Method in class jdk.jfr.ValueDescriptor
Returns a unique ID for the type in the Java virtual Machine (JVM).
getTypeName() - Method in class jdk.jfr.AnnotationElement
Returns the fully qualified name of the annotation type that corresponds to this AnnotationElement (for example, "jdk.jfr.Label").
getTypeName() - Method in class jdk.jfr.SettingDescriptor
Returns the fully qualified class name of the type that is associated with this setting descriptor.
getTypeName() - Method in class jdk.jfr.ValueDescriptor
Returns the fully qualified class name of the type that is associated with this value descriptor.
getValue(String) - Method in class jdk.jfr.AnnotationElement
Returns a value for this AnnotationElement.
getValue() - Method in class jdk.jfr.internal.Control
 
getValue() - Method in class jdk.jfr.SettingControl
Returns the currently used value for this setting, not null.
getValueDescriptors() - Method in class jdk.jfr.AnnotationElement
Returns an immutable list of descriptors that describes the annotation values for this AnnotationElement.
getValues() - Method in class jdk.jfr.AnnotationElement
Returns an immutable list of annotation values in an order that matches the value descriptors for this AnnotationElement.

H

hasValue(String) - Method in class jdk.jfr.AnnotationElement
Returns true if an annotation value with the specified name exists in this AnnotationElement.

I

isArray() - Method in class jdk.jfr.ValueDescriptor
Returns if this value descriptor is an array type.
isAvailable() - Static method in class jdk.jfr.FlightRecorder
Returns true if the Java Virtual Machine (JVM) has Flight Recorder capabilities.
isEnabled() - Method in class jdk.jfr.Event
Returns true if at least one recording is running, and the enabled setting for this event is set to true, otherwise false is returned.
isEnabled() - Method in class jdk.jfr.EventType
Returns true if the event is enabled and at least one recording is running, false otherwise.
isInitialized() - Static method in class jdk.jfr.FlightRecorder
Returns true if Flight Recorder is initialized.
isToDisk() - Method in class jdk.jfr.Recording
Returns true if this recording uses the disk repository, false otherwise.

J

jdk.jfr - package jdk.jfr
This package provides classes to create events and control Flight Recorder.
jdk.jfr.internal - package jdk.jfr.internal
 

L

Label - Annotation Type in jdk.jfr
Annotation that sets a human-readable name for an element (for example, "Maximum Throughput").

M

MemoryAddress - Annotation Type in jdk.jfr
Event field annotation, specifies that the value is a memory address.
MetadataDefinition - Annotation Type in jdk.jfr
Meta annotation for defining new types of event metadata.
MICROSECONDS - Static variable in annotation type jdk.jfr.Timespan
Unit for microseconds.
MILLISECONDS - Static variable in annotation type jdk.jfr.Timespan
Unit for milliseconds.
MILLISECONDS_SINCE_EPOCH - Static variable in annotation type jdk.jfr.Timestamp
The unit for the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.

N

NAME - Static variable in annotation type jdk.jfr.Enabled
Setting name "enabled", signifies that the event should be recorded.
Name - Annotation Type in jdk.jfr
Annotation that overrides the default name for an element (for example, when the default package for an event is not appropriate).
NAME - Static variable in annotation type jdk.jfr.Period
Settings name "period" for configuring periodic events
NAME - Static variable in annotation type jdk.jfr.StackTrace
Settings name "stackTrace" to be used for enabling event stack traces.
NAME - Static variable in annotation type jdk.jfr.Threshold
Setting name "threshold" for configuring event thresholds.
NANOSECONDS - Static variable in annotation type jdk.jfr.Timespan
Unit for nanoseconds.
newEvent() - Method in class jdk.jfr.EventFactory
Instantiates an event, so it can be populated with data and written to the Flight Recorder system.

P

Percentage - Annotation Type in jdk.jfr
Event field annotation to use on fractions, typically between 0.0 and 1.0, to specify that the value is a percentage.
Period - Annotation Type in jdk.jfr
Event annotation, specifies the default setting value for a periodic event.

R

recorderInitialized(FlightRecorder) - Method in interface jdk.jfr.FlightRecorderListener
Receives notification when Flight Recorder is initialized.
Recording - Class in jdk.jfr
Provides means to configure, start, stop and dump recording data to disk.
Recording(Map<String, String>) - Constructor for class jdk.jfr.Recording
 
Recording() - Constructor for class jdk.jfr.Recording
Creates a recording without any settings.
Recording(Configuration) - Constructor for class jdk.jfr.Recording
Creates a recording with settings from a configuration.
RecordingState - Enum in jdk.jfr
Indicates a state in the life cycle of a recording.
recordingStateChanged(Recording) - Method in interface jdk.jfr.FlightRecorderListener
Receives notification when the state of a recording changes.
register() - Method in class jdk.jfr.EventFactory
Registers an unregistered event.
register(Class<? extends Event>) - Static method in class jdk.jfr.FlightRecorder
Registers an event class.
Registered - Annotation Type in jdk.jfr
Event annotation, for programmatic event registration.
Relational - Annotation Type in jdk.jfr
Meta annotation for relational annotations, to be used on an annotation.
removeListener(FlightRecorderListener) - Static method in class jdk.jfr.FlightRecorder
Removes a recorder listener.
removePeriodicEvent(Runnable) - Static method in class jdk.jfr.FlightRecorder
Removes a hook for a periodic event.

S

scheduleStart(Duration) - Method in class jdk.jfr.Recording
Starts this recording after a delay.
SECONDS - Static variable in annotation type jdk.jfr.Timespan
Unit for seconds.
set(int, Object) - Method in class jdk.jfr.Event
Sets a field value.
setDestination(Path) - Method in class jdk.jfr.Recording
Sets a location where data is written on recording stop, or null if data is not to be dumped.
setDumpOnExit(boolean) - Method in class jdk.jfr.Recording
Sets whether this recording is dumped to disk when the JVM exits.
setDuration(Duration) - Method in class jdk.jfr.Recording
Sets a duration for how long a recording runs before it stops.
setMaxAge(Duration) - Method in class jdk.jfr.Recording
Determines how far back data is kept in the disk repository.
setMaxSize(long) - Method in class jdk.jfr.Recording
Determines how much data is kept in the disk repository.
setName(String) - Method in class jdk.jfr.Recording
Sets a human-readable name (for example, "My Recording").
setSettings(Map<String, String>) - Method in class jdk.jfr.Recording
Replaces all settings for this recording.
SettingControl - Class in jdk.jfr
Base class to extend to create setting controls.
SettingControl() - Constructor for class jdk.jfr.SettingControl
Constructor for invocation by subclass constructors.
SettingDefinition - Annotation Type in jdk.jfr
Annotation that specifies that a method in an event class should be used to filter out events.
SettingDescriptor - Class in jdk.jfr
Describes an event setting.
setToDisk(boolean) - Method in class jdk.jfr.Recording
Determines whether this recording is continuously flushed to the disk repository or data is constrained to what is available in memory buffers.
setValue(String) - Method in class jdk.jfr.internal.Control
 
setValue(String) - Method in class jdk.jfr.SettingControl
Sets the value for this setting.
shouldCommit() - Method in class jdk.jfr.Event
Returns true if the enabled setting for this event is set to true and if the duration is within the threshold for the event, false otherwise.
StackTrace - Annotation Type in jdk.jfr
Event annotation, determines whether an event by default has a stack trace or not.
start() - Method in class jdk.jfr.Recording
Starts this recording.
stop() - Method in class jdk.jfr.Recording
Stops this recording.

T

takeSnapshot() - Method in class jdk.jfr.FlightRecorder
Creates a snapshot of all available recorded data.
Threshold - Annotation Type in jdk.jfr
Event annotation, specifies the default duration below which an event is not recorded (for example, "20 ms").
TICKS - Static variable in annotation type jdk.jfr.Timespan
Unit for ticks.
TICKS - Static variable in annotation type jdk.jfr.Timestamp
The unit for the number of ticks that have transpired since some arbitrary starting date.
Timespan - Annotation Type in jdk.jfr
Event field annotation, specifies that the value is a duration.
Timestamp - Annotation Type in jdk.jfr
Event field annotation, specifies that the value is a point in time.
TransitionFrom - Annotation Type in jdk.jfr
Event field annotation, specifies that the event transitioned from a thread.
TransitionTo - Annotation Type in jdk.jfr
Event field annotation, specifies that the event will soon transition to a thread.

U

unregister() - Method in class jdk.jfr.EventFactory
Unregisters the event that is associated with this event factory.
unregister(Class<? extends Event>) - Static method in class jdk.jfr.FlightRecorder
Unregisters an event class.
Unsigned - Annotation Type in jdk.jfr
Event field annotation, specifies that the value is of an unsigned data type.

V

ValueDescriptor - Class in jdk.jfr
Describes the event fields and annotation elements.
ValueDescriptor(Class<?>, String) - Constructor for class jdk.jfr.ValueDescriptor
Constructs a value descriptor, useful for dynamically creating event types and annotations.
ValueDescriptor(Class<?>, String, List<AnnotationElement>) - Constructor for class jdk.jfr.ValueDescriptor
Constructs a value descriptor, useful for dynamically creating event types and annotations.
valueOf(String) - Static method in enum jdk.jfr.RecordingState
Returns the enum constant of this type with the specified name.
values() - Static method in enum jdk.jfr.RecordingState
Returns an array containing the constants of this enum type, in the order they are declared.

W

with(String, String) - Method in class jdk.jfr.EventSettings
Sets a setting value for the event that is associated with this event setting.
withoutStackTrace() - Method in class jdk.jfr.EventSettings
Disables stack traces for the event that is associated with this event setting.
withoutThreshold() - Method in class jdk.jfr.EventSettings
Specifies that a threshold is not used.
withPeriod(Duration) - Method in class jdk.jfr.EventSettings
Sets the interval for the event that is associated with this event setting.
withStackTrace() - Method in class jdk.jfr.EventSettings
Enables stack traces for the event that is associated with this event setting.
withThreshold(Duration) - Method in class jdk.jfr.EventSettings
Sets the threshold for the event that is associated with this event setting.
A B C D E F G H I J L M N P R S T U V W 
Skip navigation links