javax.portlet

Class PortletModeException


public class PortletModeException
extends PortletException

The PortletModeException is thrown when a portlet tries to use or set a portlet mode that is not supported by the current runtime environment or the portlet.

Constructor Summary

PortletModeException(String text, Throwable cause, PortletMode mode)
Constructs a new portlet mode exception when the portlet needs to do the following:
    throw an exception
  • include a message about the "root cause" that interfered with its normal operation
  • include a description message
  • include the portlet mode that caused this exception
PortletModeException(String text, PortletMode mode)
Constructs a new portlet mode exception with the given text and the portlet mode that caused this exception.
PortletModeException(Throwable cause, PortletMode mode)
Constructs a new portlet mode exception when the portlet needs to throw an exception.

Method Summary

PortletMode
getMode()
Returns the unsupported portlet mode causing this exception.

Methods inherited from class javax.portlet.PortletException

getCause, printStackTrace, printStackTrace, printStackTrace

Constructor Details

PortletModeException

public PortletModeException(String text,
                            Throwable cause,
                            PortletMode mode)
Constructs a new portlet mode exception when the portlet needs to do the following:
    throw an exception
  • include a message about the "root cause" that interfered with its normal operation
  • include a description message
  • include the portlet mode that caused this exception
Parameters:
text - the exception text
cause - the root cause
mode - the mode causing the exception

PortletModeException

public PortletModeException(String text,
                            PortletMode mode)
Constructs a new portlet mode exception with the given text and the portlet mode that caused this exception. The portlet container may use the text and portlet mode write it to a log.
Parameters:
text - the exception text
mode - the mode causing the exception

PortletModeException

public PortletModeException(Throwable cause,
                            PortletMode mode)
Constructs a new portlet mode exception when the portlet needs to throw an exception. The exception message is based on the localized message of the underlying exception and the portlet mode that caused this exception.
Parameters:
cause - the root cause
mode - the mode causing the exception

Method Details

getMode

public PortletMode getMode()
Returns the unsupported portlet mode causing this exception.
Returns:
the portlet mode that caused this exception