Coverage Report

Coverage Report - org.apache.commons.resources.MessageList

Classes in this File

 /*
  * $Id: MessageList.java 366395 2006-01-06 02:42:19Z niallp $
  * $Revision: 366395 $
  * $Date: 2006-01-06 02:42:19 +0000 (Fri, 06 Jan 2006) $
  *
  * ====================================================================
  *
  *  Copyright 2003-2006 The Apache Software Foundation
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
  *  You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  *  Unless required by applicable law or agreed to in writing, software
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *  See the License for the specific language governing permissions and
  *  limitations under the License.
  *
  */
 
 package org.apache.commons.resources;
 
 import java.util.Iterator;
 
 /**
  * <p>
  * A class that encapsulates messages. MessageList can be either global
  * or they are specific to a particular bean property.
  * </p>
  * <p>
  * Each individual message is described by an <code>Message</code>
  * object, which contains a message key (to be looked up in an appropriate
  * message resources database), and up to four placeholder arguments used for
  * parametric substitution in the resulting message.
  * </p>
  * <p>
  * <strong>IMPLEMENTATION NOTE</strong> - It is assumed that these objects
  * are created and manipulated only within the context of a single thread.
  * Therefore, no synchronization is required for access to internal
  * collections.
  * </p>
  * Orginally based on org.apache.struts.action.ActionMessages, Revision 49670.
  */
 public interface MessageList {
 
     /**
      * A default key to represent "global" messages
      * that do not pertain to a particular property.
      */
     public static final String GLOBAL_MESSAGE_KEY =
             "org.apache.commons.resources.GLOBAL_MESSAGE";
 
     /**
      * @return The default global message key
      */
     public String getGlobalMessageKey();
 
     /**
      * @param globalMessageKey The new default global message key
      */
     public void setGlobalMessageKey(String globalMessageKey);
 
     /**
      * Add a message to the set of messages for the specified property.  An
      * order of the property/key is maintained based on the initial addition
      * of the property/key.
      *
      * @param property  Property name (or MessageList.GLOBAL_MESSAGE_KEY)
      * @param message   The message to be added
      */
     public void add(String property, Message message);
 
     /**
      * Add a message to the set of messages for the "global" property.  An
      * order of the property/key is maintained based on the initial addition
      * of the property/key.
      *
      * @param message   The message to be added
      */
     public void add(Message message);
 
     /**
      * Adds the messages from the given <code>MessageList</code> object to
      * this set of messages. The messages are added in the order they are returned from
      * the properties() method. If a message's property is already in the current
      * <code>MessageList</code> object it is added to the end of the list for that
      * property. If a message's property is not in the current list it is added to the end
      * of the properties.
      *
      * @param messages The <code>MessageList</code> object to be added.
      */
     public void add(MessageList messages);
 
     /**
      * Clear all messages recorded by this object.
      */
     public void clear();
     
     /**
      * Determines if the MessageList's messages have been accessed one or more
      * times.  Returns <code>true</code> if the <code>get()</code> or 
      * <code>get(String)</code> methods are called.  
      * @return <code>true</code> if the messages have been accessed one or more
      * times.
      */
     public boolean isAccessed();
 
     /**
      * @return Return <code>true</code> if there are no messages recorded
      * in this collection, or <code>false</code> otherwise.
      */
     public boolean isEmpty();
 
     /**
      * Return the set of all recorded messages, without distinction
      * by which property the messages are associated with.  If there are
      * no messages recorded, an empty enumeration is returned.
      *
      * @return All messages.
      */
     public Iterator get();
 
     /**
      * Return the set of messages related to a specific property.
      * If there are no such messages, an empty enumeration is returned.
      *
      * @param property Property name
      * @return Messages related to a specific property.
      */
     public Iterator get(String property);
 
     /**
      * Return the set of property names for which at least one message has
      * been recorded.  If there are no messages, an empty Iterator is returned.
      * If you have recorded global messages, the String value of
      * <code>MessageList.GLOBAL_MESSAGE</code> will be one of the returned
      * property names.
      *
      * @return The property names.
      */
     public Iterator properties();
 
     /**
      * Return the number of messages recorded for all properties (including
      * global messages).  <strong>NOTE</strong> - it is more efficient to call
      * <code>isEmpty()</code> if all you care about is whether or not there are
      * any messages at all.
      *
      * @return The number of messages.
      */
     public int size();
 
     /**
      * Return the number of messages associated with the specified property.
      *
      * @param property Property name (or MessageList.GLOBAL_MESSAGE_KEY
      * @return The number of messages for a specific property.
      */
     public int size(String property);
 
 }
 

