com.martiansoftware.jsap
Class RequiredParameterMissingException

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.martiansoftware.jsap.JSAPException
              extended bycom.martiansoftware.jsap.RequiredParameterMissingException
All Implemented Interfaces:
Serializable

public class RequiredParameterMissingException
extends JSAPException

An exception indicating that a required parameter was missing from the supplied arguments and defaults.

Author:
Marty Lamb
See Also:
FlaggedOption.setAllowMultipleDeclarations(boolean), Option.required(), Serialized Form

Constructor Summary
RequiredParameterMissingException(String paramID)
          Creates a new RequiredParameterMissingException referencing the specified parameter.
 
Method Summary
 String getID()
          Returns the unique ID of the parameter that was missing.
 
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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RequiredParameterMissingException

public RequiredParameterMissingException(String paramID)
Creates a new RequiredParameterMissingException referencing the specified parameter.

Parameters:
paramID - the unique ID of the parameter that was missing.
Method Detail

getID

public String getID()
Returns the unique ID of the parameter that was missing.

Returns:
the unique ID of the parameter that was missing.


Copyright © 2002-2006, Martian Software, Inc.. All Rights Reserved.
For the latest version and documentation, please visit http://www.martiansoftware.com/jsap