View Javadoc

1   /*
2    * Copyright (c) 2009 QOS.ch All rights reserved.
3    * 
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   * 
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   * 
14   * THE SOFTWARE IS PROVIDED "AS  IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package ch.qos.cal10n;
24  
25  import java.text.MessageFormat;
26  import java.util.Locale;
27  import java.util.ResourceBundle;
28  
29  import ch.qos.cal10n.util.AnnotationExtractor;
30  
31  /**
32   * The default implementation for {@link IMessageConveyor} based on resource
33   * bundles.
34   * 
35   * <p>
36   * See also {@link #getMessage(Enum, Object...)} for details.
37   * 
38   * @author Ceki G&uuml;lc&uuml;
39   */
40  public class MessageConveyor implements IMessageConveyor {
41  
42    Locale locale;
43  
44    /**
45     * The {@link Locale} associated with this instance.
46     * 
47     * @param locale
48     */
49    public MessageConveyor(Locale locale) {
50      this.locale = locale;
51    }
52  
53    /**
54     * Given an enum as key, find the corresponding resource bundle and return the
55     * corresponding internationalized.
56     * 
57     * <p>
58     * The name of the resource bundle is defined via the
59     * {@link ResourceBundleName} annotation whereas the locale is specified in
60     * this MessageConveyor instance's constructor.
61     * 
62     * @param key
63     *          an enum instance used as message key
64     * 
65     */
66    public <E extends Enum<?>> String getMessage(E key, Object... args) {
67      String keyAsStr = key.toString();
68  
69      String resouceBundleName = AnnotationExtractor.getResourceBundleName(key
70          .getClass());
71      if (resouceBundleName == null) {
72        throw new IllegalArgumentException(
73            "Missing @ResourceBundleName annotation in enum type [" + key.getClass().getName()
74                + "]. See also " + Cal10nConstants.MISSING_RB_ANNOTATION_URL);
75      }
76      ResourceBundle rb = ResourceBundle.getBundle(resouceBundleName, locale);
77  
78      String value = rb.getString(keyAsStr);
79      if (value == null) {
80        return "No key found for " + keyAsStr;
81      } else {
82        if (args == null || args.length == 0) {
83          return value;
84        } else {
85          return MessageFormat.format(value, args);
86        }
87      }
88    }
89  
90    public String getMessage(MessageParameterObj mpo) {
91      if (mpo == null) {
92        throw new IllegalArgumentException(
93            "MessageParameterObj argumument cannot be null");
94      }
95      return getMessage(mpo.getKey(), mpo.getArgs());
96    }
97  
98  }