Package jakarta.portlet

Class PortletModeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

jakarta.portlet.PortletException

jakarta.portlet.PortletModeException

All Implemented Interfaces:

Serializable

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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PortletModeException(String text, PortletMode mode)	Constructs a new portlet mode exception with the given text and the portlet mode that caused this exception.
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(Throwable cause, PortletMode mode)	Constructs a new portlet mode exception when the portlet needs to throw an exception.

Method Summary

Modifier and Type	Method	Description
PortletMode	getMode()	Returns the unsupported portlet mode causing this exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

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(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(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 Detail

getMode

public PortletMode getMode()

Returns the unsupported portlet mode causing this exception.

Returns:

the portlet mode that caused this exception