A B C D E G H I J L M O R S T U V W X

A

AbstractBenchmark - Class in com.carrotsearch.junitbenchmarks

A superclass for tests that should be executed as benchmarks (several rounds, GC and time accounting).

AbstractBenchmark() - Constructor for class com.carrotsearch.junitbenchmarks.AbstractBenchmark

accept(Result) - Method in class com.carrotsearch.junitbenchmarks.h2.H2Consumer

Accept a single benchmark result.

accept(Result) - Method in interface com.carrotsearch.junitbenchmarks.IResultsConsumer

Accepts the results of a single benchmark.

accept(Result) - Method in class com.carrotsearch.junitbenchmarks.WriterConsumer

accept(Result) - Method in class com.carrotsearch.junitbenchmarks.XMLConsumer

Accept a single benchmark result.

accumulatedInvocations() - Method in class com.carrotsearch.junitbenchmarks.GCSnapshot

accumulatedTime() - Method in class com.carrotsearch.junitbenchmarks.GCSnapshot

addAutoclose(Closeable) - Static method in class com.carrotsearch.junitbenchmarks.AutocloseConsumer

apply(Statement, FrameworkMethod, Object) - Method in class com.carrotsearch.junitbenchmarks.BenchmarkRule

Apply benchmarking to the given method and target.

AutocloseConsumer - Class in com.carrotsearch.junitbenchmarks

Consumers that should be closed at shutdown (if not earlier).

AutocloseConsumer() - Constructor for class com.carrotsearch.junitbenchmarks.AutocloseConsumer

Average - Class in com.carrotsearch.junitbenchmarks

Average with standard deviation.

avg - Variable in class com.carrotsearch.junitbenchmarks.Average

Average (in milliseconds).

AxisRange - Annotation Type in com.carrotsearch.junitbenchmarks.annotation

B

BENCHMARK_ROUNDS_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.rounds.benchmark": the default number of benchmark rounds.

BenchmarkHistoryChart - Annotation Type in com.carrotsearch.junitbenchmarks.annotation

Generate a graphical summary of the historical and current run of a given set of methods.

BenchmarkMethodChart - Annotation Type in com.carrotsearch.junitbenchmarks.annotation

Generate a graphical summary for all benchmarked methods of the annotated class.

BenchmarkOptions - Annotation Type in com.carrotsearch.junitbenchmarks

Benchmark options applicable to methods annotated as tests.

BenchmarkOptionsSystemProperties - Class in com.carrotsearch.junitbenchmarks

Global settings for benchmarks set through system properties.

BenchmarkOptionsSystemProperties() - Constructor for class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

benchmarkRounds - Variable in class com.carrotsearch.junitbenchmarks.Result

BenchmarkRule - Class in com.carrotsearch.junitbenchmarks

A benchmark rule (causes tests to be repeated and measured).

BenchmarkRule() - Constructor for class com.carrotsearch.junitbenchmarks.BenchmarkRule

Creates a benchmark rule with the default sink for benchmark results (the default sink is taken from global properties).

BenchmarkRule(IResultsConsumer...) - Constructor for class com.carrotsearch.junitbenchmarks.BenchmarkRule

Creates a benchmark rule with a given sink for benchmark results.

benchmarkRun - Variable in class com.carrotsearch.junitbenchmarks.AbstractBenchmark

Enables the benchmark rule.

benchmarkTime - Variable in class com.carrotsearch.junitbenchmarks.Result

C

CHARTS_DIR_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.charts.dir": output directory for benchmark charts if H2Consumer is active and chart annotations are present.

clazz - Variable in enum com.carrotsearch.junitbenchmarks.ConsumerName

Consumer class.

close() - Method in class com.carrotsearch.junitbenchmarks.h2.H2Consumer

Close the database connection and finalize transaction.

close() - Method in class com.carrotsearch.junitbenchmarks.XMLConsumer

Close the output XML stream.

com.carrotsearch.junitbenchmarks - package com.carrotsearch.junitbenchmarks

JUnitBenchmarks core infrastructure and annotations.

com.carrotsearch.junitbenchmarks.annotation - package com.carrotsearch.junitbenchmarks.annotation

Annotations for customizing charts.

com.carrotsearch.junitbenchmarks.h2 - package com.carrotsearch.junitbenchmarks.h2

H2 database benchmark results consumer.

CONCURRENCY_AVAILABLE_CORES - Static variable in annotation type com.carrotsearch.junitbenchmarks.BenchmarkOptions

Runs the benchmark with the number of threads reported by Runtime.availableProcessors().

CONCURRENCY_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.concurrency": the default number of threads.

CONCURRENCY_SEQUENTIAL - Static variable in annotation type com.carrotsearch.junitbenchmarks.BenchmarkOptions

Sequential runs (no threads).

ConsumerName - Enum in com.carrotsearch.junitbenchmarks

Shortcuts for known IResultsConsumer.

CONSUMERS_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.consumers": specifies the consumers to instantiate and add to the benchmark results feed.

CUSTOMKEY_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.customkey": custom key to attach to the run.

D

DB_FILE_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.db.file": if set, an H2Consumer is added to the consumers list and benchmark results are saved to a database.

E

Escape - Class in com.carrotsearch.junitbenchmarks

Entity escaping.

Escape() - Constructor for class com.carrotsearch.junitbenchmarks.Escape

G

gcAverage - Variable in class com.carrotsearch.junitbenchmarks.Result

gcInfo - Variable in class com.carrotsearch.junitbenchmarks.Result

GCSnapshot - Class in com.carrotsearch.junitbenchmarks

Snapshot of GC activity (cumulative for all GC types).

generate() - Method in class com.carrotsearch.junitbenchmarks.h2.HistoryChartGenerator

Generate the chart's HTML.

