org.openjdk.jmh.profile

Interface Profiler

All Known Subinterfaces:

ExternalProfiler, InternalProfiler

All Known Implementing Classes:

AbstractPerfAsmProfiler, AsyncProfiler, ClassloaderProfiler, CompilerProfiler, DTraceAsmProfiler, GCProfiler, JavaFlightRecorderProfiler, LinuxPerfAsmProfiler, LinuxPerfC2CProfiler, LinuxPerfNormProfiler, LinuxPerfProfiler, PausesProfiler, SafepointsProfiler, StackProfiler, WinPerfAsmProfiler

public interface Profiler

Root profiler interface.

Profiler classes are expected to provide either a non-arg constructor, or a constructor accepting single String argument, as the option line. The treatment of option line is unspecified, and can be handled in profiler-specific way. Profiler constructors can throw ProfilerException if profiler cannot operate, either because of misconfiguration, or help message requested. The message in ProfilerException should clearly articulate the reason.

JMH will try to discover profiler implementations using the SPI mechanism. Note: discoverable implementations must provide a no-arg constructor for initial discovery; the instance created during discovery will be rejected. If implementation would have a constructor accepting the String option line, it would be preferred for subsequent instantiation over the no-arg constructor.

Profilers normally implement one of the subinterfaces.

See Also:

ExternalProfiler, InternalProfiler

Method Summary

Modifier and Type	Method and Description
String	getDescription() Human-readable one-line description of the profiler.

Method Detail

getDescription

String getDescription()

Human-readable one-line description of the profiler.

Returns:

description