Overview | Package | Class | Tree | Deprecated | Index | Help
| JProfiler API
PREV NEXT | FRAMES NO FRAMES

A B C D E F G H I L M N O P R S T U V

## A

addAdditionalControlObjectData(String, DataType, boolean) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures an additional data column for control objects.
addAdditionalData(String, DataType) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures an additional data column for probe events.
addBookmark(String) - Static method in class com.jprofiler.api.agent.Controller
  Adds a bookmark at the current time.
addBookmark(String, Color, boolean) - Static method in class com.jprofiler.api.agent.Controller
  Add a bookmark at the current time.
addBookmark(String) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Adds a bookmark at the current time.
addBookmark(String) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Adds a bookmark at the current time.
addCustomTelemetry(String, Unit, float) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures a custom telemetry.
addEvent(ProbeEvent) - Method in interface com.jprofiler.api.agent.probe.ProbeContext
  Publishes an event.
additionalData(Object[]) - Method in interface com.jprofiler.api.agent.probe.ProbeEvent
  Add additional data to the probe event.
addOpenControlObjectTelemetry(String) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures a telemetry that shows the number of open control objects.
addPayloadInfo(PayloadInfo) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Publishes the payload into the call tree.
Aggregation - Enum in com.jprofiler.api.platform.parameters
  Represents all available aggregation levels.
AllocationHotspots - Interface in com.jprofiler.api.platform.data
  Data object for allocation hot spots.
annotatePayloads(boolean) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures if the probe should annotate data into the call tree view.
ArrayDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for an array type.
ArrayType - Enum in com.jprofiler.api.platform.parameters
  Represents all array types in the JVM.
AWT - Static variable in class com.jprofiler.api.agent.TrackingOptions
  Only track AWT, same as `new TrackingOptions().awt(true)`.
awt(boolean) - Method in class com.jprofiler.api.agent.TrackingOptions
  Determines if AWT should be tracked.

## B

BOOLEAN - Static variable in class com.jprofiler.api.agent.probe.DataType
  The data consists of instances of `java.lang.Boolean`.
BYTES - Static variable in class com.jprofiler.api.agent.probe.Unit
  The telemetry data contains bytes.

## C

calculateRetainedSizes(boolean) - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Determines whether retained sizes should be calculated for the heap dump.
calculateTime() - Method in interface com.jprofiler.api.agent.probe.PayloadInfo
  Calculates the elapsed time since the creation of the payload and save it in the payload info.
children() - Method in interface com.jprofiler.api.platform.structures.Tree
  Returns an iterator for all child nodes.
ClassDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for a class.
close() - Method in interface com.jprofiler.api.platform.connection.Connection
  Closes the connection and free all resources asscociated with this connection.
closeTypeName(String) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Sets the name of the automatic event type for the closing of a control object.
com.jprofiler.api.agent - package com.jprofiler.api.agent
  This package contains the controller class for programatically controlling recording of profiling data.
com.jprofiler.api.agent.mbean - package com.jprofiler.api.agent.mbean
  This package contains JProfiler's controller MBean for offline profiling.
com.jprofiler.api.agent.probe - package com.jprofiler.api.agent.probe
  This package contains all classes required for developing probes.
com.jprofiler.api.platform.connection - package com.jprofiler.api.platform.connection
  This package contains classes for establishing a connection to a live profiling agent or a snapshot file.
com.jprofiler.api.platform.data - package com.jprofiler.api.platform.data
  This package contains classes that encapsulate profiling data.
com.jprofiler.api.platform.descriptors - package com.jprofiler.api.platform.descriptors
  This package contains classes that represent different types of nodes in call trees.
com.jprofiler.api.platform.parameters - package com.jprofiler.api.platform.parameters
  This package contains classes that represent parameters for requesting profiling data from a connection.
com.jprofiler.api.platform.structures - package com.jprofiler.api.platform.structures
  This package contains data structures that are used by both profiling data and request parameters.
com.jprofiler.api.platform.util - package com.jprofiler.api.platform.util
  This package contains utility classes for working the platform API.
Connection - Interface in com.jprofiler.api.platform.connection
  The primary interface for retrieving profiling data from a profiled JVM or a saved snapshot.
ConnectionFactory - Class in com.jprofiler.api.platform.connection
  Factory for creating connections to profiled JVMs and saved snapshots.
ConnectionFactory() - Constructor for class com.jprofiler.api.platform.connection.ConnectionFactory
CONTROL_OBJECT_FROM_DESCRIPTION - Static variable in class com.jprofiler.api.agent.ProbeObjectType
  The `descriptions` parameter of the `startProbeTracking` method will contain the names of control objects.
CONTROL_OBJECT_FROM_ID - Static variable in class com.jprofiler.api.agent.ProbeObjectType
  The `descriptions` parameter of the `startProbeTracking` method will contain IDs of control objects.
Controller - Class in com.jprofiler.api.agent
  This is JProfiler's profiling API.
