api

Import the contents of this singleton object to obtain access to most abstractions in the ScalaMeter API.

Note that some definitions might shadow others, so if you import the contents of this object, you should not import the contents of other packages directly.

This object contains:

basic datatypes and singleton objects for writing tests, such as PerformanceTest
all the context map keys
contents of the execution package
contents of the reporting package
contents of the persistence package
the Executor.Measurer object
the RegressionReporter.Tester object
the RegressionReporter.Historian object
the ChartReporter.ChartFactory object
the HtmlReporter.Renderer object
and much more...

Linear Supertypes

Keys, KeyContainer, AnyRef, Any

Type Members

type Aggregator[T] = scalameter.Aggregator[T]
type Bench[T] = scalameter.Bench[T]
type Context = scalameter.Context
type DsvReporter[T] = reporting.DsvReporter[T]
type Executor[T] = scalameter.Executor[T]
type GZIPJSONSerializationPersistor = persistence.GZIPJSONSerializationPersistor
type Gen[T] = scalameter.Gen[T]
type HtmlReporter[T] = reporting.HtmlReporter[T]
type JSONSerializationPersistor = persistence.JSONSerializationPersistor
type LoggingReporter[T] = reporting.LoggingReporter[T]
type Measurer[T] = scalameter.Measurer[T]
type MongoDbReporter[T] = reporting.MongoDbReporter[T]
type Persistor = scalameter.Persistor
type RegressionReporter[T] = reporting.RegressionReporter[T]
type Reporter[T] = scalameter.Reporter[T]
type SerializationPersistor = persistence.SerializationPersistor
type ValidationReporter[T] = reporting.ValidationReporter[T]
type Warmer = scalameter.Warmer
type benchmark = japi.annotation.benchmark
type ctx = japi.annotation.ctx
type curve = japi.annotation.curve
type gen = japi.annotation.gen
type scopeCtx = japi.annotation.scopeCtx
type scopes = japi.annotation.scopes
type setup = japi.annotation.setup
type setupBeforeAll = japi.annotation.setupBeforeAll
type teardown = japi.annotation.teardown
type teardownAfterAll = japi.annotation.teardownAfterAll
type warmup = japi.annotation.warmup
type PerformanceTest[T] = scalameter.Bench[T]

Annotations
@deprecated
Deprecated
(Since version 0.7) Please use Bench instead

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val Aggregator: scalameter.Aggregator.type
val Bench: scalameter.Bench.type
val Context: scalameter.Context.type
val DsvReporter: reporting.DsvReporter.type
val Executor: scalameter.Executor.type
val GZIPJSONSerializationPersistor: persistence.GZIPJSONSerializationPersistor.type
val Gen: scalameter.Gen.type
val Historian: reporting.RegressionReporter.Historian.type
val HtmlReporter: reporting.HtmlReporter.type
val JSONSerializationPersistor: persistence.JSONSerializationPersistor.type
val LocalExecutor: execution.LocalExecutor.type
val LoggingReporter: reporting.LoggingReporter.type
val Measurer: scalameter.Measurer.type
val MongoDbReporter: reporting.MongoDbReporter.type
val Persistor: scalameter.Persistor.type
val RegressionReporter: reporting.RegressionReporter.type
val Reporter: scalameter.Reporter.type
val SeparateJvmsExecutor: execution.SeparateJvmsExecutor.type
val SerializationPersistor: persistence.SerializationPersistor.type
val Tester: reporting.RegressionReporter.Tester.type
val ValidationReporter: reporting.ValidationReporter.type
val Warmer: scalameter.Warmer.type
def apply[T](name: String, defaultValue: T)(implicit arg0: Pickler[T], container: KeyContainer): KeyWithDefaultValue[T]

Definition Classes
Keys
def apply[T](name: String)(implicit arg0: Pickler[T], container: KeyContainer): Key[T]

Definition Classes
Keys
final def asInstanceOf[T0]: T0

Definition Classes
Any
val classpath: KeyWithDefaultValue[ClassPath]

Definition Classes
Keys
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
implicit def container: KeyContainer

Definition Classes
KeyContainer
val containerName: String

Definition Classes
KeyContainer
object dsl extends KeyContainer

