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 import java.lang.annotation.Retention; 26 import java.lang.annotation.RetentionPolicy; 27 import java.lang.annotation.Target; 28 29 import ch.qos.cal10n.verifier.MessageKeyVerifier; 30 31 /** 32 * This annotation serves to designate a list of locale names for which resource 33 * bundles exist. 34 * 35 * <p> 36 * Typical usage is: 37 * 38 * <pre> 39 * @LocaleNames({"en", "jp"}) 40 * @BaseName("colors"); 41 * public class enum Colors { 42 * RED, WHITE, BLUE; 43 * } 44 * </pre> 45 * 46 * <p> 47 * In the above example, @LocaleNames({"en", "jp"}) means that there are English 48 * (en) and Japanese translations for the message keys found in the Colors enum. 49 * The name of the corresponding resource bundle is named "colors". 50 * 51 * <p> 52 * Verification tools such {@link MessageKeyVerifier} can thus conclude that the 53 * resource bundle files <em>colors_en.properties</em> and 54 * <em>colors_jp.properties</em> should exist and checked against the keys 55 * defined in the Colors enum. 56 * 57 * @author Ceki Gülcü 58 * 59 */ 60 @Retention(RetentionPolicy.RUNTIME) 61 @Target(ElementType.TYPE) 62 public @interface LocaleNames { 63 String[] value(); 64 }