org.jdtaus.banking.dtaus.spi

Class IllegalHeaderException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

java.lang.IllegalArgumentException

org.jdtaus.banking.dtaus.IllegalHeaderException

org.jdtaus.banking.dtaus.spi.IllegalHeaderException

All Implemented Interfaces:

Serializable

public class IllegalHeaderException
extends IllegalHeaderException

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

Example: Throwing an IllegalHeaderException

 IllegalHeaderException e = new IllegalHeaderException();
 e.addMessage(message);
 e.addMessage(Header.PROP_XYZ, message);
 throw e;

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
void	addMessage(Message message) Adds a message to the instance.
void	addMessage(String propertyName, Message message) Adds a message bound to a property to the instance.
void	addMessages(Messages messages) Adds messages to the instance.
void	addMessages(String propertyName, Messages messages) Adds messages bound to a property to the instance.
Message[]	getMessages() Gets all messages describing the exception.
Message[]	getMessages(String propertyName) Gets messages bound to a property removing these messages from the instance.
String[]	getPropertyNames() Gets the names of all properties for which the exception holds messages.
String	toString() Returns a string representation of the object.

Methods inherited from class org.jdtaus.banking.dtaus.IllegalHeaderException

getMessage

Methods inherited from class java.lang.Throwable

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

IllegalHeaderException

public IllegalHeaderException()

Creates a new IllegalHeaderException instance.

Method Detail

addMessage

public void addMessage(Message message)

Adds a message to the instance.

Parameters:

message - The message to add to the instance.

Throws:

NullPointerException - if message is null.

addMessage

public void addMessage(String propertyName,
              Message message)

Adds a message bound to a property to the instance.

Parameters:

propertyName - The name of a property message is bound to.

message - The message to add to the instance.

Throws:

NullPointerException - if either message or propertyName is null.

addMessages

public final void addMessages(Messages messages)

Adds messages to the instance.

Parameters:

messages - The messages to add to the instance.

Throws:

NullPointerException - if messages is null.

addMessages

public final void addMessages(String propertyName,
               Messages messages)

Adds messages bound to a property to the instance.

Parameters:

propertyName - The name of a property messages are bound to.

messages - The messages to add to the instance.

Throws:

NullPointerException - if either messages or propertyName is null.

getMessages

public Message[] getMessages()

Gets all messages describing the exception.

Specified by:

getMessages in class IllegalHeaderException

Returns:

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

getMessages

public Message[] getMessages(String propertyName)

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

Specified by:

getMessages in class IllegalHeaderException

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 String[] getPropertyNames()

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

Specified by:

getPropertyNames in class IllegalHeaderException

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.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Throwable

Returns:

A string representation of the object.