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

A C D G H I L M P R S T U V

## A

addBookmark(String) - Static method in class com.jprofiler.api.agent.Controller
  Adds a bookmark at the current time.
addToCallTree(boolean, boolean) - Method in interface com.jprofiler.api.agent.interceptor.PayloadInfo
  Adds the payload info to the cumulated call tree at the current call stack.
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.
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.

## C

calculateTime() - Method in interface com.jprofiler.api.agent.interceptor.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.
com.jprofiler.api.agent - package com.jprofiler.api.agent
  This package contains the controller class for offline profiling.
com.jprofiler.api.agent.interceptor - package com.jprofiler.api.agent.interceptor
  This package contains all classes required for developing interceptors.
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
Controller - Class in com.jprofiler.api.agent
  This is JProfiler's profiling API.
Controller.HTTPRequestResolver - Interface in com.jprofiler.api.agent
  Interface for mapping HTTP requests to strings that are displayed in the JProfiler GUI.
Controller.JMSResolver - Interface in com.jprofiler.api.agent
  Interface for mapping JMS messages to strings that are displayed in the JProfiler GUI.
CpuHotspots - Interface in com.jprofiler.api.platform.data
  Data object for CPU hot spots.
createPayloadInfo(String) - Method in class com.jprofiler.api.agent.interceptor.Interceptor
  Creates a payload info object for this interceptor.
createPayloadInfo(String, Object) - Method in class com.jprofiler.api.agent.interceptor.Interceptor
  Creates a payload info object for this interceptor 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.

## D

Descriptor - Interface in com.jprofiler.api.platform.descriptors
  A descriptor describes the contents of a profiling value or a heap value.

## 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.interceptor.InterceptionMethod
  Returns the class name.
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.interceptor.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.InterceptorsInfo
  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.InterceptorsInfo
  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.
getInterceptionDescription() - Method in class com.jprofiler.api.agent.interceptor.Interceptor
  A description for this interceptor.
getInterceptionMethods() - Method in class com.jprofiler.api.agent.interceptor.Interceptor
  Defines the methods that should be intercepted by this interceptor.
getInterceptors() - Method in interface com.jprofiler.api.agent.interceptor.InterceptorProvider
  Returns the interceptors that should be activated.
getInterceptorsInfo() - Method in interface com.jprofiler.api.platform.connection.Connection
  Returns information about registered interceptors.
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.
getLocalConnection() - Static method in class com.jprofiler.api.platform.connection.ConnectionFactory
  Opens a connection to the JVM of the current process.
getMemento() - Method in interface com.jprofiler.api.agent.interceptor.PayloadInfo
  Retrieves the memento object.
getMessageDescription(Object) - Method in interface com.jprofiler.api.agent.Controller.JMSResolver
  Maps a JMS message object to a string.
