org.sourcejammer.server.plugin
Class MissingParamException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--org.sourcejammer.util.SourceJammerExceptionChain
                    |
                    +--org.sourcejammer.server.plugin.MissingParamException

All Implemented Interfaces:

java.io.Serializable

public class MissingParamException

extends org.sourcejammer.util.SourceJammerExceptionChain

Exception thrown when a plugin deffinition does not include a required parameter. If thrown when initialising the plugin, it prevents the plugin from being loaded, with the subsequent save of resources (if a required param has not been set, the plugin will not work correctly anyway, so it is better to avoid calling its methods anyway). Of course, missing optional parameters should not cause this exception being trown. To know the name of the expected parameter, use getMissingParamName().

See Also:

Serialized Form

Field Summary

private java.lang.String

missingParam

Fields inherited from class org.sourcejammer.util.SourceJammerExceptionChain

Fields inherited from class java.lang.Exception

Fields inherited from class java.lang.Throwable

Constructor Summary

MissingParamException(java.lang.String param)

Method Summary

java.lang.String

getMissingParamName() Returns the name of the missing parameter that has provoked the exception.

Methods inherited from class org.sourcejammer.util.SourceJammerExceptionChain

getMessage, getPrevException, getProcessExceptionChain, printStackTrace, printStackTrace, printStackTrace, setProcessExceptionChain, toString

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace

Methods inherited from class java.lang.Object

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

Field Detail

missingParam

private java.lang.String missingParam

Constructor Detail

MissingParamException

public MissingParamException(java.lang.String param)

Method Detail

getMissingParamName

public java.lang.String getMissingParamName()

Returns the name of the missing parameter that has provoked the exception.