com.Ostermiller.util
Class CmdLnArgumentException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              java.lang.IllegalArgumentException
                  com.Ostermiller.util.CmdLnException
                      com.Ostermiller.util.CmdLnArgumentException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ExtraCmdLnArgumentException, MissingCmdLnArgumentException

public class CmdLnArgumentException
extends CmdLnException

Exception thrown for a problem with a specific command line option. More information about this class and code samples for suggested use are available from ostermiller.org.

Since:

ostermillerutils 1.07.00

See Also:

Serialized Form

Method Summary

java.lang.String	getMessage()
CmdLnOption	getOption() Get the option that caused this exception
CmdLnResult	getResult() Get the partial result with missing arguments.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Detail

getResult

public CmdLnResult getResult()

Get the partial result with missing arguments.

Returns:

the partial result

Since:

ostermillerutils 1.07.00

getOption

public CmdLnOption getOption()

Get the option that caused this exception

Returns:

the option

Since:

ostermillerutils 1.07.00

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

Returns:

message with the option name

Since:

ostermillerutils 1.07.00