X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2Fresources%2FBundle.java;h=9da8d74836edca0be72584031ba8c83e06bfae65;hb=487926f7ddbf951064dac50cc468afceb8b0b232;hp=b4019de53d67e851e096074021b8b7341b22eef8;hpb=62c9ec78bcd5d7016e6d1447b4422955cb55b198;p=nikiroo-utils.git diff --git a/src/be/nikiroo/utils/resources/Bundle.java b/src/be/nikiroo/utils/resources/Bundle.java index b4019de..9da8d74 100644 --- a/src/be/nikiroo/utils/resources/Bundle.java +++ b/src/be/nikiroo/utils/resources/Bundle.java @@ -36,8 +36,8 @@ import java.util.ResourceBundle; public class Bundle> { protected Class type; protected Enum name; - private ResourceBundle map; - private Map changeMap; + private Map map; // R/O map + private Map changeMap; // R/W map /** * Create a new {@link Bundles} of the given name. @@ -51,8 +51,9 @@ public class Bundle> { protected Bundle(Class type, Enum name) { this.type = type; this.name = name; + this.map = new HashMap(); this.changeMap = new HashMap(); - setBundle(name, Locale.getDefault()); + setBundle(name, Locale.getDefault(), false); } /** @@ -65,7 +66,7 @@ public class Bundle> { * resource file) */ public String getString(E id) { - return getStringX(id, null); + return getString(id.name()); } /** @@ -78,12 +79,14 @@ public class Bundle> { * */ public void setString(E id, String value) { - setStringX(id, null, value); + setString(id.name(), value); } /** * Return the value associated to the given id as a {@link String} suffixed * with the runtime value "_suffix" (that is, "_" and suffix). + *

+ * Will only accept suffixes that form an existing id. * * @param mame * the id of the value to get @@ -97,8 +100,11 @@ public class Bundle> { String key = id.name() + (suffix == null ? "" : "_" + suffix.toUpperCase()); - if (containsKey(key)) { - return getString(key).trim(); + try { + id = Enum.valueOf(type, key); + return getString(id); + } catch (IllegalArgumentException e) { + } return null; @@ -107,6 +113,8 @@ public class Bundle> { /** * Set the value associated to the given id as a {@link String} suffixed * with the runtime value "_suffix" (that is, "_" and suffix). + *

+ * Will only accept suffixes that form an existing id. * * @param mame * the id of the value to get @@ -119,7 +127,12 @@ public class Bundle> { String key = id.name() + (suffix == null ? "" : "_" + suffix.toUpperCase()); - setString(key, value); + try { + id = Enum.valueOf(type, key); + setString(id, value); + } catch (IllegalArgumentException e) { + + } } /** @@ -287,6 +300,23 @@ public class Bundle> { setString(id, "#" + r + g + b + a); } + /** + * Create/update the .properties file. + *

+ * Will use the most likely candidate as base if the file does not already + * exists and this resource is translatable (for instance, "en_US" will use + * "en" as a base if the resource is a translation file). + *

+ * Will update the files in {@link Bundles#getDirectory()}; it MUST + * be set. + * + * @throws IOException + * in case of IO errors + */ + public void updateFile() throws IOException { + updateFile(Bundles.getDirectory()); + } + /** * Create/update the .properties file. *

@@ -295,7 +325,8 @@ public class Bundle> { * "en" as a base if the resource is a translation file). * * @param path - * the path where the .properties files are + * the path where the .properties files are, MUST NOT be + * NULL * * @throws IOException * in case of IO errors @@ -330,9 +361,14 @@ public class Bundle> { /** * Reload the {@link Bundle} data files. + * + * @param resetToDefault + * reset to the default configuration (do not look into the + * possible user configuration files, only take the original + * configuration) */ - public void reload() { - setBundle(name, null); + public void reload(boolean resetToDefault) { + setBundle(name, Locale.getDefault(), resetToDefault); } /** @@ -344,16 +380,7 @@ public class Bundle> { * @return true if it does */ protected boolean containsKey(String key) { - if (changeMap.containsKey(key)) { - return true; - } - - try { - map.getObject(key); - return true; - } catch (MissingResourceException e) { - return false; - } + return changeMap.containsKey(key) || map.containsKey(key); } /** @@ -370,8 +397,8 @@ public class Bundle> { return changeMap.get(key); } - if (containsKey(key)) { - return map.getString(key); + if (map.containsKey(key)) { + return map.get(key); } return null; @@ -387,7 +414,7 @@ public class Bundle> { * the associated value */ protected void setString(String key, String value) { - changeMap.put(key, value); + changeMap.put(key, value == null ? null : value.trim()); } /** @@ -536,28 +563,96 @@ public class Bundle> { * the name of the bundle to load * @param locale * the {@link Locale} to use + * @param resetToDefault + * reset to the default configuration (do not look into the + * possible user configuration files, only take the original + * configuration) */ - protected void setBundle(Enum name, Locale locale) { - map = null; + protected void setBundle(Enum name, Locale locale, boolean resetToDefault) { changeMap.clear(); String dir = Bundles.getDirectory(); - if (dir != null) { + boolean found = false; + if (!resetToDefault && dir != null) { try { File file = getPropertyFile(dir, name.name(), locale); if (file != null) { Reader reader = new InputStreamReader(new FileInputStream( file), "UTF8"); - map = new PropertyResourceBundle(reader); + resetMap(new PropertyResourceBundle(reader)); + found = true; } } catch (IOException e) { e.printStackTrace(); } } - if (map == null) { - map = ResourceBundle.getBundle(type.getPackage().getName() + "." - + name.name(), locale, new FixedResourceBundleControl()); + if (!found) { + String bname = type.getPackage().getName() + "." + name.name(); + try { + resetMap(ResourceBundle + .getBundle(bname, locale, type.getClassLoader(), + new FixedResourceBundleControl())); + } catch (Exception e) { + // We have no bundle for this Bundle + System.err.println("No bundle found for: " + bname); + resetMap(null); + } + } + } + + /** + * Reset the backing map to the content of the given bundle, or empty if + * bundle is NULL. + * + * @param bundle + * the bundle to copy + */ + private void resetMap(ResourceBundle bundle) { + this.map.clear(); + + if (bundle != null) { + for (E field : type.getEnumConstants()) { + try { + String value = bundle.getString(field.name()); + this.map.put(field.name(), + value == null ? null : value.trim()); + } catch (MissingResourceException e) { + } + } + } + } + + /** + * Take a snapshot of the changes in memory in this {@link Bundle} made by + * the "set" methods ( {@link Bundle#setString(Enum, String)}...) at the + * current time. + * + * @return a snapshot to use with {@link Bundle#restoreSnapshot(Object)} + */ + public Object takeSnapshot() { + return new HashMap(changeMap); + } + + /** + * Restore a snapshot taken with {@link Bundle}, or reset the current + * changes if the snapshot is NULL. + * + * @param snap + * the snapshot or NULL + */ + @SuppressWarnings("unchecked") + public void restoreSnapshot(Object snap) { + if (snap == null) { + changeMap.clear(); + } else { + if (snap instanceof Map) { + changeMap = (Map) snap; + } else { + throw new Error( + "Restoring changes in a Bundle must be done on a changes snapshot, " + + "or NULL to discard current changes"); + } } }