controlObjectView(boolean) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures if the probe publishes control objects.
COUNT - Static variable in class com.jprofiler.api.agent.ProbeValueType
  The probe tracker will show a graph of average counts.
CpuHotspots - Interface in com.jprofiler.api.platform.data
  Data object for CPU hot spots.
create(String) - Static method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Creates an meta-data instance.
createCloseEvent(PayloadInfo, Object) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Creates an event for closing a control object with payload information.
createCloseEvent(String, Object) - Method in interface com.jprofiler.api.agent.probe.ProbeContext
  Creates an event for closing a control object.
createCustomEvent(PayloadInfo, int, Object) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Creates a custom event with payload information.
createCustomEvent(String, int, Object) - Method in interface com.jprofiler.api.agent.probe.ProbeContext
  Creates a custom event.
createOpenEvent(PayloadInfo, Object) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Creates an event for opening a control object with payload information.
createOpenEvent(String, Object) - Method in interface com.jprofiler.api.agent.probe.ProbeContext
  Creates an event for opening a control object.
createOpenEvent(String, Object, Object[]) - Method in interface com.jprofiler.api.agent.probe.ProbeContext
  Creates an event for opening a control object with additional control object data.
createPayloadInfo(String) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Creates a payload info object for this interceptor probe.
createPayloadInfo(String, Object) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Creates a payload info object for this interceptor probe with a memento object.
createRemoteConnection(String, int, int) - Static method in class com.jprofiler.api.platform.connection.ConnectionFactory
  Opens a connection to a remote JVM.
createSnapshotConnection(File, File) - Static method in class com.jprofiler.api.platform.connection.ConnectionFactory
  Opens a connection to a saved snapshot file.
customColors(int[]) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures the colors of the custom events in the time line view.
customTypeNames(String[]) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures the custom event types and their names.

## D

DataType - Class in com.jprofiler.api.agent.probe
  Describes the type of additional data columns for events and control objects.
DEFAULT - Static variable in class com.jprofiler.api.agent.HeapDumpOptions
  The default value used by `Controller.triggerHeapDump()`.
description(String) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Sets the description of the probe.
Descriptor - Interface in com.jprofiler.api.platform.descriptors
  A descriptor describes the contents of a profiling value or a heap value.
discardTime() - Method in interface com.jprofiler.api.agent.probe.PayloadInfo
  Discards the associated timing information in the payload, so that the displayed time in the JProfiler GUI will be zero.
DOUBLE - Static variable in class com.jprofiler.api.agent.probe.DataType
  The data consists of instances of `java.lang.Double`.

## E

enableTriggerGroup(boolean, String) - Static method in class com.jprofiler.api.agent.Controller
  Enable or disable all triggers with a specified group ID.
enableTriggerGroup(boolean, String) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Enable or disable all triggers with a specified group ID.
enableTriggerGroup(boolean, String) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Enable or disable all triggers with a specified group ID.
enableTriggers(boolean) - Static method in class com.jprofiler.api.agent.Controller
  Enable or disable all triggers.
enableTriggers(boolean) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Enable or disable all triggers.
enableTriggers(boolean) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Enable or disable all triggers.
events(boolean) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures if probe retain single events.
EXECUTORS - Static variable in class com.jprofiler.api.agent.TrackingOptions
  Only track executors, same as `new TrackingOptions().executors(true)`.
executors(boolean) - Method in class com.jprofiler.api.agent.TrackingOptions
  Determines if executors should be tracked.

## F

fillTelemetryData(ProbeContext, int[]) - Method in interface com.jprofiler.api.agent.probe.TelemetryProbe
  Fills in a sample for all published telemetries.
FLOAT - Static variable in class com.jprofiler.api.agent.probe.DataType
  The data consists of instances of `java.lang.Float`.
freeze() - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Make these heap dump options unmodifiable.
freeze() - Method in class com.jprofiler.api.agent.TrackingOptions
  Make these tracking options unmodifiable.
fullGc(boolean) - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Determines whether a full garbage collection should be performed for the heap dump.

## G

getAllocationHotspotBacktrace(ProfilingValue) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the back traces for an allocation hot spot.
getAllocationHotspots(Aggregation, Liveness, Descriptor[], boolean, boolean) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the allocation hot spots for recorded objects of selected classes.
getAllocationHotspots(Aggregation, Liveness, String, boolean, boolean) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the allocation hot spots for recorded objects of a selected package.
getAllocationHotspots() - Method in interface com.jprofiler.api.platform.data.AllocationHotspots
  Returns the hot spot values.
getAllocationTree(Aggregation, Liveness, Descriptor[], boolean) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the allocation tree for recorded objects of selected classes.
getAllocationTree(Aggregation, Liveness, String, boolean) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the allocation tree for recorded objects of a selected package.
getBlockedMicro() - Method in interface com.jprofiler.api.platform.structures.Payload
  Returns the time measurement in the "Blocked" thread state associated with this payload.
