com.radiusnetworks.util

Class MissingKeyException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

com.radiusnetworks.util.MissingKeyException

All Implemented Interfaces:

Serializable

public final class MissingKeyException
extends IllegalArgumentException

A MissingKeyException may be thrown when a method is invoked with a map argument which does not contain an expected or required key.

This is meant to express the absence of a mapping for a specified key. If instead the mapping is present but the value is null, and a null value it not permitted, use MissingValueException instead.

Since:

0.1.0

See Also:

IllegalArgumentException, Map.containsKey(Object), MissingValueException, Serialized Form

Constructor Summary

Constructors

Constructor and Description
MissingKeyException(String missingKey) Constructs a new MissingKeyException with the specified missing key.
MissingKeyException(String detailMessage, String missingKey) Constructs a new MissingValueException with the specified detail message and missing key.
MissingKeyException(String detailMessage, String missingKey, Throwable cause) Constructs a new MissingValueException with the specified detail message, missing key, and cause.
MissingKeyException(String missingKey, Throwable cause) Constructs a new MissingValueException with the specified missing key and cause.

Method Summary

Modifier and Type	Method and Description
String	getKey() Missing key which caused this exception.

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

MissingKeyException

public MissingKeyException(String missingKey)

Constructs a new MissingKeyException with the specified missing key.

The detail message will be set to "Missing key: missingKey". The cause is not initialized and may subsequently be initialized by a call to Throwable.initCause(Throwable).

Parameters:

missingKey - The key missing from the map which caused this exception. The key is saved for later retrieval by the MissingKeyException.getKey() method. May be null as some maps allow null keys.

MissingKeyException

public MissingKeyException(String missingKey,
                           Throwable cause)

Constructs a new MissingValueException with the specified missing key and cause.

The detail message will be set to "Missing key: missingKey". Note that the detail message associated with cause is not automatically incorporated in this missing key exception's detail message.

Parameters:

missingKey - The key missing from the map which caused this exception. The key is saved for later retrieval by the MissingKeyException.getKey() method. May be null as some maps allow null keys.

cause - The cause of this exception. This is saved for later retrieval by the Throwable.getCause() method. May be null which indicates that the cause is nonexistent or unknown.

MissingKeyException

public MissingKeyException(String detailMessage,
                           String missingKey)

Constructs a new MissingValueException with the specified detail message and missing key.

Note that missingKey is not automatically incorporated into the detail message. The cause is not initialized and may subsequently be initialized by a call to Throwable.initCause(Throwable).

Parameters:

detailMessage - The detail message for this exception. This is saved for later retrieval by the Throwable.getMessage() method.

missingKey - The key missing from the map which caused this exception. The key is saved for later retrieval by the MissingKeyException.getKey() method. May be null as some maps allow null keys.

MissingKeyException

public MissingKeyException(String detailMessage,
                           String missingKey,
                           Throwable cause)

Constructs a new MissingValueException with the specified detail message, missing key, and cause.

Note that missingKey and the detail message associated with cause are not automatically incorporated in this missing key exception's detail message.

Parameters:

detailMessage - The detail message for this exception. This is saved for later retrieval by the Throwable.getMessage() method.

missingKey - The key missing from the map which caused this exception. The key is saved for later retrieval by the MissingKeyException.getKey() method. May be null as some maps allow null keys.

cause - The cause of this exception. This is saved for later retrieval by the Throwable.getCause() method. May be null which indicates that the cause is nonexistent or unknown.

Method Detail

getKey

public String getKey()

Missing key which caused this exception.

Returns:

The missing key which caused this exception.