Add some tests
[fanfix.git] / src / be / nikiroo / utils / resources / Meta.java
CommitLineData
ec1f3444
NR
1package be.nikiroo.utils.resources;
2
3import java.lang.annotation.ElementType;
4import java.lang.annotation.Retention;
5import java.lang.annotation.RetentionPolicy;
6import 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)
16public @interface Meta {
17 /**
18 * What kind of item this key represent (a Key, a Label text, a format to
19 * use for something else...).
20 *
21 * @return what it is
22 */
23 String what();
24
25 /**
26 * Where in the application will this key appear (in the action keys, in a
27 * menu, in a message...).
28 *
29 * @return where it is
30 */
31 String where();
32
33 /**
34 * What format should/must this key be in.
35 *
36 * @return the format it is in
37 */
38 String format();
39
40 /**
41 * Free info text to help translate.
42 *
43 * @return some info
44 */
45 String info();
46}