Package io.confound.config

Class MissingParameterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalStateException

io.confound.config.ConfigurationException

io.confound.config.MissingParameterException

All Implemented Interfaces:

java.io.Serializable

public class MissingParameterException
extends ConfigurationException

A configuration exception indicating that a configuration parameter was not found.

Author:

Garret Wilson

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
MissingParameterException(java.lang.String key)	Key constructor.
MissingParameterException(java.lang.String message, java.lang.String key)	Message and key constructor.
MissingParameterException(java.lang.String message, java.lang.String key, java.lang.Throwable cause)	Message and cause constructor.
MissingParameterException(java.lang.String key, java.lang.Throwable cause)	Cause constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getKey()

Methods inherited from class java.lang.Throwable

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

MissingParameterException

public MissingParameterException(@Nonnull
                                 java.lang.String key)

Key constructor.

Parameters:

key - The key of the configuration parameter that was not found.

MissingParameterException

public MissingParameterException(@Nullable
                                 java.lang.String message,
                                 @Nonnull
                                 java.lang.String key)

Message and key constructor.

Parameters:

message - An explanation of why the input could not be parsed, or null if a default message should be used.

key - The key of the configuration parameter that was not found.

MissingParameterException

public MissingParameterException(@Nonnull
                                 java.lang.String key,
                                 @Nullable
                                 java.lang.Throwable cause)

Cause constructor.

Parameters:

key - The key of the configuration parameter that was not found.

cause - The cause error or null if the cause is nonexistent or unknown.

MissingParameterException

public MissingParameterException(@Nullable
                                 java.lang.String message,
                                 @Nonnull
                                 java.lang.String key,
                                 @Nullable
                                 java.lang.Throwable cause)

Message and cause constructor.

Parameters:

message - An explanation of why the input could not be parsed, or null if a default message should be used.

key - The key of the configuration parameter that was not found.

cause - The cause error or null if the cause is nonexistent or unknown.

Method Detail

getKey

public java.lang.String getKey()

Returns:

The key for the missing parameter.