javax.portlet: public class: PortletException

javax.portlet
public class: PortletException [javadoc | source]

java.lang.Object
   java.lang.Throwable
      java.lang.Exception
         javax.portlet.PortletException

All Implemented Interfaces:
Serializable

Direct Known Subclasses:
PortletSecurityException, WindowStateException, ValidatorException, UnavailableException, PortletModeException, ReadOnlyException

The PortletException class defines a general exception that a portlet can throw when it is unable to perform its operation successfully.

Constructor:

Constructor:
public PortletException() { super(); } Constructs a new portlet exception.
public PortletException(String text) { super(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
public PortletException(Throwable cause) { super(cause); _cause = cause; // change this when going to jdk1.4: super (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
public PortletException(String text, Throwable cause) { super(text, cause); _cause = cause; // change this when going to jdk1.4: super (text, cause); } Constructs a new portlet exception when the portlet needs to do the following: throw an exception include the "root cause" exception include a description message Parameters: `text` - the exception text `cause` - the root cause

 public PortletException() {
        super();
}

Constructs a new portlet exception.

 public PortletException(String text) {
        super(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

 public PortletException(Throwable cause) {
        super(cause);
        _cause = cause;
        // change this when going to jdk1.4:        super (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

 public PortletException(String text,
    Throwable cause) {
        super(text, cause);
        _cause = cause;
        // change this when going to jdk1.4:    super (text, cause);
}

throw an exception
include the "root cause" exception
include a description message

Parameters:

text - the exception text

cause - the root cause

Method from javax.portlet.PortletException Summary:
getCause, printStackTrace, printStackTrace, printStackTrace

Methods from java.lang.Throwable:
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.portlet.PortletException Detail:
public Throwable getCause() { return (_cause != null ? _cause : null); } Returns the cause of this throwable or `null` if the cause is nonexistent or unknown. (The cause is the throwable that caused this throwable to get thrown.) This implementation returns the cause that was supplied via one of the constructors requiring a `Throwable`.
public void printStackTrace() { this.printStackTrace(System.err); } Prints the stack trace of this exception to the standard error stream.
public void printStackTrace(PrintStream out) { this.printStackTrace(new java.io.PrintWriter(out, true)); } Prints the stack trace of this exception to the specified print stream.
public void printStackTrace(PrintWriter out) { super.printStackTrace(out); if (getCause() != null) { out.println(); out.print("Nested Exception is "); getCause().printStackTrace(out); } // change this when going tojdk1.4: /* super.printStackTrace(out); if( getRootCause () != null ) { out.println(); out.print("Nested Exception is "); getRootCause ().printStackTrace(out); } */ } Prints the stack trace of this exception to the specified print writer.

Method from javax.portlet.PortletException Detail:

 public Throwable getCause() {
        return (_cause != null ? _cause : null);
}

null

This implementation returns the cause that was supplied via one of the constructors requiring a Throwable.

 public  void printStackTrace() {
        this.printStackTrace(System.err);
}

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

 public  void printStackTrace(PrintStream out) {
        this.printStackTrace(new java.io.PrintWriter(out, true));
}

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

 public  void printStackTrace(PrintWriter out) {
        super.printStackTrace(out);
        if (getCause() != null) {
            out.println();
            out.print("Nested Exception is ");
            getCause().printStackTrace(out);
        }
        // change this when going tojdk1.4:
        /*
          super.printStackTrace(out);
          if( getRootCause () != null )
          {
              out.println();
              out.print("Nested Exception is ");
              getRootCause ().printStackTrace(out);
          }
          */
}

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