org.apache.jetspeed.portal
Class PortletException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--org.apache.jetspeed.portal.PortletException

public class PortletException

extends java.lang.Exception

The PortletException class defines a general exception that a portlet can throw when it encounters difficulty.

See Also:

Serialized Form

Constructor Summary

PortletException()
Constructs a new portlet exception.

PortletException(java.lang.String aMessage)
Constructs a new portlet exception with the given message.

PortletException(java.lang.String aMessage, java.lang.Throwable aCause)
Constructs a new portlet exception when the portlet needs to throw an exception and include a message about the "root case" that interfered with its normal operation, including a description message.

PortletException(java.lang.Throwable aCause)
Constructs a new portlet exception when the portlet needs to throw an exception.

Method Summary

java.lang.Throwable

getRootCause() Returns the exception that cause this portlet exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletException

public PortletException()

Constructs a new portlet exception.

PortletException

public PortletException(java.lang.String aMessage)

Constructs a new portlet exception with the given message. The message can be written to the server log and/or displayed for the user.

Parameters:

aMessage - the text of the exception message

PortletException

public PortletException(java.lang.String aMessage,
                        java.lang.Throwable aCause)

Constructs a new portlet exception when the portlet needs to throw an exception and include a message about the "root case" that interfered with its normal operation, including a description message.

Parameters:

aMessage - the text of the exception message

aCause - the root cause

PortletException

public PortletException(java.lang.Throwable aCause)

Constructs a new portlet exception when the portlet needs to throw an exception. The exception's message is based on the localized message of the underlying exception.

Parameters:

aCause - the root cause

Method Detail

getRootCause

public java.lang.Throwable getRootCause()

Returns the exception that cause this portlet exception.

Returns:

the Throwable that caused this portlet exception.