org.jdtaus.banking.dtaus

Class IllegalHeaderException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.jdtaus.banking.dtaus.IllegalHeaderException

All Implemented Interfaces:

Serializable

public abstract class IllegalHeaderException
extends IllegalArgumentException

Gets thrown whenever an illegal header is passed to a method expecting a legal header.

Example: Catching an IllegalHeaderException

 catch(IllegalHeaderException e)
 {
     if(e.getMessages().length > 0)
     {
         Fetch messages for well-known properties first (optional).
         e.getMessages(Header.PROP_XYZ);
         ...
         Fetch all remaining messages.
         e.getMessages();
         ...
     }
 }

Version:

$JDTAUS: IllegalHeaderException.java 8661 2012-09-27 11:29:58Z schulte $

Author:

Christian Schulte

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IllegalHeaderException() Creates a new IllegalHeaderException instance.

Method Summary

Methods

Modifier and Type	Method and Description
String	getMessage() Returns the message of the exception.
abstract Message[]	getMessages() Gets all messages describing the exception.
abstract Message[]	getMessages(String propertyName) Gets messages bound to a property removing these messages from the instance.
abstract String[]	getPropertyNames() Gets the names of all properties for which the exception holds messages.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, 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

IllegalHeaderException

public IllegalHeaderException()

Creates a new IllegalHeaderException instance.

Method Detail

getMessage

public String getMessage()

Returns the message of the exception.

Overrides:

getMessage in class Throwable

Returns:

The message of the exception.

getMessages

public abstract Message[] getMessages()

Gets all messages describing the exception.

Returns:

An array of messages describing the exception or an empty array if the instance does not hold any messages.

getMessages

public abstract Message[] getMessages(String propertyName)

Gets messages bound to a property removing these messages from the instance.

Parameters:

propertyName - the name of a property to return any messages for.

Returns:

All messages bound to a property with name propertyName or an empty array if the instance does not hold messages for a property with name propertyName.

Throws:

NullPointerException - if propertyName is null.

getPropertyNames

public abstract String[] getPropertyNames()

Gets the names of all properties for which the exception holds messages.

Returns:

An array of the names of all properties for which the exception holds messages or an empty array if the exception does not hold any message bound to a property.