getById(int) - Static method in enum com.jprofiler.api.platform.parameters.ArrayType
  Converts an integer id to the corresponding constant.
getChildCount() - Method in interface com.jprofiler.api.platform.structures.Tree
  Returns the number of child nodes.
getClassName() - Method in class com.jprofiler.api.agent.probe.InterceptionMethod
  Returns the class name.
getControlObjectId() - Method in interface com.jprofiler.api.agent.probe.ProbeEvent
  Returns the ID of the associated control object.
getCount() - Method in interface com.jprofiler.api.platform.structures.Payload
  Returns the number of times this payload was added.
getCount() - Method in interface com.jprofiler.api.platform.structures.ProfilingValue
  Returns the count of the measurement.
getCpuHotspotBacktrace(ProfilingValue) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the back traces for a CPU hot spot.
getCpuHotspots(Collection<ThreadInfo>, Aggregation, ThreadStatus, boolean) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates CPU hot spots.
getCpuTree(Collection<ThreadInfo>, Aggregation, ThreadStatus) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the cumulated call tree.
getDeclaringClass() - Method in interface com.jprofiler.api.platform.descriptors.MethodDescriptor
  Returns the descriptor of the class that declares this method.
getDescription() - Method in interface com.jprofiler.api.agent.probe.PayloadInfo
  Returns the description for the payload info.
getDescription() - Method in interface com.jprofiler.api.platform.descriptors.Descriptor
  Returns the description.
getDescription() - Method in interface com.jprofiler.api.platform.structures.Payload
  Returns the description for this particular payload.
getDescriptionToId() - Method in interface com.jprofiler.api.platform.data.ProbeInfo
  Returns a map with the interceptor descriptions as keys and payload ids as values.
getDescriptor(Connection) - Method in interface com.jprofiler.api.platform.structures.HeapValue
  Returns the descriptor that describes the class or package for this heap value.
getDescriptor(Connection) - Method in interface com.jprofiler.api.platform.structures.ProfilingValue
  Returns the descriptor that describes the entity of this profiling value.
getGroupName() - Method in interface com.jprofiler.api.platform.structures.ThreadInfo
  Returns the thread group name of this thread.
getHeapValuesGC() - Method in interface com.jprofiler.api.platform.data.RecordedHeapUsage
  Returns the heap value objects for garbage collected objects.
getHeapValuesLive() - Method in interface com.jprofiler.api.platform.data.RecordedHeapUsage
  Returns the heap value objects for live objects.
getHotspots() - Method in interface com.jprofiler.api.platform.data.CpuHotspots
  Returns the hot spot values.
getId() - Method in enum com.jprofiler.api.platform.parameters.ArrayType
  Converts the constant to an integer id.
getIdToDescription() - Method in interface com.jprofiler.api.platform.data.ProbeInfo
  Returns a map with the payload ids as keys and interceptor descriptions as values.
getIndentedTree(Connection, Tree) - Static method in class com.jprofiler.api.platform.util.TreePrinter
  Returns an indented tree displaying profiling information and payloads.
getInstanceCount() - Method in interface com.jprofiler.api.platform.structures.HeapValue
  Returns the number of instances of the class or package represented by this heap value.
getInterceptionMethods() - Method in interface com.jprofiler.api.agent.probe.InterceptorProbe
  Defines the methods that should be intercepted by this interceptor probe.
getLineNumber() - Method in interface com.jprofiler.api.platform.structures.ProfilingValue
  Returns the line number for the context from which the entity associated with this profiling value was called.
getList() - Method in class com.jprofiler.api.agent.probe.ThreadLocalStack
  Returns the stack as a list.
getLocalConnection() - Static method in class com.jprofiler.api.platform.connection.ConnectionFactory
  Opens a connection to the JVM of the current process.
getMap() - Method in interface com.jprofiler.api.agent.probe.ProbeContext
  Returns a map for storing arbitrary data.
getMemento() - Method in interface com.jprofiler.api.agent.probe.PayloadInfo
  Retrieves the memento object.
getMetaData() - Method in interface com.jprofiler.api.agent.probe.Probe
  Configures the capabilities of your custom probe.
getMethodName() - Method in class com.jprofiler.api.agent.probe.InterceptionMethod
  Returns the method name.
getMethodName() - Method in interface com.jprofiler.api.platform.descriptors.MethodDescriptor
  Returns the name of the method.
getMethodSignature() - Method in class com.jprofiler.api.agent.probe.InterceptionMethod
  Returns the method signature
getMethodSignature() - Method in interface com.jprofiler.api.platform.descriptors.MethodDescriptor
  Returns the signature of this method in JVM format.
getName() - Method in enum com.jprofiler.api.platform.parameters.Aggregation
  Get a verbose description of the aggregation level.
getName() - Method in enum com.jprofiler.api.platform.parameters.Liveness
  Returns a verbose description of the liveness type.
getName() - Method in enum com.jprofiler.api.platform.parameters.ThreadStatus
  Returns a verbose description of the thread status.
