org.jasig.portal.channels.error.error2xml
Class DelegatingThrowableToElement

java.lang.Object
  org.jasig.portal.channels.error.error2xml.DelegatingThrowableToElement

All Implemented Interfaces:

IThrowableToElement

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class DelegatingThrowableToElement
extends Object
implements IThrowableToElement

A wrapper for a List of child ThrowableToElements and the logic to poll them in order, accepting the result from the first to support the given throwable. Defaults to the standard List of ThrowableToElement implementations, but provides API hooks to change the list. You can add handling for other Throwables by either editing this implementation code to include additional ThrowableToElement implementations by default or by injecting a different List of ThrowableToElement implementations where the instance of this class that CError actually uses is configured in applicationContext.xml.

Since:

uPortal 2.5

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Constructor Summary

DelegatingThrowableToElement()
Deprecated. Instantiate a DelegatingThrowableToElement with a default List of delegates.

Method Summary

List	getThrowableToElements() Deprecated. Get the List of ThrowableToElements delegates.
void	setThrowableToElements(List throwableToElements) Deprecated. Set the List of ThrowableToElement implementations which this implementation will poll in order.
boolean	supports(Class c) Deprecated. Returns true if the implementation knows how to translate an instance of the given class into an Element (throwableToElement() will return non-null) for instances of the class, which must extend Throwable).
Element	throwableToElement(Throwable t, Document parentDoc) Deprecated. Obtain an Element representing the throwable.
String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatingThrowableToElement

public DelegatingThrowableToElement()

Deprecated.

Instantiate a DelegatingThrowableToElement with a default List of delegates.

Method Detail

getThrowableToElements

public List getThrowableToElements()

Deprecated.

Get the List of ThrowableToElements delegates.

Returns:

Returns the List of throwableToElements delegates..

setThrowableToElements

public void setThrowableToElements(List throwableToElements)

Deprecated.

Set the List of ThrowableToElement implementations which this implementation will poll in order. The List should be in order from most specific to least specific.

Parameters:

throwableToElements - List of ThrowableToElement impls.

supports

public boolean supports(Class c)
                 throws IllegalArgumentException

Deprecated.

Description copied from interface: IThrowableToElement

Returns true if the implementation knows how to translate an instance of the given class into an Element (throwableToElement() will return non-null) for instances of the class, which must extend Throwable). Returns false if the implementation will return null for throwableToNode() on an instance of the class. Throws IllegalArgumentException if c is not a class which extends Throwable. Throws IllegalArgumentException if c is null.

Specified by:

supports in interface IThrowableToElement

Parameters:

c - a Class extending Throwable

Returns:

true if handles instances of c, false otherwise

Throws:

IllegalArgumentException - if c is null or does not extend Throwable

throwableToElement

public Element throwableToElement(Throwable t,
                                  Document parentDoc)
                           throws IllegalArgumentException

Deprecated.

Description copied from interface: IThrowableToElement

Obtain an Element representing the throwable. Throws IllegalArgumentException if t is null. Throws IllegalArgumentException if t is not supported, as indicated by the supports() method.

Specified by:

throwableToElement in interface IThrowableToElement

Parameters:

t - a supported throwable

parentDoc - document into which the element is to go

Returns:

an Element representing the Element

Throws:

IllegalArgumentException - if t is null.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object