Commit | Line | Data |
---|---|---|
e7418457 NR |
1 | package be.nikiroo.jvcard.i18n; |
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 | */ | |
15 | @Retention(RetentionPolicy.RUNTIME) | |
16 | @Target(ElementType.FIELD) | |
17 | public @interface Meta { | |
18 | /** | |
19 | * What kind of item this key represent (a Key, a Label text, a format to | |
20 | * use for something else...). | |
21 | * | |
22 | * @return what it is | |
23 | */ | |
24 | String what(); | |
25 | ||
26 | /** | |
27 | * Where in the application will this key appear (in the action keys, in a | |
28 | * menu, in a message...). | |
29 | * | |
30 | * @return where it is | |
31 | */ | |
32 | String where(); | |
33 | ||
34 | /** | |
35 | * What format should/must this key be in. | |
36 | * | |
37 | * @return the format it is in | |
38 | */ | |
39 | String format(); | |
40 | ||
41 | /** | |
42 | * Free info text to help translate. | |
43 | * | |
44 | * @return some info | |
45 | */ | |
46 | String info(); | |
47 | } |