com.Ostermiller.util Java Utilities


com.Ostermiller.util
Class CmdLnArgumentException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by java.lang.IllegalArgumentException
                  extended by com.Ostermiller.util.CmdLnException
                      extended by com.Ostermiller.util.CmdLnArgumentException
All Implemented Interfaces:
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
Author:
Stephen Ostermiller http://ostermiller.org/contact.pl?regarding=Java+Utilities
See Also:
Serialized Form

Method Summary
 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
equals, 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 String getMessage()
Overrides:
getMessage in class Throwable
Returns:
message with the option name
Since:
ostermillerutils 1.07.00

com.Ostermiller.util Java Utilities


Copyright © 2001-2012 by Stephen Ostermiller