01: //////////////////////////////////////////////////////////////////////////////
02: // Clirr: compares two versions of a java library for binary compatibility
03: // Copyright (C) 2003 - 2005 Lars Kühne
04: //
05: // This library is free software; you can redistribute it and/or
06: // modify it under the terms of the GNU Lesser General Public
07: // License as published by the Free Software Foundation; either
08: // version 2.1 of the License, or (at your option) any later version.
09: //
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:
20: package net.sf.clirr.core;
21:
22: /**
23: * Class which manages API Difference messages, including expanding message
24: * codes into strings and descriptions.
25: */
26: public final class Message {
27: private int id;
28:
29: /**
30: * This constructor is equivalent to new Message(id, true).
31: */
32: public Message(int id) {
33: this (id, true);
34: }
35:
36: /**
37: * Create an instance of this object with the specified message id
38: *
39: * @param id is an integer which is used to look up the appropriate
40: * text string for this message from a resource file. The id of a
41: * message should be unique.
42: *
43: * @param register determines whether the new Message object should be
44: * registered with the central MessageManager object. This is normally
45: * desirable, as this allows the unit tests associated with clirr to
46: * verify that message ids are unique and that translations exist for
47: * all registered messages. However false can be useful in some
48: * circumstances, eg when creating Message objects for the purposes
49: * of unit tests.
50: */
51: public Message(int id, boolean register) {
52: this .id = id;
53: if (register) {
54: MessageManager.getInstance().addMessage(this );
55: }
56: }
57:
58: public int getId() {
59: return id;
60: }
61:
62: public String toString() {
63: return "Message#" + id;
64: }
65: }
|