name.kevinlocke.ultragetopt
Class InvalidOptionException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          name.kevinlocke.ultragetopt.CommandLineException
              name.kevinlocke.ultragetopt.InvalidOptionException

All Implemented Interfaces:

java.io.Serializable

public class InvalidOptionException
extends CommandLineException

Exception signaling that an option was determined to be invalid by the optionEncountered method. This exception is only thrown by an optionEncountered function written by an application programmer (the default optionEncountered method does nothing). It is intended to be used for signaling any condition that should terminate command-line processing and prevent the UltraGetopt constructor from returning.

Author:

Kevin Locke <kwl7@cornell.edu>

See Also:

CommandLineOption.optionEncountered(String), Serialized Form

Constructor Summary

InvalidOptionException(java.lang.String message)
Creates a new invalid option exception with the given error message.

Method Summary

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

InvalidOptionException

public InvalidOptionException(java.lang.String message)

Creates a new invalid option exception with the given error message.

Parameters:

message - the error message indicating the cause of this exception