BenchmarkConfiguration (Yardstick 0.6.3 API)

java.lang.Object
- org.yardstickframework.BenchmarkConfiguration

public class BenchmarkConfiguration
extends Object

Input arguments for benchmarks.

Constructor Summary

Constructors
Constructor and Description

BenchmarkConfiguration()

Constructors
Constructor and Description
`BenchmarkConfiguration()`

Method Summary

Methods
Modifier and Type	Method and Description
`String[]`	`commandLineArguments()`
`void`	`commandLineArguments(String[] cmdArgs)`
`Map<String,String>`	`customProperties()`
`void`	`customProperties(Map<String,String> customProps)`
`List<String>`	`defaultProbeClassNames()`
`void`	`defaultProbeClassNames(List<String> dfltProbeClsNames)`
`List<BenchmarkProbe>`	`defaultProbes()`
`void`	`defaultProbes(List<BenchmarkProbe> dfltProbes)`
`String`	`description()`
`String`	`driverName()`
`long`	`duration()`
`void`	`duration(long duration)`
`PrintStream`	`error()`
`void`	`error(PrintStream errorWriter)`
`boolean`	`help()`
`PrintStream`	`output()`
`void`	`output(PrintStream outputWriter)`
`String`	`outputFolder()`
`List<String>`	`packages()`
`void`	`packages(List<String> packages)`
`String`	`probeWriterClassName()`
`void`	`probeWriterClassName(String probeWriter)`
`String`	`propertiesFileName()`
`String`	`serverName()`
`boolean`	`shutdownHook()`
`void`	`shutdownHook(boolean shutdownHook)`
`int`	`threads()`
`void`	`threads(int threads)`
`String`	`toString()`
`long`	`warmup()`
`void`	`warmup(long warmup)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BenchmarkConfiguration
```
public BenchmarkConfiguration()
```
- Method Detail
  - propertiesFileName
```
public String propertiesFileName()
```
    Returns:
    Properties file name.
  - help
```
public boolean help()
```
    Returns:
    If help requested.
  - serverName
```
public String serverName()
```
    Returns:
    Benchmark server name.
  - driverName
```
public String driverName()
```
    Returns:
    Benchmark driver name.
  - packages
```
public List<String> packages()
```
    Returns:
    List of packages to load benchmarks from.
  - packages
```
public void packages(List<String> packages)
```
    Parameters:
    packages - List of packages to load benchmarks from.
  - threads
```
public int threads()
```
    Returns:
    Threads.
  - threads
```
public void threads(int threads)
```
    Parameters:
    threads - Number of threads to run benchmark on.
  - duration
```
public long duration()
```
    Returns:
    Duration, in seconds.
  - duration
```
public void duration(long duration)
```
    Parameters:
    duration - Duration, in seconds.
  - warmup
```
public long warmup()
```
    Returns:
    Warmup, in seconds.
  - warmup
```
public void warmup(long warmup)
```
    Parameters:
    warmup - Warmup time, in seconds.
  - shutdownHook
```
public boolean shutdownHook()
```
    Returns:
    True if shutdown hook should be added (true by default).
  - shutdownHook
```
public void shutdownHook(boolean shutdownHook)
```
    Parameters:
    shutdownHook - True if shutdown hook should be added.
  - customProperties
```
public Map<String,String> customProperties()
```
    Returns:
    Custom properties map.
  - customProperties
```
public void customProperties(Map<String,String> customProps)
```
    Parameters:
    customProps - Custom properties map.
  - output
```
public PrintStream output()
```
    Returns:
    Output writer.
  - output
```
public void output(PrintStream outputWriter)
```
    Parameters:
    outputWriter - Output writer.
  - error
```
public PrintStream error()
```
    Returns:
    Error writer.
  - error
```
public void error(PrintStream errorWriter)
```
    Parameters:
    errorWriter - Error writer.
  - commandLineArguments
```
public String[] commandLineArguments()
```
    Returns:
    Command line arguments list.
  - commandLineArguments
```
public void commandLineArguments(String[] cmdArgs)
```
    Parameters:
    cmdArgs - Command line arguments.
  - defaultProbeClassNames
```
public List<String> defaultProbeClassNames()
```
    Returns:
    Gets list of default probe class names.
  - defaultProbeClassNames
```
public void defaultProbeClassNames(List<String> dfltProbeClsNames)
```
    Parameters:
    dfltProbeClsNames - List of default probe class names.
  - defaultProbes
```
public List<BenchmarkProbe> defaultProbes()
```
    Returns:
    List of default probes.
  - defaultProbes
```
public void defaultProbes(List<BenchmarkProbe> dfltProbes)
```
    Parameters:
    dfltProbes - List of default probes.
  - probeWriterClassName
```
public String probeWriterClassName()
```
    Returns:
    Probe writer class name.
  - probeWriterClassName
```
public void probeWriterClassName(String probeWriter)
```
    Parameters:
    probeWriter - Probe writer class name.
  - outputFolder
```
public String outputFolder()
```
    Returns:
    Output folder.
  - description
```
public String description()
```
    Returns:
    Description.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class BenchmarkConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BenchmarkConfiguration

Method Detail

propertiesFileName

help

serverName

driverName

packages

packages

threads

threads

duration

duration

warmup

warmup

shutdownHook

shutdownHook

customProperties

customProperties

output

output

error

error

commandLineArguments

commandLineArguments

defaultProbeClassNames

defaultProbeClassNames

defaultProbes

defaultProbes

probeWriterClassName

probeWriterClassName

outputFolder

description

toString