com.radiusnetworks.util

Class MissingValueException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

com.radiusnetworks.util.MissingValueException

All Implemented Interfaces:

Serializable

public final class MissingValueException
extends IllegalArgumentException

A MissingValueException may be thrown when a method is invoked with a map argument which is missing a value for an expected key.

This is an alternative to a NullPointerException. A MissingValueException should imply that the associated key mapping is present and only the value is missing (e.g. null). Additionally, this may also be used for values which implicitly represent the absence of something (e.g. the empty string (""), an unset integer (-1), etc.).

Since:

0.1.0

See Also:

IllegalArgumentException, MissingKeyException, Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getKey() Key missing a value 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

MissingValueException

public MissingValueException(String missingKey)

Constructs a new MissingValueException with the specified key which is missing a value.

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

Parameters:

missingKey - The key which is present in the map but is missing a value. The key is saved for later retrieval by the MissingValueException.getKey() method. May be null as some maps allow null keys.

MissingValueException

public MissingValueException(String missingKey,
                             Throwable cause)

Constructs a new MissingValueException with the specified key, which is missing a value, and cause.

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

Parameters:

missingKey - The key which is present in the map but is missing a value. The key is saved for later retrieval by the MissingValueException.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.

MissingValueException

public MissingValueException(String detailMessage,
                             String missingKey)

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

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 which is present in the map but is missing a value. The key is saved for later retrieval by the MissingValueException.getKey() method. May be null as some maps allow null keys.

MissingValueException

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

Constructs a new MissingValueException with the specified detail message, key which is missing a value, 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 which is present in the map but is missing a value. The key is saved for later retrieval by the MissingValueException.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()

Key missing a value which caused this exception.

Returns:

The key which is missing a value that caused this exception.