com.martiansoftware.jsap
Class RequiredParameterMissingException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.martiansoftware.jsap.JSAPException
              com.martiansoftware.jsap.RequiredParameterMissingException

All Implemented Interfaces:

java.io.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(java.lang.String paramID)
Creates a new RequiredParameterMissingException referencing the specified parameter.

Method Summary

java.lang.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(java.lang.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 java.lang.String getID()

Returns the unique ID of the parameter that was missing.

Returns:

the unique ID of the parameter that was missing.