This framework allows various components from the harvester to launch using a uniform style of XML configuration file and/or command-line parameters. By providing this framework, there is uniformity and continuity between each separate task and promotes modularity.
Argument Definition Class
public class ArgDef
Constructors
- public constructor()
Mutators - public setShortOption(shortOpt:char) : ArgDef
- public setLongOption(longOpt:String) : ArgDef
- public setDescription(description:String) : ArgDef
- public setRequired(required:boolean) : ArgDef
- public setDefaultValue(valueDefault:String) : ArgDef
- public withParameter(required:boolean, description:String) : ArgDef
- public withParameters(required:boolean, description:String) : ArgDef
- public withParameters(required:boolean, description:String, numParams:int) : ArgDef
Accessors - public getShortOption() : char
- public getLongOption() : String
- public isRequired() : boolean
- public hasDefaultValue() : boolean
- public getDefaultValue() : String
- public getDescription() : String
- public hasParameter() : boolean
- public hasParameters() : boolean
- public numParameters() : int
- public isParameterRequired() : boolean
- public getParameterDescription() : String
Argument Parser Class
public class ArgParser
Constructors
- public constructor(appName:String)
Mutators - public addArgument(arg:ArgDef) : void
Accessors - public getUsage() : String
- public getAppName() : String
- public getArgDefs() : Collection<ArgDef>
- public getOptMap() : Map<String,ArgDef>
- protected getOptions() : apache.commons.cli.Options
Utilities - public parse(args:String[]) : ArgList
Parsed Argument List Class
public class ArgList
Constructors
- public constructor(p:ArgParser, args:String[])
Accessors - public get(arg:String) : String
- public getAll(arg:String, includeDefaultValue:boolean) : List<String>
- public has(arg:String) : boolean