getNetioMicro() - Method in interface com.jprofiler.api.platform.structures.Payload
  Returns the time measurement in the "Net IO" thread state associated with this payload.
getOpenEventDescription(Object) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Returns the description that was used for creating a control object.
getParentName() - Method in interface com.jprofiler.api.platform.structures.ThreadInfo
  Returns the name of the parent thread.
getPayloadCount() - Method in interface com.jprofiler.api.platform.structures.Tree
  Returns the number of payloads attached to this call stack.
getPayloadHotspotBacktrace(ProfilingValue) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the back traces for a payload hot spot.
getPayloadHotspots(String, Collection<ThreadInfo>, Aggregation, ThreadStatus) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates hot spots for a non-method hot spot type.
getPayloadIterator() - Method in interface com.jprofiler.api.platform.structures.Tree
  Returns an iterator for all payloads attached to this call stack.
getProbeInfo() - Method in interface com.jprofiler.api.platform.connection.Connection
  Returns information about registered interceptors.
getProbes() - Method in interface com.jprofiler.api.agent.probe.ProbeProvider
  Returns the probes that should be activated.
getRecordedHeapUsage(boolean) - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the heap usage for all classes of recorded objects in the JVM.
getRunnableMicro() - Method in interface com.jprofiler.api.platform.structures.Payload
  Returns the time measurement in the "Runnable" thread state associated with this payload.
getSize() - Method in interface com.jprofiler.api.platform.structures.HeapValue
  Returns the shallow size in bytes of the instances of the class or package represented by this heap value.
getThreadCPUTime() - Method in interface com.jprofiler.api.platform.structures.ThreadInfo
  Returns the CPU time for this thread.
getThreadEndTime() - Method in interface com.jprofiler.api.platform.structures.ThreadInfo
  Returns the time when this thread was ended.
getThreadId() - Method in interface com.jprofiler.api.platform.structures.ThreadInfo
  Returns the id of this thread.
getThreadInfos() - Method in interface com.jprofiler.api.platform.connection.Connection
  Returns information about all threads (live and dead) in the JVM.
getThreadName() - Method in interface com.jprofiler.api.platform.structures.ThreadInfo
  Returns the name of this thread.
getThreadStartTime() - Method in interface com.jprofiler.api.platform.structures.ThreadInfo
  Returns the time when this thread was started.
getTimeStampMicro() - Method in interface com.jprofiler.api.platform.structures.Payload
  Returns the time stamp when this payload was added to the call tree.
getTotalHeapUsage() - Method in interface com.jprofiler.api.platform.connection.Connection
  Calculates the total heap usage for all classes in the JVM.
getTotalSize() - Method in interface com.jprofiler.api.platform.data.AllocationHotspots
  Returns the total size in bytes of all recorded objects that are included in this data object.
getTotalTime() - Method in interface com.jprofiler.api.platform.data.CpuHotspots
  Returns the total execution time in microseconds for all hot spots that are included in this data object.
getType() - Method in interface com.jprofiler.api.platform.descriptors.ArrayDescriptor
  Returns the type of the array.
getType() - Method in interface com.jprofiler.api.platform.descriptors.PayloadDescriptor
  Returns the payload id.
getType() - Method in interface com.jprofiler.api.platform.structures.Payload
  Returns ths type of the payload.
getValue() - Method in interface com.jprofiler.api.platform.structures.ProfilingValue
  Returns the value of the measurement.
getVerbose(String) - Static method in class com.jprofiler.api.platform.util.SignatureParser
  Returns a verbose form of the signature.
getVerbose(String, boolean) - Static method in class com.jprofiler.api.platform.util.SignatureParser
  Returns a verbose form of the signature.
getVerboseArguments(String) - Static method in class com.jprofiler.api.platform.util.SignatureParser
  Returns a verbose form of the signature surrounded by parentheses.
getWaitingMicro() - Method in interface com.jprofiler.api.platform.structures.Payload
  Returns the time measurement in the "Waiting" thread state associated with this payload.

## H

HeapDumpOptions - Class in com.jprofiler.api.agent
  Heap dump options for calling `Controller.triggerHeapDump(HeapDumpOptions)` The default values after constructing an instance of this class are equivalent to calling `heapDumpOptions.fullGc(true).primitiveData(true).calculateRetainedSizes(true).selectRecorded(true)`.
HeapDumpOptions() - Constructor for class com.jprofiler.api.agent.HeapDumpOptions
  Create a new instance with the default options described above.
HeapValue - Interface in com.jprofiler.api.platform.structures
  Contains information about allocated instances of a class or package.
HOTSPOT - Static variable in class com.jprofiler.api.agent.ProbeObjectType
  The `descriptions` parameter of the `startProbeTracking` method will contain the names of hot spots.

## I

implementsInterface(Object, String) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Helper method to check whether the class of an object implements an interface.
INT - Static variable in class com.jprofiler.api.agent.probe.DataType
  The data consists of instances of `java.lang.Integer`.
