http://openjdk.java.net/projects/code-tools/jmh/jmh-core/: The jmh is a Java harness for building, running, and analysing nano/micro/macro benchmarks written in Java and other languages targeting the JVM. (Oracle)
  • Aleksey Shipilev (Oracle/Sun, Red Hat)
  • Sergey Kuksenko (Oracle/Sun)
  • Anders Astrand (Oracle/BEA)
  • Staffan Friberg (Oracle/BEA)
  • Henrik Loef (Oracle/BEA) 
/*
 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.openjdk.jmh.profile;


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. 
Profilers normally implement one of the subinterfaces.


See Also:
/**
 * Root profiler interface.
 *
 * <p>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
 * {@link org.openjdk.jmh.profile.ProfilerException} if profiler cannot
 * operate, either because of misconfiguration, or help message requested.
 * The message in {@link org.openjdk.jmh.profile.ProfilerException} should
 * clearly articulate the reason.
 *
 * <p>Profilers normally implement one of the subinterfaces.</p>
 * @see org.openjdk.jmh.profile.ExternalProfiler
 * @see org.openjdk.jmh.profile.InternalProfiler
 */
public interface Profiler {

    
Human-readable one-line description of the profiler.

Returns:description
/**
     * Human-readable one-line description of the profiler.
     * @return description
     */
    String getDescription();

}