TranslationRequiredIssue


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