Class SbkYalParameters

java.lang.Object

io.sbk.params.impl.SbkInputOptions

io.sbk.params.impl.SbkYalParameters

All Implemented Interfaces:

InputOptions, ParsedOptions, ParseInputOptions, YalParameters

public class SbkYalParameters
extends SbkInputOptions
implements YalParameters

Field Summary

Fields

Modifier and Type	Field	Description
protected YalConfig	config

Constructor Summary

Constructors

Constructor	Description
SbkYalParameters(String name, String desc, YalConfig config)	Create a YAML parameters handler.

Method Summary

Modifier and Type	Method	Description
final String	getFileName()	Get the configured YAML file name.
String	getFileOptionDescription()	Build description text for the -file option including the default path.
String	getPrintOptionDescription()	Build description text for the -print option.
void	parseArgs(String[] args)	Parse arguments and update YalConfig.yamlFileName to reflect any override from CLI.

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 ParsedOptions

printHelp

Field Details

config

protected YalConfig config

Constructor Details

SbkYalParameters

public SbkYalParameters(String name,
 String desc,
 YalConfig config)

Create a YAML parameters handler.

Parameters:

name - benchmark name used in help header

desc - help description footer

config - YAL configuration holder (provides defaults, receives parsed values)

Method Details

getFileOptionDescription

public String getFileOptionDescription()

Build description text for the -file option including the default path.

Returns:

user-facing description for the file option

getFileName

public final String getFileName()

Description copied from interface: YalParameters

Get the configured YAML file name.

Specified by:

getFileName in interface YalParameters

Returns:

path or name of the YAML file to read

getPrintOptionDescription

public String getPrintOptionDescription()

Build description text for the -print option.

Returns:

user-facing description for the print option

parseArgs

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

Parse arguments and update YalConfig.yamlFileName to reflect any override from CLI.

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.