interceptionEnter(InterceptorContext, Object, Class, String, String, String, Object[]) - Method in interface com.jprofiler.api.agent.probe.InterceptorProbe
  Called when an intercepted method is entered.
interceptionExceptionExit(InterceptorContext, Object, Class, String, String, String, Throwable) - Method in interface com.jprofiler.api.agent.probe.InterceptorProbe
  Called when an in intercepted method is exited because an exception is thrown.
interceptionExit(InterceptorContext, Object, Class, String, String, String, Object) - Method in interface com.jprofiler.api.agent.probe.InterceptorProbe
  Called when an intercepted method is exited via a regular return call.
InterceptionMethod - Class in com.jprofiler.api.agent.probe
  Defines a single method that should be intercepted by an @{link InterceptorProbe interceptor probe}.
InterceptionMethod(String, String, String) - Constructor for class com.jprofiler.api.agent.probe.InterceptionMethod
  Constructor for a method interception of a concrete class.
InterceptionMethod(String, String) - Constructor for class com.jprofiler.api.agent.probe.InterceptionMethod
  Constructor for a wildcard method interception.
InterceptorContext - Interface in com.jprofiler.api.agent.probe
  Context object that is passed to the interception methods of `interceptor probes`.
InterceptorProbe - Interface in com.jprofiler.api.agent.probe
  Base class for deriving a probe that intercepts methods.
INTERNED_STRING - Static variable in class com.jprofiler.api.agent.probe.DataType
  The data consists of interned strings.
isAwt() - Method in class com.jprofiler.api.agent.TrackingOptions
  Returns if AWT is tracked.
isCalculateRetainedSizes() - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Returns if retained sizes should be calculated for the heap dump.
isEmpty() - Method in class com.jprofiler.api.agent.probe.ThreadLocalStack
  Checks if the thread-local stack is empty.
isExecutors() - Method in class com.jprofiler.api.agent.TrackingOptions
  Returns if executors are tracked.
isFullGc() - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Returns if a full garbage collection should be performed for the heap dump.
isPayloadStackEmpty() - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Check if the payload stack is empty.
isPrimitiveData() - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Returns if primitive data should be recorded for the heap dump.
isRecording() - Method in interface com.jprofiler.api.agent.probe.ProbeContext
  Return whether the probe is recording data.
isSelectRecorded() - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Returns if recorded objects should be selected when the heap dump is opened in the JProfiler GUI.
isSwt() - Method in class com.jprofiler.api.agent.TrackingOptions
  Returns if SWT is tracked.
isTargetMethod(String, String, String, String) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Helper method to check if a method name and signature are equivalent with target values.
isThreadStart() - Method in class com.jprofiler.api.agent.TrackingOptions
  Returns if thread start is tracked.

## L

Liveness - Enum in com.jprofiler.api.platform.parameters
  Represents all supported liveness types.
LONG - Static variable in class com.jprofiler.api.agent.probe.DataType
  The data consists of instances of `java.lang.Long`.

## M

MethodDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for an array type.
MICROSECONDS - Static variable in class com.jprofiler.api.agent.probe.Unit
  The telemetry data contains microseconds.

## N

NO_FULL_GC - Static variable in class com.jprofiler.api.agent.HeapDumpOptions
  Same as `HeapDumpOptions.DEFAULT`, only with `fullGc(false)`.
NONE - Static variable in class com.jprofiler.api.agent.TrackingOptions
  The default value used by `Controller.startCPURecording(boolean)` and `Controller.startAllocRecording(boolean, TrackingOptions)`

## O

OBJECT - Static variable in class com.jprofiler.api.agent.probe.DataType
  The data consists of arbitrary objects.
openTypeName(String) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Sets the name of the automatic event type for the opening of a control object.

## P

PackageDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for a package.
payload(boolean) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures if the probe collects payload information.
Payload - Interface in com.jprofiler.api.platform.structures
  Represents payload by built-in or user-defined interceptors.
PAYLOAD_NAME_JDBC - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload name for the built-in JDBC interceptor.
PAYLOAD_NAME_JMS - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload name for the built-in JMS interceptor.
PAYLOAD_NAME_JNDI - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload name for the built-in JNDI interceptor.
PAYLOAD_NAME_SERVLET - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload name for the built-in URL interceptor.
PAYLOAD_TYPE_JDBC - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload type for the built-in JDBC interceptor.
PAYLOAD_TYPE_JMS - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload type for the built-in JMS interceptor.
PAYLOAD_TYPE_JNDI - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload type for the built-in JNDI interceptor.
PAYLOAD_TYPE_SERVLET - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload type for the built-in Servlet interceptor.
PayloadDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for a payload.
PayloadInfo - Interface in com.jprofiler.api.agent.probe
  A payload info represents a verbose description that can be added added to the current call stack together with associated timing information.
payloadName(String) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Sets the name of the payload.
peek() - Method in class com.jprofiler.api.agent.probe.ThreadLocalStack
  Retrieves the object on top of the thread-local stack.
