01: /**
02: * Copyright 2003 IBM Corporation and Sun Microsystems, Inc.
03: * All rights reserved.
04: * Use is subject to license terms.
05: */package javax.portlet;
06:
07: /**
08: * The <CODE>PortletModeException</CODE> is thrown when a portlet
09: * tries to use or set a portlet mode that is not supported by the current
10: * runtime environment or the portlet.
11: */
12:
13: public class PortletModeException extends PortletException {
14:
15: private transient PortletMode _mode = null;
16:
17: /**
18: * Constructs a new portlet mode exception with the given text and the
19: * portlet mode that caused this exception. The
20: * portlet container may use the text and portlet mode write it to a log.
21: *
22: * @param text
23: * the exception text
24: * @param mode
25: * the mode causing the exception
26: */
27:
28: public PortletModeException(String text, PortletMode mode) {
29: super (text);
30: _mode = mode;
31: }
32:
33: /**
34: * Constructs a new portlet mode exception when the portlet needs to do
35: * the following:
36: * <ul>
37: * <il>throw an exception
38: * <li>include a message about the "root cause" that interfered
39: * with its normal operation
40: * <li>include a description message
41: * <li>include the portlet mode that caused this exception
42: * </ul>
43: *
44: * @param text
45: * the exception text
46: * @param cause
47: * the root cause
48: * @param mode
49: * the mode causing the exception
50: */
51:
52: public PortletModeException(String text, Throwable cause,
53: PortletMode mode) {
54: super (text, cause);
55: _mode = mode;
56: }
57:
58: /**
59: * Constructs a new portlet mode exception when the portlet needs to throw an
60: * exception. The exception message is based on the localized message
61: * of the underlying exception and the portlet mode that caused this exception.
62: *
63: * @param cause
64: * the root cause
65: * @param mode
66: * the mode causing the exception
67: */
68:
69: public PortletModeException(Throwable cause, PortletMode mode) {
70: super (cause);
71: _mode = mode;
72: }
73:
74: /**
75: * Returns the unsupported portlet mode causing this exception.
76: *
77: * @return the portlet mode that caused this exception
78: */
79:
80: public PortletMode getMode() {
81: return _mode;
82: }
83: }
|