com.portal.common

Class CommandLineParser.InvalidOptionsException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.portal.common.CommandLineParser.InvalidOptionsException

All Implemented Interfaces:

Serializable

Enclosing class:

CommandLineParser

public class CommandLineParser.InvalidOptionsException
extends Exception

Signals that an exception occurred while the command line arguments were being parsed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidOptionsException(CommandLineParser parser, String msg) An error occurred while parsing the command line arguments.

Method Summary

Modifier and Type	Method and Description
String[]	getArgs() Get the command line arguments that could not be parsed.
String	getHelp() Get the help string that describes the syntax required by the options class and a desciption of each option supported.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

InvalidOptionsException

public InvalidOptionsException(CommandLineParser parser,
                               String msg)

An error occurred while parsing the command line arguments.

Parameters:

parser - The parser class that encountered an error when parsing the command line arguments.

msg - A non-localized string description of the error.

Method Detail

getArgs

public String[] getArgs()

Get the command line arguments that could not be parsed.

Returns:

The command line arguments that could not be parsed.

getHelp

public String getHelp()

Get the help string that describes the syntax required by the options class and a desciption of each option supported.

Returns:

The appropriate help string.