PERCENT - Static variable in class com.jprofiler.api.agent.probe.Unit
  The telemetry contains percent values between 0 and 100.
PLAIN - Static variable in class com.jprofiler.api.agent.probe.Unit
  The telemetry data contains natural numbers without a unit.
pop() - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Retrieves a payload that was saved to the thread local stack with `InterceptorContext.push(PayloadInfo)`.
pop() - Method in class com.jprofiler.api.agent.probe.ThreadLocalStack
  Pops an object from the thread-local stack.
primitiveData(boolean) - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Determines whether primitive data should be recorded for the heap dump.
Probe - Interface in com.jprofiler.api.agent.probe
  Base interface for probes.
PROBE_NAME_FILE - Static variable in class com.jprofiler.api.agent.Controller
  Name of the built-in file probe.
PROBE_NAME_JDBC - Static variable in class com.jprofiler.api.agent.Controller
  Name of the built-in JDBC probe.
PROBE_NAME_JMS - Static variable in class com.jprofiler.api.agent.Controller
  Name of the built-in JMS probe.
PROBE_NAME_JNDI - Static variable in class com.jprofiler.api.agent.Controller
  Name of the built-in JNDI probe.
PROBE_NAME_PERSISTENCE - Static variable in class com.jprofiler.api.agent.Controller
  Name of the built-in persistence probe.
PROBE_NAME_PROCESS - Static variable in class com.jprofiler.api.agent.Controller
  Name of the built-in process probe.
PROBE_NAME_SERVLET - Static variable in class com.jprofiler.api.agent.Controller
  Name of the built-in servlet probe.
PROBE_NAME_SOCKET - Static variable in class com.jprofiler.api.agent.Controller
  Name of the built-in socket probe.
ProbeContext - Interface in com.jprofiler.api.agent.probe
  Context object that is passed to probes and provide ways to publish data.
ProbeEvent - Interface in com.jprofiler.api.agent.probe
  A probe event.
ProbeInfo - Interface in com.jprofiler.api.platform.data
  Data object that holds informaton about registered interceptors.
ProbeMetaData - Class in com.jprofiler.api.agent.probe
  The meta data defines the capabilities of a probe.
ProbeMetaData() - Constructor for class com.jprofiler.api.agent.probe.ProbeMetaData
ProbeObjectType - Class in com.jprofiler.api.agent
  Represents the type of elements to be tracked in probe tracking.
ProbeProvider - Interface in com.jprofiler.api.agent.probe
  A probe provider is queried by the profiling agent for the probes that should be activated.
ProbeValueType - Class in com.jprofiler.api.agent
  Represents the types of values to be tracked in probe tracking.
ProfilingValue - Interface in com.jprofiler.api.platform.structures
  Contains information about a CPU or memory profiling measurement in a call tree or hot spot list.
push(PayloadInfo) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Saves a payload to a thread local stack.
push(Object) - Method in class com.jprofiler.api.agent.probe.ThreadLocalStack
  Pushes an object onto the thread-local stack.

## R

recordAllocations(boolean) - Method in interface com.jprofiler.api.platform.connection.Connection
  Starts or stops recording allocations.
recordCpuData(boolean) - Method in interface com.jprofiler.api.platform.connection.Connection
  Starts or stops recording CPU data.
RecordedHeapUsage - Interface in com.jprofiler.api.platform.data
  Data object for recorded heap usage.
recordOnStartup(boolean) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures if the probe should record data on startup.
RemoteController - Class in com.jprofiler.api.agent.mbean
  This is JProfiler's MBean implementation.
RemoteController() - Constructor for class com.jprofiler.api.agent.mbean.RemoteController
RemoteControllerMBean - Interface in com.jprofiler.api.agent.mbean
  This is JProfiler's MBean interface.

## S

saveSnapshot(File) - Static method in class com.jprofiler.api.agent.Controller
  Saves a snapshot of all profiling data to disk.
saveSnapshot(String) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Saves a snapshot of all profiling data to disk.
saveSnapshot(String) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Saves a snapshot of all profiling data to disk.
saveSnapshotOnExit(File) - Static method in class com.jprofiler.api.agent.Controller
  Saves a snapshot of all profiling data to disk when the VM shuts down.
saveSnapshotOnExit(String) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Saves a snapshot of all profiling data to disk when the VM shuts down.
saveSnapshotOnExit(String) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Saves a snapshot of all profiling data to disk when the VM shuts down.
SELECT_RECORDED - Static variable in class com.jprofiler.api.agent.HeapDumpOptions
  Same as `HeapDumpOptions.DEFAULT`, only with `selectRecorded(true)`.
selectRecorded(boolean) - Method in class com.jprofiler.api.agent.HeapDumpOptions
  Determines whether recorded objects should be selected when the heap dump is opened in the JProfiler GUI.
setDescription(String) - Method in interface com.jprofiler.api.agent.probe.PayloadInfo
  Sets the description for the payload info.
