Merge branch 'subtree'
[fanfix.git] / src / be / nikiroo / utils / resources / Meta.java
1 package be.nikiroo.utils.resources;
2
3 import java.lang.annotation.ElementType;
4 import java.lang.annotation.Retention;
5 import java.lang.annotation.RetentionPolicy;
6 import java.lang.annotation.Target;
7
8 /**
9 * Annotation used to give some information about the translation keys, so the
10 * translation .properties file can be created programmatically.
11 *
12 * @author niki
13 */
14 @Retention(RetentionPolicy.RUNTIME)
15 @Target(ElementType.FIELD)
16 public @interface Meta {
17 /**
18 * The format of an item (the values it is expected to be of).
19 * <p>
20 * Note that the INI file can contain arbitrary data, but it is expected to
21 * be valid.
22 *
23 * @author niki
24 */
25 public enum Format {
26 /** An integer value, can be negative. */
27 INT,
28 /** true or false. */
29 BOOLEAN,
30 /** Any text String. */
31 STRING,
32 /** A password field. */
33 PASSWORD,
34 /** A colour (either by name or #rrggbb or #aarrggbb). */
35 COLOR,
36 /** A locale code (e.g., fr-BE, en-GB, es...). */
37 LOCALE,
38 /** A path to a file. */
39 FILE,
40 /** A path to a directory. */
41 DIRECTORY,
42 /** A fixed list of values (see {@link Meta#list()} for the values). */
43 FIXED_LIST,
44 /**
45 * A fixed list of values (see {@link Meta#list()} for the values) OR a
46 * custom String value (basically, a {@link Format#FIXED_LIST} with an
47 * option to enter a not accounted for value).
48 */
49 COMBO_LIST,
50 }
51
52 /**
53 * A description for this item: what it is or does, how to explain that item
54 * to the user including what can be used here (i.e., %s = file name, %d =
55 * file size...).
56 * <p>
57 * For group, the first line ('\\n'-separated) will be used as a title while
58 * the rest will be the description.
59 *
60 * @return what it is
61 */
62 String description() default "";
63
64 /**
65 * This item is only used as a group, not as an option.
66 * <p>
67 * For instance, you could have LANGUAGE_CODE as a group for which you won't
68 * use the value in the program, and LANGUAGE_CODE_FR, LANGUAGE_CODE_EN
69 * inside for which the value must be set.
70 *
71 * @return TRUE if it is a group
72 */
73 boolean group() default false;
74
75 /**
76 * What format should/must this key be in.
77 *
78 * @return the format it is in
79 */
80 Format format() default Format.STRING;
81
82 /**
83 * The list of fixed values this item can be (either for
84 * {@link Format#FIXED_LIST} or {@link Format#COMBO_LIST}).
85 *
86 * @return the list of values
87 */
88 String[] list() default {};
89
90 /**
91 * This item can be left unspecified.
92 *
93 * @return TRUE if it can
94 */
95 boolean nullable() default true;
96
97 /**
98 * The default value of this item.
99 *
100 * @return the value
101 */
102 String def() default "";
103
104 /**
105 * This item is a comma-separated list of values instead of a single value.
106 * <p>
107 * The list items are separated by a comma, each surrounded by
108 * double-quotes, with backslashes and double-quotes escaped by a backslash.
109 * <p>
110 * Example: <tt>"un", "deux"</tt>
111 *
112 * @return TRUE if it is
113 */
114 boolean array() default false;
115
116 /**
117 * @deprecated add the info into the description, as only the description
118 * will be translated.
119 */
120 @Deprecated
121 String info() default "";
122 }