org.xins.common.collections

Class InvalidPropertyValueException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.xins.common.collections.PropertyException

org.xins.common.collections.InvalidPropertyValueException

All Implemented Interfaces:

Serializable

public final class InvalidPropertyValueException
extends PropertyException

Exception thrown to indicate the property of a value is invalid.

Since:

XINS 1.0.0

Version:

$Revision: 1.26 $ $Date: 2011/02/12 08:22:46 $

Author:

Ernst de Haan

See Also:

MissingRequiredPropertyException, Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidPropertyValueException(String propertyName, String propertyValue) Constructs a new InvalidPropertyValueException.
InvalidPropertyValueException(String propertyName, String propertyValue, String reason) Constructs a new InvalidPropertyValueException with the specified reason.

Method Summary

Methods

Modifier and Type	Method and Description
String	getPropertyValue() Returns the (invalid) value of the property.
String	getReason() Returns the description of the reason.

Methods inherited from class org.xins.common.collections.PropertyException

getPropertyName

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

InvalidPropertyValueException

public InvalidPropertyValueException(String propertyName,
                             String propertyValue)
                              throws IllegalArgumentException

Constructs a new InvalidPropertyValueException.

Parameters:

propertyName - the name of the property, cannot be null.

propertyValue - the (invalid) value set for the property, cannot be null.

Throws:

IllegalArgumentException - if propertyName == null || propertyValue == null.

InvalidPropertyValueException

public InvalidPropertyValueException(String propertyName,
                             String propertyValue,
                             String reason)
                              throws IllegalArgumentException

Constructs a new InvalidPropertyValueException with the specified reason.

Parameters:

propertyName - the name of the property, cannot be null.

propertyValue - the (invalid) value set for the property, cannot be null.

reason - additional description of the problem, or null.

Throws:

IllegalArgumentException - if propertyName == null || propertyValue == null.

Method Detail

getPropertyValue

public String getPropertyValue()

Returns the (invalid) value of the property.

Returns:

the value of the property, never null.

getReason

public String getReason()

Returns the description of the reason.

Returns:

the reason, or null.