Class SbkParameters

java.lang.Object

io.sbk.params.impl.SbkInputOptions

io.sbk.params.impl.SbkParameters

All Implemented Interfaces:

ActionParameter, InputOptions, InputParameterOptions, ParameterOptions, Parameters, ParsedOptions, ParseInputOptions, ThreadTypeParameter

Direct Known Subclasses:

SbkDriversParameters

public sealed class SbkParameters
extends SbkInputOptions
implements InputParameterOptions
permits SbkDriversParameters

Parses and exposes common SBK benchmark parameters.

Builds the CLI schema for core options (writers/readers, size, records, seconds, throughput, step controls, read-only, idle sleep) and maps parsed values into typed getters via Lombok Getter annotations.

Semantics (high-level): - **writers/readers**: concurrency configuration; at least one must be > 0. - **size**: record size (bytes); required if workers > 0. - **records/seconds/throughput**: determine rate control and runtime. - **wstep/wsec, rstep/rsec**: step ramping configuration. - **ro**: read-only when both writers and readers are set. - **millisecsleep**: idle sleep in milliseconds between operations.

Constructor Summary

Constructors

Constructor	Description
SbkParameters(String name)	Construct parameters using the default description.
SbkParameters(String name, String desc)	Construct parameters with the given benchmark name and description.

Method Summary

Modifier and Type	Method	Description
void	parseArgs(String[] args)	Parse the provided arguments into a CommandLine.

Methods inherited from class SbkInputOptions

addOption, getHelpText, getOptionValue, getOptionValue, hasOption, hasOptionValue

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ActionParameter

getAction

Methods inherited from interface InputOptions

addOption, hasOption

Methods inherited from interface Parameters

getIdleSleepMilliSeconds, getReadersCount, getReadersStep, getReadersStepSeconds, getRecordSize, getRecordsPerSec, getRecordsPerSync, getTimeoutMS, getTotalRecords, getTotalSecondsToRun, getWritersCount, getWritersStep, getWritersStepSeconds

Methods inherited from interface ParsedOptions

getHelpText, getOptionValue, getOptionValue, hasOptionValue, printHelp

Methods inherited from interface ThreadTypeParameter

getThreadType

Constructor Details

SbkParameters

public SbkParameters(String name,
 String desc)

Construct parameters with the given benchmark name and description. Registers the standard SBK options and default values.

Parameters:

name - benchmark name

desc - help description

SbkParameters

public SbkParameters(String name)

Construct parameters using the default description.

Parameters:

name - benchmark name

Method Details

parseArgs

public void parseArgs(String[] args)
               throws org.apache.commons.cli.ParseException,
IllegalArgumentException,
HelpException

Description copied from class: SbkInputOptions

Parse the provided arguments into a CommandLine. If the help option is present, throws HelpException carrying the formatted help text.

Specified by:

parseArgs in interface ParseInputOptions

Overrides:

parseArgs in class SbkInputOptions

Parameters:

args - list of command line arguments.

Throws:

org.apache.commons.cli.ParseException - If an exception occurred.

IllegalArgumentException - If an exception occurred.

HelpException - If the 'help' option is supplied.