Definition Classes
Keys
val enclosing: KeyContainer

Definition Classes
KeyContainer
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object exec extends KeyContainer

Definition Classes
Keys
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def parseKey(keyName: String): Key[_]

Definition Classes
KeyContainer
val preJDK7: KeyWithDefaultValue[Boolean]

Definition Classes
Keys
object reports extends KeyContainer

Definition Classes
Keys
val scopeFilter: KeyWithDefaultValue[String]

Definition Classes
Keys
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
val verbose: KeyWithDefaultValue[Boolean]

Definition Classes
Keys
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

val PerformanceTest: scalameter.Bench.type

Annotations
@deprecated
Deprecated
(Since version 0.7) Please use Bench instead

object api extends Keys

Type Members

type Aggregator[T] = scalameter.Aggregator[T]

type Bench[T] = scalameter.Bench[T]

type Context = scalameter.Context

type DsvReporter[T] = reporting.DsvReporter[T]

type Executor[T] = scalameter.Executor[T]

type GZIPJSONSerializationPersistor = persistence.GZIPJSONSerializationPersistor

type Gen[T] = scalameter.Gen[T]

type HtmlReporter[T] = reporting.HtmlReporter[T]

type JSONSerializationPersistor = persistence.JSONSerializationPersistor

type LoggingReporter[T] = reporting.LoggingReporter[T]

type Measurer[T] = scalameter.Measurer[T]

type MongoDbReporter[T] = reporting.MongoDbReporter[T]

type Persistor = scalameter.Persistor

type RegressionReporter[T] = reporting.RegressionReporter[T]

type Reporter[T] = scalameter.Reporter[T]

type SerializationPersistor = persistence.SerializationPersistor

type ValidationReporter[T] = reporting.ValidationReporter[T]

type Warmer = scalameter.Warmer

type benchmark = japi.annotation.benchmark

type ctx = japi.annotation.ctx

type curve = japi.annotation.curve

type gen = japi.annotation.gen

type scopeCtx = japi.annotation.scopeCtx

type scopes = japi.annotation.scopes

type setup = japi.annotation.setup

type setupBeforeAll = japi.annotation.setupBeforeAll

type teardown = japi.annotation.teardown

type teardownAfterAll = japi.annotation.teardownAfterAll

type warmup = japi.annotation.warmup

type PerformanceTest[T] = scalameter.Bench[T]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val Aggregator: scalameter.Aggregator.type

val Bench: scalameter.Bench.type

val Context: scalameter.Context.type

val DsvReporter: reporting.DsvReporter.type

val Executor: scalameter.Executor.type

val GZIPJSONSerializationPersistor: persistence.GZIPJSONSerializationPersistor.type

val Gen: scalameter.Gen.type

val Historian: reporting.RegressionReporter.Historian.type

val HtmlReporter: reporting.HtmlReporter.type

val JSONSerializationPersistor: persistence.JSONSerializationPersistor.type

val LocalExecutor: execution.LocalExecutor.type

val LoggingReporter: reporting.LoggingReporter.type

val Measurer: scalameter.Measurer.type

val MongoDbReporter: reporting.MongoDbReporter.type

val Persistor: scalameter.Persistor.type

val RegressionReporter: reporting.RegressionReporter.type

val Reporter: scalameter.Reporter.type

val SeparateJvmsExecutor: execution.SeparateJvmsExecutor.type

val SerializationPersistor: persistence.SerializationPersistor.type

val Tester: reporting.RegressionReporter.Tester.type

val ValidationReporter: reporting.ValidationReporter.type

val Warmer: scalameter.Warmer.type

def apply[T](name: String, defaultValue: T)(implicit arg0: Pickler[T], container: KeyContainer): KeyWithDefaultValue[T]

def apply[T](name: String)(implicit arg0: Pickler[T], container: KeyContainer): Key[T]

final def asInstanceOf[T0]: T0

val classpath: KeyWithDefaultValue[ClassPath]

def clone(): AnyRef

implicit def container: KeyContainer

val containerName: String

object dsl extends KeyContainer

val enclosing: KeyContainer

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

object exec extends KeyContainer

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parseKey(keyName: String): Key[_]

val preJDK7: KeyWithDefaultValue[Boolean]