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 import ch.qos.cal10n.util.PropertyResourceBundleFinder; 31 32 /** 33 * The default implementation for {@link IMessageConveyor} based on resource 34 * bundles. 35 * 36 * <p> 37 * See also {@link #getMessage(Enum, Object...)} for details. 38 * 39 * @author Ceki Gülcü 40 */ 41 public class MessageConveyor implements IMessageConveyor { 42 43 Locale locale; 44 45 /** 46 * The {@link Locale} associated with this instance. 47 * 48 * @param locale 49 */ 50 public MessageConveyor(Locale locale) { 51 this.locale = locale; 52 } 53 54 /** 55 * Given an enum as key, find the corresponding resource bundle and return the 56 * corresponding internationalized. 57 * 58 * <p> 59 * The name of the resource bundle is defined via the {@link BaseName} 60 * annotation whereas the locale is specified in this MessageConveyor 61 * instance's constructor. 62 * 63 * @param key 64 * an enum instance used as message key 65 * 66 */ 67 public <E extends Enum<?>> String getMessage(E key, Object... args) { 68 String keyAsStr = key.toString(); 69 70 String baseName = AnnotationExtractor.getBaseName(key.getDeclaringClass()); 71 if (baseName == null) { 72 throw new IllegalArgumentException( 73 "Missing @BaseName annotation in enum type [" 74 + key.getClass().getName() + "]. See also " 75 + Cal10nConstants.MISSING_BN_ANNOTATION_URL); 76 } 77 78 ResourceBundle rb = PropertyResourceBundleFinder.getBundle(this.getClass() 79 .getClassLoader(), baseName, locale); 80 81 String value = rb.getString(keyAsStr); 82 if (value == null) { 83 return "No key found for " + keyAsStr; 84 } else { 85 if (args == null || args.length == 0) { 86 return value; 87 } else { 88 return MessageFormat.format(value, args); 89 } 90 } 91 } 92 93 public String getMessage(MessageParameterObj mpo) { 94 if (mpo == null) { 95 throw new IllegalArgumentException( 96 "MessageParameterObj argumument cannot be null"); 97 } 98 return getMessage(mpo.getKey(), mpo.getArgs()); 99 } 100 101 }