setMemento(Object) - Method in interface com.jprofiler.api.agent.probe.PayloadInfo
  Sets the memento object.
SignatureParser - Class in com.jprofiler.api.platform.util
  Helper class to parse a signature in JVM format.
size() - Method in class com.jprofiler.api.agent.probe.ThreadLocalStack
  Returns the number of objects currently on the thread-local stack.
startAllocRecording(boolean) - Static method in class com.jprofiler.api.agent.Controller
  Starts recording of memory allocations.
startAllocRecording(boolean, TrackingOptions) - Static method in class com.jprofiler.api.agent.Controller
  Starts recording of memory allocations.
startAllocRecording(boolean) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Starts recording of memory allocations.
startAllocRecording(boolean) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Starts recording of memory allocations.
startCallTracer(int, boolean, boolean) - Static method in class com.jprofiler.api.agent.Controller
  Starts the call tracer.
startCPURecording(boolean) - Static method in class com.jprofiler.api.agent.Controller
  Starts recording CPU data.
startCPURecording(boolean, TrackingOptions) - Static method in class com.jprofiler.api.agent.Controller
  Starts recording CPU data.
startCPURecording(boolean) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Starts recording CPU data.
startCPURecording(boolean) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Starts recording CPU data.
startCustomState(Object, int) - Method in interface com.jprofiler.api.agent.probe.InterceptorContext
  Change the state of a control object for the time line view.
startMethodStatsRecording() - Static method in class com.jprofiler.api.agent.Controller
  Starts method statistics recording.
startMethodStatsRecording() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Starts method statistics recording.
startMethodStatsRecording() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Starts method statistics recording.
startMonitorRecording() - Static method in class com.jprofiler.api.agent.Controller
  Start recording of monitor usage with default thresholds of 100 microseconds for blocking events and 100 ms for waiting events.
startMonitorRecording(int, int) - Static method in class com.jprofiler.api.agent.Controller
  Start recording of monitor usage.
startMonitorRecording() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Start recording of monitor usage with default thresholds of 100 microseconds for blocking events and 100 ms for waiting events.
startMonitorRecording(int, int) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Start recording of monitor usage.
startMonitorRecording() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Start recording of monitor usage with default thresholds of 100 microseconds for blocking events and 100 ms for waiting events.
startMonitorRecording(int, int) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Start recording of monitor usage.
startProbeRecording(String, boolean) - Static method in class com.jprofiler.api.agent.Controller
  Start recording data for a selected probe.
startProbeRecording(String, boolean) - Method in class com.jprofiler.api.agent.mbean.RemoteController
startProbeRecording(String, boolean) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
startProbeTracking(String, String[], ProbeObjectType, ProbeValueType) - Static method in class com.jprofiler.api.agent.Controller
  Start tracking selected elements for a selected probe.
startTelemetryGroup(String) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Starts a group of telemetries that can be displayed in the same graph.
startThreadProfiling() - Static method in class com.jprofiler.api.agent.Controller
  Starts recording of thread states and monitor usage.
startThreadProfiling() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Starts recording of thread states and monitor usage.
startThreadProfiling() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Starts recording of thread states and monitor usage.
startVMTelemetryRecording() - Static method in class com.jprofiler.api.agent.Controller
  Starts recording of VM telemetry data.
startVMTelemetryRecording() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Starts recording of VM telemetry data.
startVMTelemetryRecording() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Starts recording of VM telemetry data.
stopAllocRecording() - Static method in class com.jprofiler.api.agent.Controller
  Stops recording of memory allocations.
stopAllocRecording() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Stops recording of memory allocations.
stopAllocRecording() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Stops recording of memory allocations.
stopCallTracer() - Static method in class com.jprofiler.api.agent.Controller
  Stops the call tracer.
stopCPURecording() - Static method in class com.jprofiler.api.agent.Controller
  Stops CPU recording.
stopCPURecording() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Stops CPU recording.
stopCPURecording() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Stops CPU recording.
stopMethodStatsRecording() - Static method in class com.jprofiler.api.agent.Controller
  Stops method statistics recording.
stopMethodStatsRecording() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Stops method statistics recording.
stopMethodStatsRecording() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Stops method statistics recording.
stopMonitorRecording() - Static method in class com.jprofiler.api.agent.Controller
  Stop recording of monitor usage.
stopMonitorRecording() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Stop recording of monitor usage.
stopMonitorRecording() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Stop recording of monitor usage.
stopProbeRecording(String) - Static method in class com.jprofiler.api.agent.Controller
  Stop recording data for a selected probe.
stopProbeRecording(String) - Method in class com.jprofiler.api.agent.mbean.RemoteController
stopProbeRecording(String) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
stopProbeTracking(String, String[], ProbeObjectType, ProbeValueType) - Static method in class com.jprofiler.api.agent.Controller
  Stop tracking selected elements for a selected probe.
stopThreadProfiling() - Static method in class com.jprofiler.api.agent.Controller
  Stops recording of thread states and monitor usage.
