org.xins.common.types

Class TypeValueException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.xins.common.types.TypeValueException

All Implemented Interfaces:

Serializable

public class TypeValueException
extends Exception

Exception thrown to indicate a value is invalid for a certain type.

Since:

XINS 1.0.0

Version:

$Revision: 1.20 $ $Date: 2012/03/15 21:07:39 $

Author:

Ernst de Haan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TypeValueException(Type type, String value) Creates a new TypeValueException.
TypeValueException(Type type, String value, String detail) Creates a new TypeValueException.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDetail() Retrieves the additional detail information passed to the constructor.
Type	getType() Retrieves the type.
String	getValue() Retrieves the value that was considered invalid.

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

TypeValueException

public TypeValueException(Type type,
                  String value)
                   throws IllegalArgumentException

Creates a new TypeValueException.

Parameters:

type - the type, not null.

value - the value, not null.

Throws:

IllegalArgumentException - if type == null || value == null.

TypeValueException

public TypeValueException(Type type,
                  String value,
                  String detail)
                   throws IllegalArgumentException

Creates a new TypeValueException.

Parameters:

type - the type, not null.

value - the value, not null.

detail - additional detail information, can be null.

Throws:

IllegalArgumentException - if type == null || value == null.

Method Detail

getType

public final Type getType()

Retrieves the type.

Returns:

the type, never null.

getValue

public final String getValue()

Retrieves the value that was considered invalid.

Returns:

the value that was considered invalid, not null.

getDetail

public final String getDetail()

Retrieves the additional detail information passed to the constructor. This information is optional.

Returns:

the additional detailed information, can be null.

Since:

XINS 1.2.0