A C G I M P R S U

A

ArgumentCommand - interface com.nevelex.app.args.ArgumentCommand.

Base command-line argument command object.

ArgumentConsumer - interface com.nevelex.app.args.ArgumentConsumer.

Interface defining specific methods called on the argument consumer before and after the ArgumentProcessor's processing of arguments.

ArgumentException - exception com.nevelex.app.args.ArgumentException.

The base exception used for command-line argument exceptions.

ArgumentException(String, int) - Constructor for class com.nevelex.app.args.ArgumentException

Constructs a UnknownArgumentException with the supplied detailed message.

ArgumentProcessor - class com.nevelex.app.args.ArgumentProcessor.

SINGLETON object used to processes the consumption of every command-line argument passed in to an application.

C

checkArgumentState() - Method in interface com.nevelex.app.args.ArgumentConsumer

The method is called by the ArgumentProcessor after all the arguments have been processed by the application.

com.nevelex.app.args - package com.nevelex.app.args

Re-usable Command Pattern implementation for processing command-line arguments passed to a Java Application.

consumeArgument(String[], int) - Method in interface com.nevelex.app.args.ArgumentCommand

This method will attempt to consume the current command-line argument.

G

getArgumentCommand(String) - Static method in class com.nevelex.app.args.ArgumentProcessor

Returns the associated ArgumentCommand object for the supplied argumentName.

getOffset() - Method in class com.nevelex.app.args.ArgumentException

Returns the offset in to the argument array where the error was generated.

I

initArgumentState() - Method in interface com.nevelex.app.args.ArgumentConsumer

The method is called by the ArgumentProcessor before any the arguments have been processed by the application.

InvalidArgumentException - exception com.nevelex.app.args.InvalidArgumentException.

Exception thrown when the command-line argument was supplied with all of its required parameters.

InvalidArgumentException(String, int) - Constructor for class com.nevelex.app.args.InvalidArgumentException

Constructs a InvalidArgumentException with the supplied detailed message.

M

MissingArgumentException - exception com.nevelex.app.args.MissingArgumentException.

Exception thrown when the command-line argument list is missing a required argument.

MissingArgumentException(String) - Constructor for class com.nevelex.app.args.MissingArgumentException

Constructs a MissingArgumentException with the supplied detailed message.

P

processArguments(String[]) - Static method in class com.nevelex.app.args.ArgumentProcessor

Processes the argument list.

processArguments(String[], int, int) - Static method in class com.nevelex.app.args.ArgumentProcessor

Processes the argument list.

R

registerArgumentCommand(String, ArgumentCommand) - Static method in class com.nevelex.app.args.ArgumentProcessor

Registers an ArgumentCommand concrete class to handle the supplied command-line argument.

registerArgumentCommand(String, String, ArgumentCommand) - Static method in class com.nevelex.app.args.ArgumentProcessor

Registers an ArgumentCommand concrete class to handle the supplied long and short version of a command-line argument.

S

setArgumentConsumer(ArgumentConsumer) - Static method in class com.nevelex.app.args.ArgumentProcessor

Sets the ArgumentConsumer object used to verify that all required arguments have been given on the command-line.

U

UnknownArgumentException - exception com.nevelex.app.args.UnknownArgumentException.

Exception thrown when the command-line argument is not recognized.

UnknownArgumentException(String, int) - Constructor for class com.nevelex.app.args.UnknownArgumentException

Constructs a UnknownArgumentException with the supplied detailed message.

A C G I M P R S U