01: package org.tigris.scarab.util.build.l10nchecker.issues;
02:
03: import org.tigris.scarab.util.build.l10nchecker.L10nIssue;
04:
05: /* ================================================================
06: * Copyright (c) 2005 CollabNet. All rights reserved.
07: *
08: * Redistribution and use in source and binary forms, with or without
09: * modification, are permitted provided that the following conditions are
10: * met:
11: *
12: * 1. Redistributions of source code must retain the above copyright
13: * notice, this list of conditions and the following disclaimer.
14: *
15: * 2. Redistributions in binary form must reproduce the above copyright
16: * notice, this list of conditions and the following disclaimer in the
17: * documentation and/or other materials provided with the distribution.
18: *
19: * 3. The end-user documentation included with the redistribution, if
20: * any, must include the following acknowlegement: "This product includes
21: * software developed by Collab.Net <http://www.Collab.Net/>."
22: * Alternately, this acknowlegement may appear in the software itself, if
23: * and wherever such third-party acknowlegements normally appear.
24: *
25: * 4. The hosted project names must not be used to endorse or promote
26: * products derived from this software without prior written
27: * permission. For written permission, please contact info@collab.net.
28: *
29: * 5. Products derived from this software may not use the "Tigris" or
30: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
31: * prior written permission of Collab.Net.
32: *
33: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
35: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
36: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
37: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
39: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
40: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
41: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
42: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
43: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44: *
45: * ====================================================================
46: *
47: * This software consists of voluntary contributions made by many
48: * individuals on behalf of Collab.Net.
49: */
50:
51: /**
52: * Translation is required.
53: *
54: * This issue represents a key that has been marked in the reference file
55: * as required to be translated (i.e. <code>#+TRANS</code> but the
56: * translation is either missing in the localisation file or the translation
57: * is there but the value has not been translated:
58: *
59: * <p>Examples:
60: * <ul><li>Reference File
61: * <pre>
62: * #+TRANS
63: * Token=Translation Needed
64: * </pre>
65: * <li>Localisation file (option 1):
66: * <pre>
67: * Token=Translation Needed
68: * </pre>
69: * <li>option 2 just means that the token is not there in the file.
70: * </ul>
71: */
72: public class TranslationRequiredIssue extends L10nIssue {
73:
74: private String key;
75:
76: /**
77: * Construct this issue
78: */
79: public TranslationRequiredIssue(String key) {
80: this .key = key;
81: }
82:
83: /* (non-Javadoc)
84: * @see org.tigris.scarab.util.build.l10nchecker.L10nIssue#getMessageTemplate()
85: */
86: public String getMessageTemplate() {
87: return "Key {0} has to be translated";
88: }
89:
90: /* (non-Javadoc)
91: * @see org.tigris.scarab.util.build.l10nchecker.L10nIssue#getParameters()
92: */
93: public Object[] getParameters() {
94: return new Object[] { key };
95: }
96: }
|