generate() - Method in class com.carrotsearch.junitbenchmarks.h2.MethodChartGenerator

Generate the chart's HTML.

getDefaultConsumers() - Static method in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

getShortTestClassName() - Method in class com.carrotsearch.junitbenchmarks.Result

Returns the short version of the test's class.

getTestClass() - Method in class com.carrotsearch.junitbenchmarks.Result

Returns the class under test.

getTestClassName() - Method in class com.carrotsearch.junitbenchmarks.Result

Returns the long version of the test's class.

getTestMethod() - Method in class com.carrotsearch.junitbenchmarks.Result

Returns the method under test.

getTestMethodName() - Method in class com.carrotsearch.junitbenchmarks.Result

H

H2Consumer - Class in com.carrotsearch.junitbenchmarks.h2

IResultsConsumer that appends records to a H2 database.

H2Consumer() - Constructor for class com.carrotsearch.junitbenchmarks.h2.H2Consumer

H2Consumer(File) - Constructor for class com.carrotsearch.junitbenchmarks.h2.H2Consumer

H2Consumer(File, File, String) - Constructor for class com.carrotsearch.junitbenchmarks.h2.H2Consumer

HistoryChartGenerator - Class in com.carrotsearch.junitbenchmarks.h2

Generate historical view of a given test class (one or more methods).

HistoryChartGenerator(Connection, String, String, LabelType) - Constructor for class com.carrotsearch.junitbenchmarks.h2.HistoryChartGenerator

htmlEscape(String) - Static method in class com.carrotsearch.junitbenchmarks.Escape

Escape special HTML entities.

I

IGNORE_ANNOTATION_OPTIONS_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.ignore.annotations": if true, the defaults (or property values) take precedence over BenchmarkOptions annotations.

IGNORE_CALLGC_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.ignore.callgc": if true, do not call System.gc() between rounds.

includeMethod(String) - Method in class com.carrotsearch.junitbenchmarks.h2.HistoryChartGenerator

Include a given method in the chart.

IResultsConsumer - Interface in com.carrotsearch.junitbenchmarks

An interface for consumers of benchmark results.

J

jsonEscape(String) - Static method in class com.carrotsearch.junitbenchmarks.Escape

Escape a JSON string.

L

LabelType - Enum in com.carrotsearch.junitbenchmarks.annotation

X-axis label type.

M

MethodChartGenerator - Class in com.carrotsearch.junitbenchmarks.h2

Generate a snippet of HTML code for a given class and all of its benchmarked methods.

MethodChartGenerator(Connection, String, int, String) - Constructor for class com.carrotsearch.junitbenchmarks.h2.MethodChartGenerator

O

options - Variable in class com.carrotsearch.junitbenchmarks.Result

R

removeAutoclose(Closeable) - Static method in class com.carrotsearch.junitbenchmarks.AutocloseConsumer

Result - Class in com.carrotsearch.junitbenchmarks

A result of a single benchmark test.

Result(Object, FrameworkMethod, BenchmarkOptions, int, int, long, long, Average, Average, GCSnapshot) - Constructor for class com.carrotsearch.junitbenchmarks.Result

rollback() - Method in class com.carrotsearch.junitbenchmarks.h2.H2Consumer

Rollback all performed operations on request.

roundAverage - Variable in class com.carrotsearch.junitbenchmarks.Result

S

sqlEscape(String) - Static method in class com.carrotsearch.junitbenchmarks.Escape

Escape an SQL string.

stddev - Variable in class com.carrotsearch.junitbenchmarks.Average

Standard deviation (in milliseconds).

T

TIMESTAMP_FORMAT - Static variable in class com.carrotsearch.junitbenchmarks.XMLConsumer

Timestamp format.

toString() - Method in class com.carrotsearch.junitbenchmarks.Average

U

updateMaxRuns(int) - Method in class com.carrotsearch.junitbenchmarks.h2.HistoryChartGenerator

Update max history steps.

updateMinMax(AxisRange) - Method in class com.carrotsearch.junitbenchmarks.h2.HistoryChartGenerator

Update min/max fields.

V

valueOf(String) - Static method in enum com.carrotsearch.junitbenchmarks.annotation.LabelType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.carrotsearch.junitbenchmarks.ConsumerName

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.carrotsearch.junitbenchmarks.annotation.LabelType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.carrotsearch.junitbenchmarks.ConsumerName

Returns an array containing the constants of this enum type, in the order they are declared.

W

WARMUP_ROUNDS_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.rounds.warmup": the default number of warmup rounds.

warmupRounds - Variable in class com.carrotsearch.junitbenchmarks.Result

warmupTime - Variable in class com.carrotsearch.junitbenchmarks.Result

WriterConsumer - Class in com.carrotsearch.junitbenchmarks

IResultsConsumer printing benchmark results to a given writer.

WriterConsumer() - Constructor for class com.carrotsearch.junitbenchmarks.WriterConsumer

WriterConsumer(Writer) - Constructor for class com.carrotsearch.junitbenchmarks.WriterConsumer

X

XML_FILE_PROPERTY - Static variable in class com.carrotsearch.junitbenchmarks.BenchmarkOptionsSystemProperties

"jub.xml.file": if set, an XMLConsumer is added to the consumers list.

xmlAttrEscape(String) - Static method in class com.carrotsearch.junitbenchmarks.Escape

Escape XML attribute's value.

XMLConsumer - Class in com.carrotsearch.junitbenchmarks

IResultsConsumer that writes XML files for each benchmark.

XMLConsumer() - Constructor for class com.carrotsearch.junitbenchmarks.XMLConsumer

Instantiate from global options.

XMLConsumer(File) - Constructor for class com.carrotsearch.junitbenchmarks.XMLConsumer

A B C D E G H I J L M O R S T U V W X