1		/*
2		* $Id: MessageList.java 366395 2006-01-06 02:42:19Z niallp $
3		* $Revision: 366395 $
4		* $Date: 2006-01-06 02:42:19 +0000 (Fri, 06 Jan 2006) $
5		*
6		* ====================================================================
7		*
8		* Copyright 2003-2006 The Apache Software Foundation
9		*
10		* Licensed under the Apache License, Version 2.0 (the "License");
11		* you may not use this file except in compliance with the License.
12		* You may obtain a copy of the License at
13		*
14		* http://www.apache.org/licenses/LICENSE-2.0
15		*
16		* Unless required by applicable law or agreed to in writing, software
17		* distributed under the License is distributed on an "AS IS" BASIS,
18		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19		* See the License for the specific language governing permissions and
20		* limitations under the License.
21		*
22		*/
23
24		package org.apache.commons.resources;
25
26		import java.util.Iterator;
27
28		/**
29		* <p>
30		* A class that encapsulates messages. MessageList can be either global
31		* or they are specific to a particular bean property.
32		* </p>
33		* <p>
34		* Each individual message is described by an <code>Message</code>
35		* object, which contains a message key (to be looked up in an appropriate
36		* message resources database), and up to four placeholder arguments used for
37		* parametric substitution in the resulting message.
38		* </p>
39		* <p>
40		* <strong>IMPLEMENTATION NOTE</strong> - It is assumed that these objects
41		* are created and manipulated only within the context of a single thread.
42		* Therefore, no synchronization is required for access to internal
43		* collections.
44		* </p>
45		* Orginally based on org.apache.struts.action.ActionMessages, Revision 49670.
46		*/
47		public interface MessageList {
48
49		/**
50		* A default key to represent "global" messages
51		* that do not pertain to a particular property.
52		*/
53		public static final String GLOBAL_MESSAGE_KEY =
54		"org.apache.commons.resources.GLOBAL_MESSAGE";
55
56		/**
57		* @return The default global message key
58		*/
59		public String getGlobalMessageKey();
60
61		/**
62		* @param globalMessageKey The new default global message key
63		*/
64		public void setGlobalMessageKey(String globalMessageKey);
65
66		/**
67		* Add a message to the set of messages for the specified property. An
68		* order of the property/key is maintained based on the initial addition
69		* of the property/key.
70		*
71		* @param property Property name (or MessageList.GLOBAL_MESSAGE_KEY)
72		* @param message The message to be added
73		*/
74		public void add(String property, Message message);
75
76		/**
77		* Add a message to the set of messages for the "global" property. An
78		* order of the property/key is maintained based on the initial addition
79		* of the property/key.
80		*
81		* @param message The message to be added
82		*/
83		public void add(Message message);
84
85		/**
86		* Adds the messages from the given <code>MessageList</code> object to
87		* this set of messages. The messages are added in the order they are returned from
88		* the properties() method. If a message's property is already in the current
89		* <code>MessageList</code> object it is added to the end of the list for that
90		* property. If a message's property is not in the current list it is added to the end
91		* of the properties.
92		*
93		* @param messages The <code>MessageList</code> object to be added.
94		*/
95		public void add(MessageList messages);
96
97		/**
98		* Clear all messages recorded by this object.
99		*/
100		public void clear();
101
102		/**
103		* Determines if the MessageList's messages have been accessed one or more
104		* times. Returns <code>true</code> if the <code>get()</code> or
105		* <code>get(String)</code> methods are called.
106		* @return <code>true</code> if the messages have been accessed one or more
107		* times.
108		*/
109		public boolean isAccessed();
110
111		/**
112		* @return Return <code>true</code> if there are no messages recorded
113		* in this collection, or <code>false</code> otherwise.
114		*/
115		public boolean isEmpty();
116
117		/**
118		* Return the set of all recorded messages, without distinction
119		* by which property the messages are associated with. If there are
120		* no messages recorded, an empty enumeration is returned.
121		*
122		* @return All messages.
123		*/
124		public Iterator get();
125
126		/**
127		* Return the set of messages related to a specific property.
128		* If there are no such messages, an empty enumeration is returned.
129		*
130		* @param property Property name
131		* @return Messages related to a specific property.
132		*/
133		public Iterator get(String property);
134
135		/**
136		* Return the set of property names for which at least one message has
137		* been recorded. If there are no messages, an empty Iterator is returned.
138		* If you have recorded global messages, the String value of
139		* <code>MessageList.GLOBAL_MESSAGE</code> will be one of the returned
140		* property names.
141		*
142		* @return The property names.
143		*/
144		public Iterator properties();
145
146		/**
147		* Return the number of messages recorded for all properties (including
148		* global messages). <strong>NOTE</strong> - it is more efficient to call
149		* <code>isEmpty()</code> if all you care about is whether or not there are
150		* any messages at all.
151		*
152		* @return The number of messages.
153		*/
154		public int size();
155
156		/**
157		* Return the number of messages associated with the specified property.
158		*
159		* @param property Property name (or MessageList.GLOBAL_MESSAGE_KEY
160		* @return The number of messages for a specific property.
161		*/
162		public int size(String property);
163
164		}
165