001: package org.tigris.scarab.util.build.l10nchecker;
002:
003: /* ================================================================
004: * Copyright (c) 2005 CollabNet. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: /**
050: * Interface that contains a message (information, warning, error) that can be
051: * created during initialisation
052:
053: * @author sreindl
054: */
055: public class L10nMessage {
056: /* line number */
057: private int lineNumber;
058:
059: /* message text */
060: private String messageText;
061:
062: /* corresponding L10nObject */
063: private L10nKey l10nObject;
064:
065: /* The corresponding issue */
066: private L10nIssue issue;
067:
068: /**
069: * INTERNAL-should not have been called
070: */
071: private L10nMessage() {
072: throw new RuntimeException("This should not have been called");
073: }
074:
075: /**
076: * Create a message of type INFORMATION at line #lineNo with message
077: * #issue.
078: *
079: * @param lineNo The line where the message appeared
080: * @param issue The issue to be created.
081: */
082: public L10nMessage(int lineNo, L10nIssue issue) {
083: lineNumber = lineNo;
084: this .issue = issue;
085: this .messageText = issue.formatMessage();
086: }
087:
088: /* getter setter methods */
089: /**
090: * Return the line number.
091: *
092: * @return Returns the lineNumber.
093: */
094: public int getLineNumber() {
095: return lineNumber;
096: }
097:
098: /**
099: * Set the line number
100: *
101: * @param lineNumber The lineNumber to set.
102: */
103: public void setLineNumber(int lineNumber) {
104: this .lineNumber = lineNumber;
105: }
106:
107: /**
108: * Return the message text.
109: *
110: * @return Returns the messageText.
111: */
112: public String getMessageText() {
113: return messageText;
114: }
115:
116: /**
117: * Set the message text.
118: *
119: * @return Returns the l10nObject.
120: */
121: public L10nKey getL10nObject() {
122: return l10nObject;
123: }
124:
125: /**
126: * Return the corresponding L10nKey.
127: *
128: * @param object The l10nKey to set.
129: */
130: public void setL10nObject(L10nKey object) {
131: l10nObject = object;
132: }
133:
134: /**
135: * Return the issue assiciated to this message.
136: *
137: * @return Returns the issue.
138: */
139: public L10nIssue getIssue() {
140: return issue;
141: }
142: }
|