com.programix.value
Class ValueMapRequiredKeyException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              com.programix.value.ValueMapException
                  com.programix.value.ValueMapRequiredKeyException

All Implemented Interfaces:

Serializable

public class ValueMapRequiredKeyException
extends ValueMapException

A special kind of ValueMapException used to indicate that a required key was not found in a ValueMap. This is a RuntimeException, so it can be generally ignored when it is unexpected (use of try/catch is not required).

Author:

Paul Hyde

See Also:

Serialized Form

Constructor Summary

ValueMapRequiredKeyException(String keyName)
Pass in the name of the expected key.

Method Summary

String

getKeyName()

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

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

Constructor Detail

ValueMapRequiredKeyException

public ValueMapRequiredKeyException(String keyName)

Pass in the name of the expected key. The resulting message is generated from this:

     "Required key '" + keyName + "' not found."
 

The getKeyName() method can be used to retrieve the exact key name if desired.

Method Detail

getKeyName

public String getKeyName()