001: /***************************************************************
002: * This file is part of the [fleXive](R) project.
003: *
004: * Copyright (c) 1999-2007
005: * UCS - unique computing solutions gmbh (http://www.ucs.at)
006: * All rights reserved
007: *
008: * The [fleXive](R) project is free software; you can redistribute
009: * it and/or modify it under the terms of the GNU General Public
010: * License as published by the Free Software Foundation;
011: * either version 2 of the License, or (at your option) any
012: * later version.
013: *
014: * The GNU General Public License can be found at
015: * http://www.gnu.org/copyleft/gpl.html.
016: * A copy is found in the textfile GPL.txt and important notices to the
017: * license from the author are found in LICENSE.txt distributed with
018: * these libraries.
019: *
020: * This library is distributed in the hope that it will be useful,
021: * but WITHOUT ANY WARRANTY; without even the implied warranty of
022: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
023: * GNU General Public License for more details.
024: *
025: * For further information about UCS - unique computing solutions gmbh,
026: * please see the company website: http://www.ucs.at
027: *
028: * For further information about [fleXive](R), please see the
029: * project website: http://www.flexive.org
030: *
031: *
032: * This copyright notice MUST APPEAR in all copies of the file!
033: ***************************************************************/package com.flexive.faces.messages;
034:
035: import org.apache.commons.lang.StringUtils;
036:
037: import javax.faces.application.FacesMessage;
038: import java.io.Serializable;
039: import java.util.ArrayList;
040: import java.util.List;
041:
042: /**
043: * FxFacesMessages represents a collection of one ore more FxFacesMessage that have the same
044: * summary and the same severity.
045: * <p/>
046: * The messages can be obtained using the getMessages() function.
047: *
048: * @author Gregor Schober (gregor.schober@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
049: */
050: public class FxFacesMessages implements Serializable {
051:
052: private static final long serialVersionUID = 8038620276312808700L;
053: private static long nextId = 0;
054: private String summary;
055: private FacesMessage.Severity severity;
056: private List<FxFacesMessage> messages;
057: private long id;
058:
059: /**
060: * Generates a (server) unique message id.
061: *
062: * @return a (server) unique message id.
063: */
064: private synchronized long generateId() {
065: long result = nextId++;
066: if (nextId == Long.MAX_VALUE) {
067: nextId = 0;
068: }
069: return result;
070: }
071:
072: /**
073: * Constructore.
074: *
075: * @param summary the shared summary
076: * @param severity the shared severity
077: * @param message the first message to add
078: */
079: public FxFacesMessages(String summary,
080: FacesMessage.Severity severity, FxFacesMessage message) {
081: this .messages = new ArrayList<FxFacesMessage>(10);
082: this .summary = summary;
083: this .messages.add(message);
084: this .severity = severity;
085: this .id = generateId();
086: }
087:
088: /**
089: * Returns the (server) unique id of this object.
090: *
091: * @return the (server) unique id of this object.
092: */
093: public long getId() {
094: return id;
095: }
096:
097: /**
098: * Adds a new mesage to this FxFacesMessages collection.
099: *
100: * @param message the message to add
101: */
102: public void addMessage(FxFacesMessage message) {
103: for (FxFacesMessage m : messages) {
104: if (m.equals(message)) {
105: // Dupe
106: return;
107: }
108: }
109: this .messages.add(message);
110: }
111:
112: /**
113: * Returns the shared summary with the additional information how many messages
114: * the collection contains.
115: *
116: * @return the shared summary
117: */
118: public String getSummary() {
119: return summary + (getSize() > 1 ? " [" + getSize() + "]" : "");
120: }
121:
122: /**
123: * The shared severity.
124: *
125: * @return the shared severity
126: */
127: public FacesMessage.Severity getSeverity() {
128: return severity;
129: }
130:
131: /**
132: * The messages.
133: *
134: * @return the messages
135: */
136: public List<FxFacesMessage> getMessages() {
137: return messages;
138: }
139:
140: /**
141: * The message count.
142: *
143: * @return the message count
144: */
145: public int getSize() {
146: return this .messages.size();
147: }
148:
149: /**
150: * Returns true if at least one message contains a detail error message.
151: *
152: * @return true if at least one message contains a detail error message.
153: * @see FacesMessage#getDetail
154: */
155: public boolean isContainsDetailMessages() {
156: for (FxFacesMessage message : messages) {
157: if (StringUtils.isNotBlank(message.getDetail())) {
158: return true;
159: }
160: }
161: return false;
162: }
163: }
|