net.sf.mmm.util.value.api

Class ValueOutOfRangeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.sf.mmm.util.exception.api.NlsRuntimeException

net.sf.mmm.util.value.api.ValueException

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

All Implemented Interfaces:

Serializable, Cloneable, NlsThrowable, AttributeReadMessage, AttributeReadMessageCode, AttributeReadUuid, NlsObject

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

Fields

Modifier and Type	Field and Description
static String	MESSAGE_CODE
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_CONTAINER, KEY_DEFAULT, KEY_DIRECTORY, KEY_ERROR, KEY_EXISTING, KEY_EXPECTED, 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_USER, KEY_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValueOutOfRangeException() The constructor for de-serialization in GWT.
	ValueOutOfRangeException(Number value, Number minimum, Number maximum) The constructor.
	ValueOutOfRangeException(Number value, Number minimum, Number maximum, Object valueSource) The constructor.
	ValueOutOfRangeException(Object valueSource, V value, V minimum, V maximum) The constructor.

Method Summary

Modifier and Type	Method and Description
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.
static <V> NlsMessage	createMessage(V value, V minimum, V maximum, Object valueSource) Creates a new error NlsMessage that the given value is not in the Range from minimum to maximum.
String	getCode() This method gets the code that identifies the detailed type of this object.
private <V extends Comparable> void	verifyComparable(V value, V minimum, V maximum) Verifies that the value is actually out of range.
private void	verifyNumber(Number value, Number minimum, Number maximum) Verifies that the value is actually out of range.

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

createBundle, createCopy, createCopyViaClone, createUuid, getLocalizedMessage, getLocalizedMessage, getLocalizedMessage, getMessage, getNlsMessage, getUuid, isForUser, isTechnical, printStackTrace, toNlsMessage, toString, toString, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

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.exception.api.NlsThrowable

getCause, getStackTrace

Field Detail

serialVersionUID

private static final long serialVersionUID

UID for serialization.

See Also:

Constant Field Values

MESSAGE_CODE

public static final String MESSAGE_CODE

See Also:

getCode(), Constant Field Values

Constructor Detail

ValueOutOfRangeException

protected ValueOutOfRangeException()

The constructor for de-serialization in GWT.

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.

ValueOutOfRangeException

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

The constructor.

Type Parameters:

V - is the generic type of the values.

Parameters:

valueSource - describes the source of the value or null if NOT available. 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.

value - is the number that is out of range.

minimum - is the minimum value allowed

maximum - is the maximum value allowed.

Since:

3.0.0

Method Detail

verifyComparable

private <V extends Comparable> void verifyComparable(V value,
                                                     V minimum,
                                                     V maximum)

Verifies that the value is actually out of range.

Type Parameters:

V - is the generic type of the values.

Parameters:

value - is the number that is out of range.

minimum - is the minimum value allowed

maximum - is the maximum value allowed.

verifyNumber

private void verifyNumber(Number value,
                          Number minimum,
                          Number maximum)

Verifies that the value is actually out of range.

Parameters:

value - is the number that is out of range.

minimum - is the minimum value allowed

maximum - is the maximum value allowed.

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.

createMessage

public static <V> NlsMessage createMessage(V value,
                                           V minimum,
                                           V maximum,
                                           Object valueSource)

Creates a new error NlsMessage that the given value is not in the Range from minimum to maximum.

Type Parameters:

V - is the generic type of the values. Needs to be an instance of Number or Comparable.

Parameters:

value - is the invalid value.

minimum - is the minimum value or null if unbounded.

maximum - is the maximum value or null if unbounded.

valueSource - describes the source of value or null if unknown.

Returns:

the error NlsMessage.

getCode

public String getCode()

This method gets the code that identifies the detailed type of this object. While UUID or ID are typically unique per instance of an object the code is unique for all instances of the exact same kind. So e.g. a particular kind of exception or ValidationFailure can be identified by its code. A simple generic implementation may return the classname or the key of the NLS message. However, the code should remain stable after refactoring (so at least after the rename the previous code should be returned as String literal). This code may be used as a compact identifier to reference the related problem or information as well as for automatic tests of error situations that should remain stable even if the message text gets improved or the locale is unknown.

Specified by:

getCode in interface AttributeReadMessageCode

Overrides:

getCode in class NlsRuntimeException

Returns:

the message text.

See Also:

Throwable.getMessage(), NlsThrowable, Message