net.sf.mmm.util.value.api
Class ValueOutOfRangeException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              net.sf.mmm.util.nls.api.AbstractNlsRuntimeException
                  net.sf.mmm.util.nls.api.NlsRuntimeException
                      net.sf.mmm.util.value.api.ValueException
                          net.sf.mmm.util.value.api.ValueOutOfRangeException

All Implemented Interfaces:

Serializable, NlsObject, NlsThrowable

public class ValueOutOfRangeException
extends ValueException

This is the exception thrown if a numeric value is not in the expected range.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

GenericValueConverter.convertValue(Object, Object, Number, Number), Serialized Form

Field Summary

private static long

serialVersionUID UID for serialization.

Fields inherited from interface net.sf.mmm.util.nls.api.NlsObject

KEY_ANNOTATION, KEY_ARGUMENT, KEY_CAPACITY, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_FILE, KEY_FUNCTION, KEY_ID, KEY_KEY, KEY_LOCATION, KEY_MAX, KEY_MIN, KEY_MODE, KEY_NAME, KEY_OBJECT, KEY_OPERAND, KEY_OPERATION, KEY_OPTION, KEY_PATH, KEY_PROPERTY, KEY_QUERY, KEY_RESOURCE, KEY_SIZE, KEY_SOURCE, KEY_TARGET_TYPE, KEY_TITLE, KEY_TYPE, KEY_URI, KEY_VALUE

Constructor Summary

ValueOutOfRangeException(Number value, Number minimum, Number maximum)
The constructor.

ValueOutOfRangeException(Number value, Number minimum, Number maximum, Object valueSource)
The constructor.

Method Summary

static void

checkRange(Number value, Number minimum, Number maximum, Object valueSource) This method checks that the given value is in the inclusive range from minimum to maximum.

Methods inherited from class net.sf.mmm.util.nls.api.NlsRuntimeException

addToMap, toMap, toMap, toMap

Methods inherited from class net.sf.mmm.util.nls.api.AbstractNlsRuntimeException

createUuid, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getUuid, printStackTrace, printStackTrace, printStackTrace, printStackTrace, toNlsMessage

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.util.nls.api.NlsThrowable

getCause, getStackTrace

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

Constructor Detail

ValueOutOfRangeException

public ValueOutOfRangeException(Number value,
                                Number minimum,
                                Number maximum)

The constructor.

Parameters:

value - is the number that is out of range.

minimum - is the minimum value allowed

maximum - is the maximum value allowed.

ValueOutOfRangeException

public ValueOutOfRangeException(Number value,
                                Number minimum,
                                Number maximum,
                                Object valueSource)

The constructor.

Parameters:

value - is the number that is out of range.

minimum - is the minimum value allowed

maximum - is the maximum value allowed.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier.

Method Detail

checkRange

public static void checkRange(Number value,
                              Number minimum,
                              Number maximum,
                              Object valueSource)
                       throws ValueOutOfRangeException

This method checks that the given value is in the inclusive range from minimum to maximum.

Parameters:

value - is the value to check.

minimum - is the minimum number allowed.

maximum - is the maximum number allowed.

valueSource - describes the source of the value. This may be the filename where the value was read from, an XPath where the value was located in an XML document, etc. It is used in exceptions thrown if something goes wrong. This will help to find the problem easier. It may be null if there is no helpful source available.

Throws:

ValueOutOfRangeException - - if the given value is NOT in the range from minimum to maximum.