1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2015 the original author or authors.
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 */
32 public final class LocalizedMessages
33 {
34 /** contains the messages logged **/
35 private final TreeSet<LocalizedMessage> messages = Sets.newTreeSet();
36
37 /** @return the logged messages **/
38 public TreeSet<LocalizedMessage> getMessages()
39 {
40 return Sets.newTreeSet(messages);
41 }
42
43 /** Reset the object. **/
44 public void reset()
45 {
46 messages.clear();
47 }
48
49 /**
50 * Logs a message to be reported.
51 * @param aMsg the message to log
52 **/
53 public void add(LocalizedMessage aMsg)
54 {
55 messages.add(aMsg);
56 }
57
58 /** @return the number of messages */
59 public int size()
60 {
61 return messages.size();
62 }
63 }