1 /** 2 * 3 */ 4 package org.unicode.cldr.util; 5 6 import java.lang.annotation.ElementType; 7 import java.lang.annotation.Retention; 8 import java.lang.annotation.RetentionPolicy; 9 import java.lang.annotation.Target; 10 11 /** 12 * This annotation is used to mark CLDR Tools that are runnable by users. 13 * All CLDR Tools should be so annotated. 14 * Running "java -jar cldr.jar" will list all annotated tools. 15 * 16 * @author srl 17 */ 18 @Target({ ElementType.TYPE }) 19 @Retention(RetentionPolicy.RUNTIME) 20 public @interface CLDRTool { 21 22 /** 23 * Short name for this tool. Required. 24 * @return 25 */ alias()26 String alias(); 27 28 /** 29 * Long description of the purpose of this tool. 30 * @return 31 */ description()32 String description() default ""; 33 34 /** 35 * If non-empty, a description of why this tool should be hidden from user view. 36 * Example: hidden="BROKEN" or hidden="one-off testing tool" 37 * or hidden="" for visible 38 * @return 39 */ hidden()40 String hidden() default ""; 41 42 /** 43 * If non-empty, URL to further docs on this tool. 44 */ url()45 String url() default ""; 46 } 47