Overview

Package

Class

Tree

Serialized

Deprecated

Index

Help

PREV class NEXT class

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.portlet
Class PortletException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          javax.servlet.ServletException
              org.apache.jetspeed.portlet.PortletException

All Implemented Interfaces:

java.io.Serializable

public class PortletException

extends javax.servlet.ServletException

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

Since:

4.1

See Also:

Serialized Form

Constructor Summary

PortletException()
Constructs a new portlet exception.

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

PortletException(java.lang.String text, java.lang.Throwable cause)
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 cause)
Constructs a new portlet exception when the portlet needs to throw an exception.

Method Summary
void	printStackTrace() Prints the stack trace of this exception to the standard error stream.
void	printStackTrace(java.io.PrintStream out) Prints the stack trace of this exception to the specified print stream.
void	printStackTrace(java.io.PrintWriter out) Prints the stack trace of this exception to the specified print writer.

Methods inherited from class javax.servlet.ServletException

getRootCause

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, setStackTrace, 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 text)

Constructs a new portlet exception with the given text. The portlet container may use the text write it to a log.

Parameters:

text - the exception text

PortletException

public PortletException(java.lang.String text,
                        java.lang.Throwable cause)

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:

text - the exception text

cause - the root cause

PortletException

public PortletException(java.lang.Throwable cause)

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:

cause - the root cause

Method Detail

printStackTrace

public void printStackTrace()

Prints the stack trace of this exception to the standard error stream.

printStackTrace

public void printStackTrace(java.io.PrintStream out)

Prints the stack trace of this exception to the specified print stream.

Parameters:

out - the PrintStream to use for output

printStackTrace

public void printStackTrace(java.io.PrintWriter out)

Prints the stack trace of this exception to the specified print writer.

Parameters:

out - the PrintWriter to use for output.