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 package ch.qos.cal10n; 23 24 import java.lang.annotation.ElementType; 25 26 import java.lang.annotation.Retention; 27 import java.lang.annotation.RetentionPolicy; 28 import java.lang.annotation.Target; 29 30 import ch.qos.cal10n.verifier.MessageCodeVerifier; 31 32 /** 33 * This annotation serves to designate the name of the resource bundle 34 * corresponding to an enum type. 35 * 36 * <p> 37 * Typical usage is: 38 * 39 * <pre> 40 * @LocaleNames({"en", "jp"}) 41 * @ResourceBundleName("colors"); 42 * public class enum Colors { 43 * RED, WHITE, BLUE; 44 * } 45 * </pre> 46 * 47 * <p> 48 * In the above example, @ResourceBundleName("colors") means that there exists 49 * resource files with the root name "colors". In conjunction with the 50 * information provided in the @LocaleNames annotation, we can assume that the 51 * files <em>colors_en.properties</em> and <em>colors_jp.properties</em> exist. 52 * 53 * <p> 54 * Verification tools such as {@link MessageCodeVerifier} can then proceed to 55 * check that the codes defined in the enum type match those in the resource bundles. 56 * 57 * @author Ceki Gülcü 58 * 59 */ 60 @Retention(RetentionPolicy.RUNTIME) 61 @Target(ElementType.TYPE) 62 public @interface ResourceBundleName { 63 String value(); 64 }