net.sf.eBus.messages

Class ValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

net.sf.eBus.messages.ValidationException

All Implemented Interfaces:

Serializable

public final class ValidationException
extends RuntimeException

This exception is thrown when message build fails due to an incorrectly configured message. This will be due to either required fields not being set or two or more fields set to incompatible values. That is setting one field to a given value restricts the values allowed for one or more other fields. This method is "fail slow" meaning that it should contain all the ConfigException.ValidationProblems found with the configured message and not the first problem.

This exception should not be thrown if a single field is set to an invalid value. Instead an exception is thrown by the setter method when given that invalid value.

Author:

Charles W. Rapp

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ValidationException(Class<? extends EMessageObject> mc, List<String> problems) Creates a new instance of ValidationException for the given message class and validation problems.

Method Summary

Modifier and Type	Method and Description
Class<? extends EMessageObject>	messageClass() Returns the message class experiencing the validation problems.
Iterable<String>	problems() Returns the validation problems as a read-only list.
String	toString() Returns text displaying the message validation problems.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationException

public ValidationException(Class<? extends EMessageObject> mc,
                           List<String> problems)

Creates a new instance of ValidationException for the given message class and validation problems.

Parameters:

mc - target message object class.

problems - discovered message class problems.

Method Detail

toString

public String toString()

Returns text displaying the message validation problems.

Overrides:

toString in class Throwable

Returns:

exception in text format.

messageClass

public Class<? extends EMessageObject> messageClass()

Returns the message class experiencing the validation problems.

Returns:

message object class.

problems

public Iterable<String> problems()

Returns the validation problems as a read-only list.

Returns:

problems list.