1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2014 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 com.google.common.collect.Sets;
26 import java.util.TreeSet;
27
28 /**
29 * Collection of messages.
30 * @author Oliver Burn
31 * @version 1.0
32 */
33 public final class LocalizedMessages
34 {
35 /** contains the messages logged **/
36 private final TreeSet<LocalizedMessage> messages = Sets.newTreeSet();
37
38 /** @return the logged messages **/
39 public TreeSet<LocalizedMessage> getMessages()
40 {
41 return Sets.newTreeSet(messages);
42 }
43
44 /** Reset the object. **/
45 public void reset()
46 {
47 messages.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 messages.add(aMsg);
57 }
58
59 /** @return the number of messages */
60 public int size()
61 {
62 return messages.size();
63 }
64 }