KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > api > LocalizedMessages


1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2005 Oliver Burn
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ////////////////////////////////////////////////////////////////////////////////
19 package com.puppycrawl.tools.checkstyle.api;
20
21 // TODO: check that this class is in the right package
22 // as soon as architecture has settled. At the time of writing
23 // this class is not necessary as a part of the public api
24
25 import java.util.TreeSet JavaDoc;
26
27 /**
28  * Collection of messages.
29  * @author Oliver Burn
30  * @version 1.0
31  */
32 public final class LocalizedMessages
33 {
34     /** contains the messages logged **/
35     private final TreeSet JavaDoc mMessages = new TreeSet JavaDoc();
36
37     /** @return the logged messages **/
38     public LocalizedMessage[] getMessages()
39     {
40         return (LocalizedMessage[])
41             mMessages.toArray(new LocalizedMessage[mMessages.size()]);
42     }
43
44     /** Reset the object. **/
45     public void reset()
46     {
47         mMessages.clear();
48     }
49
50     /**
51      * Logs a message to be reported.
52      * @param aMsg the message to log
53      **/
54     public void add(LocalizedMessage aMsg)
55     {
56         mMessages.add(aMsg);
57     }
58
59     /** @return the number of messages */
60     public int size()
61     {
62         return mMessages.size();
63     }
64 }
65
Popular Tags