getMethodName() - Method in class com.jprofiler.api.agent.interceptor.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.interceptor.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.
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(int, 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.
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.
getSignificantPart(String, String) - Method in interface com.jprofiler.api.agent.Controller.HTTPRequestResolver
  Returns the significant part of a request string.
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.
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

HeapValue - Interface in com.jprofiler.api.platform.structures
  Contains information about allocated instances of a class or package.

## I

implementsInterface(Object, String) - Method in class com.jprofiler.api.agent.interceptor.Interceptor
  Helper method to check whether the class of an object implements an interface.
interceptionEnter(Object, String, String, Object[]) - Method in class com.jprofiler.api.agent.interceptor.Interceptor
  Called when an intercepted method is entered.
interceptionExceptionExit(Object, String, String, Throwable) - Method in class com.jprofiler.api.agent.interceptor.Interceptor
  Called when an in intercepted method is exited because an exception is thrown.
interceptionExit(Object, String, String, Object) - Method in class com.jprofiler.api.agent.interceptor.Interceptor
  Called when an intercepted method is exited via a regular return call.
InterceptionMethod - Class in com.jprofiler.api.agent.interceptor
  Defines a single method that should be intercepted by an interceptor.
InterceptionMethod(String, String, String) - Constructor for class com.jprofiler.api.agent.interceptor.InterceptionMethod
  Constructor for a method interception of a concrete class.
InterceptionMethod(String, String) - Constructor for class com.jprofiler.api.agent.interceptor.InterceptionMethod
  Constructor for a wildcard method interception.
Interceptor - Class in com.jprofiler.api.agent.interceptor
  Base class for deriving a concrete interceptor.
Interceptor() - Constructor for class com.jprofiler.api.agent.interceptor.Interceptor
InterceptorProvider - Interface in com.jprofiler.api.agent.interceptor
  An interceptor provider is queried by the profiling agent for the interceptors that should be activated.
InterceptorsInfo - Interface in com.jprofiler.api.platform.data
  Data object that holds informaton about registered interceptors.
isCpuRecording() - Static method in class com.jprofiler.api.agent.interceptor.Interceptor
  Determines if CPU data is being recorded by the profiling agent.
isEmpty() - Method in class com.jprofiler.api.agent.interceptor.ThreadLocalStack
  Checks if the thread-local stack is empty.
isTargetMethod(String, String, String, String) - Static method in class com.jprofiler.api.agent.interceptor.Interceptor
  Helper method to check if a method name and signature are equivalent with target values.

## L

Liveness - Enum in com.jprofiler.api.platform.parameters
  Represents all supported liveness types.

## M

MethodDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for an array type.

## P

PackageDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for a package.
Payload - Interface in com.jprofiler.api.platform.structures
  Represents payload by built-in or user-defined interceptors.
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_URL - Static variable in interface com.jprofiler.api.platform.structures.Payload
  Payload type for the built-in URL interceptor.
PayloadDescriptor - Interface in com.jprofiler.api.platform.descriptors
  Descriptor for a payload.
PayloadInfo - Interface in com.jprofiler.api.agent.interceptor
  A payload info represents a verbose description that can be added added to the current call stack together with associated timing information.
pop() - Method in class com.jprofiler.api.agent.interceptor.ThreadLocalStack
  Pops an object from the thread-local stack.
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(Object) - Method in class com.jprofiler.api.agent.interceptor.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.
registerHTTPRequestResolver(Controller.HTTPRequestResolver) - Static method in class com.jprofiler.api.agent.Controller
  Registers a resolver class that will map HTTP requests to description strings.
registerJMSResolver(Controller.JMSResolver) - Static method in class com.jprofiler.api.agent.Controller
  Registers a resolver class that will map JMS messages to description strings.

## S

saveSnapshot(File) - Static method in class com.jprofiler.api.agent.Controller
  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.
setDescription(String) - Method in interface com.jprofiler.api.agent.interceptor.PayloadInfo
  Sets the description for the payload info.
setMemento(Object) - Method in interface com.jprofiler.api.agent.interceptor.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.interceptor.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.
startCPURecording(boolean) - Static method in class com.jprofiler.api.agent.Controller
  Starts recording CPU data.
startThreadProfiling() - Static method in class com.jprofiler.api.agent.Controller
  Starts recording of thread states and monitor usage.
startVMTelemetryRecording() - Static method in class com.jprofiler.api.agent.Controller
  Starts recording of VM telemetry data.
stopAllocRecording() - Static method in class com.jprofiler.api.agent.Controller
  Stops recording of memory allocations.
stopCPURecording() - Static method in class com.jprofiler.api.agent.Controller
  Stops CPU recording.
stopThreadProfiling() - Static method in class com.jprofiler.api.agent.Controller
  Stops recording of thread states and monitor usage.
stopVMTelemetryRecording() - Static method in class com.jprofiler.api.agent.Controller
  Stops recording of VM telemetry data.

## T

ThreadInfo - Interface in com.jprofiler.api.platform.structures
  Describes a thread.
ThreadLocalStack - Class in com.jprofiler.api.agent.interceptor
  A stack that saves objects in thread-local data structures.
ThreadLocalStack() - Constructor for class com.jprofiler.api.agent.interceptor.ThreadLocalStack
ThreadStatus - Enum in com.jprofiler.api.platform.parameters
  Represents all supported thread statuses.
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
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(boolean, boolean, boolean) - Static method in class com.jprofiler.api.agent.Controller
  Triggers a heap dump.

## U

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're 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're 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're 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're declared.

A C D G H I L M P R S T U V

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