01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/velocity/tags/sakai_2-4-1/tool/src/java/org/sakaiproject/cheftool/AlertImpl.java $
03: * $Id: AlertImpl.java 6782 2006-03-18 02:48:14Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.cheftool;
21:
22: import java.io.Serializable;
23:
24: /**
25: * <p>
26: * Alert is a set of messages intended for user display in the user interface.
27: * </p>
28: */
29: public class AlertImpl implements org.sakaiproject.cheftool.api.Alert,
30: Serializable {
31: /** The Alert text. */
32: protected String m_msg = null;
33:
34: /**
35: * Add a new alert line. A line separator will be appended as needed.
36: *
37: * @param alert
38: * The alert message to add.
39: */
40: public void add(String alert) {
41: // if this is the first, just set it
42: if (m_msg == null) {
43: m_msg = alert;
44: }
45:
46: // otherwise append it with a line break
47: else {
48: m_msg = "\n" + alert;
49: }
50: }
51:
52: /**
53: * Access the alert message. Once accessed, the message is cleared.
54: *
55: * @return The alert message.
56: */
57: public String getAlert() {
58: String tmp = m_msg;
59: m_msg = null;
60:
61: return tmp;
62: }
63:
64: /**
65: * Access the alert message, but unlike getAlert(), do not clear the message.
66: *
67: * @return The alert message.
68: */
69: public String peekAlert() {
70: return m_msg;
71: }
72:
73: /**
74: * Check to see if the alert is empty, or has been populated.
75: *
76: * @return true of the alert is empty, false if there have been alerts set.
77: */
78: public boolean isEmpty() {
79: return ((m_msg == null) || (m_msg.length() == 0));
80: }
81:
82: /**
83: * Remove any messages in the Alert.
84: */
85: public void clear() {
86: m_msg = null;
87: }
88: }
|