1 package be
.nikiroo
.utils
.resources
;
3 import java
.io
.BufferedWriter
;
5 import java
.io
.FileInputStream
;
6 import java
.io
.FileOutputStream
;
7 import java
.io
.IOException
;
8 import java
.io
.InputStreamReader
;
9 import java
.io
.OutputStreamWriter
;
10 import java
.io
.Reader
;
11 import java
.io
.Writer
;
12 import java
.lang
.reflect
.Field
;
13 import java
.util
.ArrayList
;
14 import java
.util
.HashMap
;
15 import java
.util
.List
;
16 import java
.util
.Locale
;
18 import java
.util
.MissingResourceException
;
19 import java
.util
.PropertyResourceBundle
;
20 import java
.util
.ResourceBundle
;
23 * This class encapsulate a {@link ResourceBundle} in UTF-8. It allows to
24 * retrieve values associated to an enumeration, and allows some additional
27 * It also sports a writable change map, and you can save back the
28 * {@link Bundle} to file with {@link Bundle#updateFile(String)}.
31 * the enum to use to get values out of this class
36 public class Bundle
<E
extends Enum
<E
>> {
38 protected Class
<E
> type
;
40 * The {@link Enum} associated to this {@link Bundle} (all the keys used in
41 * this {@link Bundle} will be of this type).
43 protected Enum
<?
> keyType
;
45 private TransBundle
<E
> descriptionBundle
;
48 private Map
<String
, String
> map
;
50 private Map
<String
, String
> changeMap
;
53 * Create a new {@link Bundles} of the given name.
56 * a runtime instance of the class of E
58 * the name of the {@link Bundles}
59 * @param descriptionBundle
60 * the description {@link TransBundle}, that is, a
61 * {@link TransBundle} dedicated to the description of the values
62 * of the given {@link Bundle} (can be NULL)
64 protected Bundle(Class
<E
> type
, Enum
<?
> name
,
65 TransBundle
<E
> descriptionBundle
) {
68 this.descriptionBundle
= descriptionBundle
;
70 this.map
= new HashMap
<String
, String
>();
71 this.changeMap
= new HashMap
<String
, String
>();
72 setBundle(name
, Locale
.getDefault(), false);
76 * Return the value associated to the given id as a {@link String}.
79 * the id of the value to get
81 * @return the associated value, or NULL if not found (not present in the
84 public String
getString(E id
) {
85 return getString(id
.name());
89 * Set the value associated to the given id as a {@link String}.
92 * the id of the value to get
97 public void setString(E id
, String value
) {
98 setString(id
.name(), value
);
102 * Return the value associated to the given id as a {@link String} suffixed
103 * with the runtime value "_suffix" (that is, "_" and suffix).
105 * Will only accept suffixes that form an existing id.
108 * the id of the value to get
112 * @return the associated value, or NULL if not found (not present in the
115 public String
getStringX(E id
, String suffix
) {
116 String key
= id
.name()
117 + (suffix
== null ?
"" : "_" + suffix
.toUpperCase());
120 id
= Enum
.valueOf(type
, key
);
121 return getString(id
);
122 } catch (IllegalArgumentException e
) {
130 * Set the value associated to the given id as a {@link String} suffixed
131 * with the runtime value "_suffix" (that is, "_" and suffix).
133 * Will only accept suffixes that form an existing id.
136 * the id of the value to get
142 public void setStringX(E id
, String suffix
, String value
) {
143 String key
= id
.name()
144 + (suffix
== null ?
"" : "_" + suffix
.toUpperCase());
147 id
= Enum
.valueOf(type
, key
);
148 setString(id
, value
);
149 } catch (IllegalArgumentException e
) {
155 * Return the value associated to the given id as a {@link Boolean}.
158 * the id of the value to get
160 * @return the associated value
162 public Boolean
getBoolean(E id
) {
163 String str
= getString(id
);
164 if (str
!= null && str
.length() > 0) {
165 if (str
.equalsIgnoreCase("true") || str
.equalsIgnoreCase("on")
166 || str
.equalsIgnoreCase("yes"))
168 if (str
.equalsIgnoreCase("false") || str
.equalsIgnoreCase("off")
169 || str
.equalsIgnoreCase("no"))
178 * Return the value associated to the given id as a {@link Boolean}.
181 * the id of the value to get
183 * the default value when it is not present in the config file or
184 * if it is not a boolean value
186 * @return the associated value
188 public boolean getBoolean(E id
, boolean def
) {
189 Boolean b
= getBoolean(id
);
197 * Return the value associated to the given id as an {@link Integer}.
200 * the id of the value to get
202 * @return the associated value
204 public Integer
getInteger(E id
) {
206 return Integer
.parseInt(getString(id
));
207 } catch (Exception e
) {
214 * Return the value associated to the given id as an int.
217 * the id of the value to get
219 * the default value when it is not present in the config file or
220 * if it is not a int value
222 * @return the associated value
224 public int getInteger(E id
, int def
) {
225 Integer i
= getInteger(id
);
233 * Return the value associated to the given id as a {@link Character}.
236 * the id of the value to get
238 * @return the associated value
240 public Character
getCharacter(E id
) {
241 String s
= getString(id
).trim();
242 if (s
.length() > 0) {
250 * Return the value associated to the given id as a {@link Character}.
253 * the id of the value to get
255 * the default value when it is not present in the config file or
256 * if it is not a char value
258 * @return the associated value
260 public char getCharacter(E id
, char def
) {
261 String s
= getString(id
).trim();
262 if (s
.length() > 0) {
270 * Return the value associated to the given id as a colour if it is found
273 * The returned value is an ARGB value.
276 * the id of the value to get
278 * @return the associated value
280 public Integer
getColor(E id
) {
283 String bg
= getString(id
).trim();
285 int r
= 0, g
= 0, b
= 0, a
= -1;
286 if (bg
.startsWith("#") && (bg
.length() == 7 || bg
.length() == 9)) {
288 r
= Integer
.parseInt(bg
.substring(1, 3), 16);
289 g
= Integer
.parseInt(bg
.substring(3, 5), 16);
290 b
= Integer
.parseInt(bg
.substring(5, 7), 16);
291 if (bg
.length() == 9) {
292 a
= Integer
.parseInt(bg
.substring(7, 9), 16);
297 } catch (NumberFormatException e
) {
302 // Try by name if still not found
304 if ("black".equalsIgnoreCase(bg
)) {
309 } else if ("white".equalsIgnoreCase(bg
)) {
314 } else if ("red".equalsIgnoreCase(bg
)) {
319 } else if ("green".equalsIgnoreCase(bg
)) {
324 } else if ("blue".equalsIgnoreCase(bg
)) {
329 } else if ("grey".equalsIgnoreCase(bg
)
330 || "gray".equalsIgnoreCase(bg
)) {
335 } else if ("cyan".equalsIgnoreCase(bg
)) {
340 } else if ("magenta".equalsIgnoreCase(bg
)) {
345 } else if ("yellow".equalsIgnoreCase(bg
)) {
354 rep
= ((a
& 0xFF) << 24) //
355 | ((r
& 0xFF) << 16) //
356 | ((g
& 0xFF) << 8) //
364 * Set the value associated to the given id as a colour.
366 * The value is an BGRA value.
369 * the id of the value to set
373 public void setColor(E id
, Integer color
) {
374 int a
= (color
>> 24) & 0xFF;
375 int r
= (color
>> 16) & 0xFF;
376 int g
= (color
>> 8) & 0xFF;
377 int b
= (color
>> 0) & 0xFF;
379 String rs
= Integer
.toString(r
, 16);
380 String gs
= Integer
.toString(g
, 16);
381 String bs
= Integer
.toString(b
, 16);
384 as
= Integer
.toString(a
, 16);
387 setString(id
, "#" + rs
+ gs
+ bs
+ as
);
391 * Create/update the .properties file.
393 * Will use the most likely candidate as base if the file does not already
394 * exists and this resource is translatable (for instance, "en_US" will use
395 * "en" as a base if the resource is a translation file).
397 * Will update the files in {@link Bundles#getDirectory()}; it <b>MUST</b>
400 * @throws IOException
401 * in case of IO errors
403 public void updateFile() throws IOException
{
404 updateFile(Bundles
.getDirectory());
408 * Create/update the .properties file.
410 * Will use the most likely candidate as base if the file does not already
411 * exists and this resource is translatable (for instance, "en_US" will use
412 * "en" as a base if the resource is a translation file).
415 * the path where the .properties files are, <b>MUST NOT</b> be
418 * @throws IOException
419 * in case of IO errors
421 public void updateFile(String path
) throws IOException
{
422 File file
= getUpdateFile(path
);
424 BufferedWriter writer
= new BufferedWriter(new OutputStreamWriter(
425 new FileOutputStream(file
), "UTF-8"));
431 for (Field field
: type
.getDeclaredFields()) {
432 Meta meta
= field
.getAnnotation(Meta
.class);
434 E id
= Enum
.valueOf(type
, field
.getName());
435 String info
= getMetaInfo(meta
);
442 writeValue(writer
, id
);
450 * The description {@link TransBundle}, that is, a {@link TransBundle}
451 * dedicated to the description of the values of the given {@link Bundle}
454 * @return the description {@link TransBundle}
456 public TransBundle
<E
> getDescriptionBundle() {
457 return descriptionBundle
;
461 * Reload the {@link Bundle} data files.
463 * @param resetToDefault
464 * reset to the default configuration (do not look into the
465 * possible user configuration files, only take the original
468 public void reload(boolean resetToDefault
) {
469 setBundle(keyType
, Locale
.getDefault(), resetToDefault
);
473 * Check if the internal map contains the given key.
476 * the key to check for
478 * @return true if it does
480 protected boolean containsKey(String key
) {
481 return changeMap
.containsKey(key
) || map
.containsKey(key
);
485 * Get the value for the given key if it exists in the internal map, or NULL
489 * the key to check for
491 * @return the value, or NULL
493 protected String
getString(String key
) {
494 if (changeMap
.containsKey(key
)) {
495 return changeMap
.get(key
);
498 if (map
.containsKey(key
)) {
506 * Set the value for this key, in the change map (it is kept in memory, not
512 * the associated value
514 protected void setString(String key
, String value
) {
515 changeMap
.put(key
, value
== null ?
null : value
.trim());
519 * Return formated, display-able information from the {@link Meta} field
520 * given. Each line will always starts with a "#" character.
523 * the {@link Meta} field
525 * @return the information to display or NULL if none
527 protected String
getMetaInfo(Meta meta
) {
528 String desc
= meta
.description();
529 boolean group
= meta
.group();
530 Meta
.Format format
= meta
.format();
531 String
[] list
= meta
.list();
532 boolean nullable
= meta
.nullable();
533 String info
= meta
.info();
534 boolean array
= meta
.array();
536 // Default, empty values -> NULL
537 if (desc
.length() + list
.length
+ info
.length() == 0 && !group
538 && nullable
&& format
== Meta
.Format
.STRING
) {
542 StringBuilder builder
= new StringBuilder();
543 builder
.append("# ").append(desc
);
544 if (desc
.length() > 20) {
545 builder
.append("\n#");
549 builder
.append("This item is used as a group, its content is not expected to be used.");
551 builder
.append(" (FORMAT: ").append(format
)
552 .append(nullable ?
"" : " (required)");
553 builder
.append(") ").append(info
);
555 if (list
.length
> 0) {
556 builder
.append("\n# ALLOWED VALUES:");
557 for (String value
: list
) {
558 builder
.append(" \"").append(value
).append("\"");
563 builder
.append("\n# (This item accept a list of comma-separated values)");
567 return builder
.toString();
571 * The display name used in the <tt>.properties file</tt>.
575 protected String
getBundleDisplayName() {
576 return keyType
.toString();
580 * Write the header found in the configuration <tt>.properties</tt> file of
581 * this {@link Bundles}.
584 * the {@link Writer} to write the header in
586 * @throws IOException
587 * in case of IO error
589 protected void writeHeader(Writer writer
) throws IOException
{
590 writer
.write("# " + getBundleDisplayName() + "\n");
595 * Write the given id to the config file, i.e., "MY_ID = my_curent_value"
596 * followed by a new line
599 * the {@link Writer} to write into
603 * @throws IOException
604 * in case of IO error
606 protected void writeValue(Writer writer
, E id
) throws IOException
{
607 writeValue(writer
, id
.name(), getString(id
));
611 * Write the given data to the config file, i.e., "MY_ID = my_curent_value"
612 * followed by a new line
615 * the {@link Writer} to write into
621 * @throws IOException
622 * in case of IO error
624 protected void writeValue(Writer writer
, String id
, String value
)
633 String
[] lines
= value
.replaceAll("\t", "\\\\\\t").split("\n");
634 for (int i
= 0; i
< lines
.length
; i
++) {
635 writer
.write(lines
[i
]);
636 if (i
< lines
.length
- 1) {
637 writer
.write("\\n\\");
644 * Return the source file for this {@link Bundles} from the given path.
647 * the path where the .properties files are
649 * @return the source {@link File}
651 protected File
getUpdateFile(String path
) {
652 return new File(path
, keyType
.name() + ".properties");
656 * Change the currently used bundle, and reset all changes.
659 * the name of the bundle to load
661 * the {@link Locale} to use
662 * @param resetToDefault
663 * reset to the default configuration (do not look into the
664 * possible user configuration files, only take the original
667 protected void setBundle(Enum
<?
> name
, Locale locale
, boolean resetToDefault
) {
669 String dir
= Bundles
.getDirectory();
671 boolean found
= false;
672 if (!resetToDefault
&& dir
!= null) {
674 File file
= getPropertyFile(dir
, name
.name(), locale
);
676 Reader reader
= new InputStreamReader(new FileInputStream(
678 resetMap(new PropertyResourceBundle(reader
));
681 } catch (IOException e
) {
687 String bname
= type
.getPackage().getName() + "." + name
.name();
689 resetMap(ResourceBundle
690 .getBundle(bname
, locale
, type
.getClassLoader(),
691 new FixedResourceBundleControl()));
692 } catch (Exception e
) {
693 // We have no bundle for this Bundle
694 System
.err
.println("No bundle found for: " + bname
);
701 * Reset the backing map to the content of the given bundle, or empty if
707 protected void resetMap(ResourceBundle bundle
) {
710 if (bundle
!= null) {
711 for (E field
: type
.getEnumConstants()) {
713 String value
= bundle
.getString(field
.name());
714 this.map
.put(field
.name(),
715 value
== null ?
null : value
.trim());
716 } catch (MissingResourceException e
) {
723 * Take a snapshot of the changes in memory in this {@link Bundle} made by
724 * the "set" methods ( {@link Bundle#setString(Enum, String)}...) at the
727 * @return a snapshot to use with {@link Bundle#restoreSnapshot(Object)}
729 public Object
takeSnapshot() {
730 return new HashMap
<String
, String
>(changeMap
);
734 * Restore a snapshot taken with {@link Bundle}, or reset the current
735 * changes if the snapshot is NULL.
738 * the snapshot or NULL
740 @SuppressWarnings("unchecked")
741 public void restoreSnapshot(Object snap
) {
745 if (snap
instanceof Map
) {
746 changeMap
= (Map
<String
, String
>) snap
;
748 throw new RuntimeException(
749 "Restoring changes in a Bundle must be done on a changes snapshot, "
750 + "or NULL to discard current changes");
756 * Return the resource file that is closer to the {@link Locale}.
759 * the directory to look into
761 * the file base name (without <tt>.properties</tt>)
765 * @return the closest match or NULL if none
767 private File
getPropertyFile(String dir
, String name
, Locale locale
) {
768 List
<String
> locales
= new ArrayList
<String
>();
769 if (locale
!= null) {
770 String country
= locale
.getCountry() == null ?
"" : locale
772 String language
= locale
.getLanguage() == null ?
"" : locale
774 if (!language
.isEmpty() && !country
.isEmpty()) {
775 locales
.add("_" + language
+ "-" + country
);
777 if (!language
.isEmpty()) {
778 locales
.add("_" + language
);
785 for (String loc
: locales
) {
786 file
= new File(dir
, name
+ loc
+ ".properties");