stopThreadProfiling() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Stops recording of thread states and monitor usage.
stopThreadProfiling() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Stops recording of thread states and monitor usage.
stopVMTelemetryRecording() - Static method in class com.jprofiler.api.agent.Controller
  Stops recording of VM telemetry data.
stopVMTelemetryRecording() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Stops recording of VM telemetry data.
stopVMTelemetryRecording() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Stops recording of VM telemetry data.
STRING - Static variable in class com.jprofiler.api.agent.probe.DataType
  The data consists of strings.
SWT - Static variable in class com.jprofiler.api.agent.TrackingOptions
  Only track SWT, same as `new TrackingOptions().swt(true)`.
swt(boolean) - Method in class com.jprofiler.api.agent.TrackingOptions
  Determines if SWT should be tracked.

## T

telemetry(boolean) - Method in class com.jprofiler.api.agent.probe.ProbeMetaData
  Configures if the probe collects telemetry data.
TelemetryProbe - Interface in com.jprofiler.api.agent.probe
  Base class for deriving a probe that publishes telemetries.
THREAD_START - Static variable in class com.jprofiler.api.agent.TrackingOptions
  Only track thread start, same as `new TrackingOptions().threadStart(true)`.
ThreadInfo - Interface in com.jprofiler.api.platform.structures
  Describes a thread.
ThreadLocalStack - Class in com.jprofiler.api.agent.probe
  A stack that saves objects in thread local data structures.
ThreadLocalStack() - Constructor for class com.jprofiler.api.agent.probe.ThreadLocalStack
threadStart(boolean) - Method in class com.jprofiler.api.agent.TrackingOptions
  Determines if thread start should be tracked.
ThreadStatus - Enum in com.jprofiler.api.platform.parameters
  Represents all supported thread statuses.
THROUGHPUT - Static variable in class com.jprofiler.api.agent.ProbeValueType
  The probe tracker will show a graph of average throughputs.
TIMES - Static variable in class com.jprofiler.api.agent.ProbeValueType
  The probe tracker will show a graph of average times.
toString() - Method in class com.jprofiler.api.agent.probe.DataType
toString() - Method in class com.jprofiler.api.agent.probe.InterceptionMethod
toString() - Method in class com.jprofiler.api.agent.probe.Unit
toString() - Method in class com.jprofiler.api.agent.ProbeObjectType
toString() - Method in class com.jprofiler.api.agent.ProbeValueType
toString() - Method in enum com.jprofiler.api.platform.parameters.Aggregation
toString() - Method in enum com.jprofiler.api.platform.parameters.Liveness
toString() - Method in enum com.jprofiler.api.platform.parameters.ThreadStatus
TrackingOptions - Class in com.jprofiler.api.agent
  Request tracking options for calling `Controller.startCPURecording(boolean, TrackingOptions)`} and `Controller.startAllocRecording(boolean, TrackingOptions)`.
TrackingOptions() - Constructor for class com.jprofiler.api.agent.TrackingOptions
  Create a new instance with no tracking types enabled.
Tree - Interface in com.jprofiler.api.platform.structures
  Describes a call tree.
TreePrinter - Class in com.jprofiler.api.platform.util
  Helper class to get a string respresentation for a `Tree` structure.
triggerHeapDump() - Static method in class com.jprofiler.api.agent.Controller
  Trigger a heap dump.
triggerHeapDump(HeapDumpOptions) - Static method in class com.jprofiler.api.agent.Controller
  Trigger a heap dump with the specified `heap dump options`.
triggerHeapDump() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Triggers a heap dump.
triggerHeapDump() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Triggers a heap dump.
triggerHeapDumpWithOptions(boolean, boolean, boolean, boolean) - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Triggers a heap dump.
triggerHeapDumpWithOptions(boolean, boolean, boolean, boolean) - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Triggers a heap dump.
triggerThreadDump() - Static method in class com.jprofiler.api.agent.Controller
  Trigger a thread dump.
triggerThreadDump() - Method in class com.jprofiler.api.agent.mbean.RemoteController
  Trigger a thread dump.
triggerThreadDump() - Method in interface com.jprofiler.api.agent.mbean.RemoteControllerMBean
  Trigger a thread dump.

## U

Unit - Class in com.jprofiler.api.agent.probe
  Defines the unit that is displays in a particular custom telemetry.
URLDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for a URL node.

## V

valueOf(String) - Static method in enum com.jprofiler.api.platform.parameters.Aggregation
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jprofiler.api.platform.parameters.ArrayType
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jprofiler.api.platform.parameters.Liveness
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.jprofiler.api.platform.parameters.ThreadStatus
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.jprofiler.api.platform.parameters.Aggregation
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.jprofiler.api.platform.parameters.ArrayType
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.jprofiler.api.platform.parameters.Liveness
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.jprofiler.api.platform.parameters.ThreadStatus
  Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L M N O P R S T U V

Overview | Package | Class | Tree | Deprecated | Index | Help
| JProfiler API
PREV NEXT | FRAMES NO FRAMES