Args

Class Args

Summary

The Args class accepts a list of strings corresponding to the program parameter list, separates options (parameters starting with 1 or more hyphens ["-"]) from arguments (parameters) that don't start with a hyphen) and provides convenient and efficient separate handling of those options and arguments. Options may have values as in --cmd=write. If an option is duplicated, the values (if any) are kept in order. Arguments are also kept in order.

The class may also be given a set of valid option names (without the leading hyphens. If given such a set, then any options that are not in the set are flagged to standard error and program execution is halted. The class can also be given a procedure to call prior to program termination when bad options are found. Usually, this is used to display a help message.

Superclasses:: Object
Package:: util
File:: args.icn

Methods:

genArgs, genOptDefs, genOptNames, getArgs, getOpt, getOptDef, getOptDefs

Methods inherited from Object:

Type, className, clone, equals, fieldNames, genMethods, getField, get_class, get_class_name, get_id, hasField, hasMethod, hash_code, instanceOf, invoke, is_instance, setField, to_string

Fields:

argList, badOptions, optionMap

Source code.

Details

Constructor

Args(params, validOptions, helpMesg)

Parameters:

`params`	List of parametes
`validOptions`	Option set of valid option names
`helpMesg`	Optional help message procedure to be called if any invalid options are found

Accept a list of arguments and process for efficient handling

Methods:

genArgs()

Generates:

arguments

Generate the arguments (with options stripped out).

genOptDefs(option, defValue)

Parameters: