X-Git-Url: http://git.nikiroo.be/?a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2Fresources%2FBundle.java;h=84efceafabfacac5d1edf887dc49f3542bd76725;hb=601003e69e1dc81774243c6eadf7982b6b563b33;hp=5932cfff71db0793a074a0bddccf9b56a5b34e25;hpb=9e834013f84e8797acf26f5418ae3448044ad097;p=fanfix.git diff --git a/src/be/nikiroo/utils/resources/Bundle.java b/src/be/nikiroo/utils/resources/Bundle.java index 5932cff..84efcea 100644 --- a/src/be/nikiroo/utils/resources/Bundle.java +++ b/src/be/nikiroo/utils/resources/Bundle.java @@ -19,6 +19,8 @@ import java.util.MissingResourceException; import java.util.PropertyResourceBundle; import java.util.ResourceBundle; +import be.nikiroo.utils.resources.Meta.Format; + /** * This class encapsulate a {@link ResourceBundle} in UTF-8. It allows to * retrieve values associated to an enumeration, and allows some additional @@ -72,6 +74,42 @@ public class Bundle> { setBundle(name, Locale.getDefault(), false); } + /** + * Check if the setting is set into this {@link Bundle}. + * + * @param id + * the id of the setting to check + * @param includeDefaultValue + * TRUE to only return false when the setting is not set AND + * there is no default value + * + * @return TRUE if the setting is set + */ + public boolean isSet(E id, boolean includeDefaultValue) { + return isSet(id.name(), includeDefaultValue); + } + + /** + * Check if the setting is set into this {@link Bundle}. + * + * @param name + * the id of the setting to check + * @param includeDefaultValue + * TRUE to only return false when the setting is explicitly set + * to NULL (and not just "no set") in the change maps + * + * @return TRUE if the setting is set + */ + protected boolean isSet(String name, boolean includeDefaultValue) { + if (getString(name, null) == null) { + if (!includeDefaultValue || getString(name, "") == null) { + return false; + } + } + + return true; + } + /** * Return the value associated to the given id as a {@link String}. * @@ -82,7 +120,64 @@ public class Bundle> { * resource file) */ public String getString(E id) { - return getString(id.name()); + return getString(id, null); + } + + /** + * Return the value associated to the given id as a {@link String}. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file + * + * @return the associated value, or def if not found (not present + * in the resource file) + */ + public String getString(E id, String def) { + return getString(id, def, -1); + } + + /** + * Return the value associated to the given id as a {@link String}. + *

+ * If no value is associated (or if it is empty!), take the default one if + * any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + * @return the associated value, def if not found (not present in + * the resource file) or NULL if the item is specified (not -1) and + * does not exist + */ + public String getString(E id, String def, int item) { + String rep = getString(id.name(), null); + if (rep == null) { + rep = getMetaDef(id.name()); + } + + if (rep.isEmpty()) { + return def; + } + + if (item >= 0) { + List values = BundleHelper.parseList(rep, item); + if (values != null && item < values.size()) { + return values.get(item); + } + + return null; + } + + return rep; } /** @@ -98,11 +193,34 @@ public class Bundle> { setString(id.name(), value); } + /** + * Set the value associated to the given id as a {@link String}. + * + * @param id + * the id of the value to set + * @param value + * the value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + */ + public void setString(E id, String value, int item) { + if (item < 0) { + setString(id.name(), value); + } else { + List values = getList(id); + setString(id.name(), BundleHelper.fromList(values, value, item)); + } + } + /** * 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. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -113,14 +231,61 @@ public class Bundle> { * resource file) */ public String getStringX(E id, String suffix) { + return getStringX(id, suffix, null, -1); + } + + /** + * 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. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param suffix + * the runtime suffix + * @param def + * the default value when it is not present in the config file + * + * @return the associated value, or NULL if not found (not present in the + * resource file) + */ + public String getStringX(E id, String suffix, String def) { + return getStringX(id, suffix, def, -1); + } + + /** + * 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. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param suffix + * the runtime suffix + * @param def + * the default value when it is not present in the config file + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + * @return the associated value, def if not found (not present in + * the resource file), NULL if the item is specified (not -1) but + * does not exist and NULL if bad key + */ + public String getStringX(E id, String suffix, String def, int item) { String key = id.name() + (suffix == null ? "" : "_" + suffix.toUpperCase()); try { id = Enum.valueOf(type, key); - return getString(id); + return getString(id, def, item); } catch (IllegalArgumentException e) { - } return null; @@ -140,19 +305,40 @@ public class Bundle> { * the value */ public void setStringX(E id, String suffix, String value) { + setStringX(id, suffix, value, -1); + } + + /** + * 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 id + * the id of the value to set + * @param suffix + * the runtime suffix + * @param value + * the value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + */ + public void setStringX(E id, String suffix, String value, int item) { String key = id.name() + (suffix == null ? "" : "_" + suffix.toUpperCase()); try { id = Enum.valueOf(type, key); - setString(id, value); + setString(id, value, item); } catch (IllegalArgumentException e) { - } } /** * Return the value associated to the given id as a {@link Boolean}. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -160,12 +346,13 @@ public class Bundle> { * @return the associated value */ public Boolean getBoolean(E id) { - String str = getString(id); - return BundleHelper.parseBoolean(str); + return BundleHelper.parseBoolean(getString(id), -1); } /** * Return the value associated to the given id as a {@link Boolean}. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -176,13 +363,39 @@ public class Bundle> { * @return the associated value */ public boolean getBoolean(E id, boolean def) { - Boolean b = getBoolean(id); - if (b != null) - return b; + Boolean value = getBoolean(id); + if (value != null) { + return value; + } return def; } - + + /** + * Return the value associated to the given id as a {@link Boolean}. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file or + * if it is not a boolean value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + * @return the associated value + */ + public Boolean getBoolean(E id, boolean def, int item) { + String value = getString(id); + if (value != null) { + return BundleHelper.parseBoolean(value, item); + } + + return def; + } + /** * Set the value associated to the given id as a {@link Boolean}. * @@ -193,12 +406,29 @@ public class Bundle> { * */ public void setBoolean(E id, boolean value) { - setString(id.name(), BundleHelper.fromBoolean(value)); + setBoolean(id, value, -1); } + /** + * Set the value associated to the given id as a {@link Boolean}. + * + * @param id + * the id of the value to set + * @param value + * the value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + */ + public void setBoolean(E id, boolean value, int item) { + setString(id, BundleHelper.fromBoolean(value), item); + } /** * Return the value associated to the given id as an {@link Integer}. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -206,11 +436,18 @@ public class Bundle> { * @return the associated value */ public Integer getInteger(E id) { - return BundleHelper.parseInteger(getString(id)); + String value = getString(id); + if (value != null) { + return BundleHelper.parseInteger(value, -1); + } + + return null; } /** * Return the value associated to the given id as an int. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -221,9 +458,35 @@ public class Bundle> { * @return the associated value */ public int getInteger(E id, int def) { - Integer i = getInteger(id); - if (i != null) - return i; + Integer value = getInteger(id); + if (value != null) { + return value; + } + + return def; + } + + /** + * Return the value associated to the given id as an int. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file or + * if it is not a int value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + * @return the associated value + */ + public Integer getInteger(E id, int def, int item) { + String value = getString(id); + if (value != null) { + return BundleHelper.parseInteger(value, item); + } return def; } @@ -238,11 +501,29 @@ public class Bundle> { * */ public void setInteger(E id, int value) { - setString(id.name(), BundleHelper.fromInteger(value)); + setInteger(id, value, -1); } - + + /** + * Set the value associated to the given id as a {@link Integer}. + * + * @param id + * the id of the value to set + * @param value + * the value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + */ + public void setInteger(E id, int value, int item) { + setString(id, BundleHelper.fromInteger(value), item); + } + /** * Return the value associated to the given id as a {@link Character}. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -250,11 +531,13 @@ public class Bundle> { * @return the associated value */ public Character getCharacter(E id) { - return BundleHelper.parseCharacter(getString(id)); + return BundleHelper.parseCharacter(getString(id), -1); } /** * Return the value associated to the given id as a {@link Character}. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -265,18 +548,75 @@ public class Bundle> { * @return the associated value */ public char getCharacter(E id, char def) { - Character car = getCharacter(id); - if (car != null) - return car; + Character value = getCharacter(id); + if (value != null) { + return value; + } + + return def; + } + + /** + * Return the value associated to the given id as a {@link Character}. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file or + * if it is not a char value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + * @return the associated value + */ + public Character getCharacter(E id, char def, int item) { + String value = getString(id); + if (value != null) { + return BundleHelper.parseCharacter(value, item); + } return def; } + /** + * Set the value associated to the given id as a {@link Character}. + * + * @param id + * the id of the value to set + * @param value + * the value + * + */ + public void setCharacter(E id, char value) { + setCharacter(id, value, -1); + } + + /** + * Set the value associated to the given id as a {@link Character}. + * + * @param id + * the id of the value to set + * @param value + * the value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + */ + public void setCharacter(E id, char value, int item) { + setString(id, BundleHelper.fromCharacter(value), item); + } + /** * Return the value associated to the given id as a colour if it is found * and can be parsed. *

* The returned value is an ARGB value. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -284,7 +624,60 @@ public class Bundle> { * @return the associated value */ public Integer getColor(E id) { - return BundleHelper.parseColor(getString(id)); + return BundleHelper.parseColor(getString(id), -1); + } + + /** + * Return the value associated to the given id as a colour if it is found + * and can be parsed. + *

+ * The returned value is an ARGB value. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file or + * if it is not a char value + * + * @return the associated value + */ + public int getColor(E id, int def) { + Integer value = getColor(id); + if (value != null) { + return value; + } + + return def; + } + + /** + * Return the value associated to the given id as a colour if it is found + * and can be parsed. + *

+ * The returned value is an ARGB value. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file or + * if it is not a char value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + * @return the associated value + */ + public Integer getColor(E id, int def, int item) { + String value = getString(id); + if (value != null) { + return BundleHelper.parseColor(value, item); + } + + return def; } /** @@ -298,12 +691,30 @@ public class Bundle> { * the new colour */ public void setColor(E id, Integer color) { - setString(id, BundleHelper.fromColor(color)); + setColor(id, color, -1); + } + + /** + * Set the value associated to the given id as a Color. + * + * @param id + * the id of the value to set + * @param value + * the value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + */ + public void setColor(E id, int value, int item) { + setString(id, BundleHelper.fromColor(value), item); } /** * Return the value associated to the given id as a list of values if it is * found and can be parsed. + *

+ * If no value is associated, take the default one if any. * * @param id * the id of the value to get @@ -312,7 +723,58 @@ public class Bundle> { * not found or cannot be parsed as a list */ public List getList(E id) { - return BundleHelper.parseList(getString(id)); + return BundleHelper.parseList(getString(id), -1); + } + + /** + * Return the value associated to the given id as a list of values if it is + * found and can be parsed. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file or + * if it is not a char value + * + * @return the associated list, empty if the value is empty, NULL if it is + * not found or cannot be parsed as a list + */ + public List getList(E id, List def) { + List value = getList(id); + if (value != null) { + return value; + } + + return def; + } + + /** + * Return the value associated to the given id as a list of values if it is + * found and can be parsed. + *

+ * If no value is associated, take the default one if any. + * + * @param id + * the id of the value to get + * @param def + * the default value when it is not present in the config file or + * if it is not a char value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + * @return the associated list, empty if the value is empty, NULL if it is + * not found or cannot be parsed as a list + */ + public List getList(E id, List def, int item) { + String value = getString(id); + if (value != null) { + return BundleHelper.parseList(value, item); + } + + return def; } /** @@ -324,7 +786,23 @@ public class Bundle> { * the new list of values */ public void setList(E id, List list) { - setString(id, BundleHelper.fromList(list)); + setList(id, list, -1); + } + + /** + * Set the value associated to the given id as a {@link List}. + * + * @param id + * the id of the value to set + * @param value + * the value + * @param item + * the item number to get for an array of values, or -1 for + * non-arrays + * + */ + public void setList(E id, List value, int item) { + setString(id, BundleHelper.fromList(value), item); } /** @@ -456,15 +934,43 @@ public class Bundle> { } /** - * Get the value for the given key if it exists in the internal map, or NULL - * if not. + * The default {@link Meta#def()} value for the given enumeration name. + * + * @param id + * the enumeration name (the "id") + * + * @return the def value in the {@link MetaInfo} or "" if none (never NULL) + */ + protected String getMetaDef(String id) { + String rep = ""; + try { + Meta meta = type.getDeclaredField(id).getAnnotation(Meta.class); + rep = meta.def(); + } catch (NoSuchFieldException e) { + } catch (SecurityException e) { + } + + if (rep == null) { + rep = ""; + } + + return rep; + } + + /** + * Get the value for the given key if it exists in the internal map, or + * def if not. + *

+ * DO NOT get the default meta value (MetaInfo.def()). * * @param key * the key to check for + * @param def + * the default value when it is not present in the internal map * - * @return the value, or NULL + * @return the value, or def if not found */ - protected String getString(String key) { + protected String getString(String key, String def) { if (changeMap.containsKey(key)) { return changeMap.get(key); } @@ -473,7 +979,7 @@ public class Bundle> { return map.get(key); } - return null; + return def; } /** @@ -505,37 +1011,40 @@ public class Bundle> { String[] list = meta.list(); boolean nullable = meta.nullable(); String def = meta.def(); - String info = meta.info(); boolean array = meta.array(); // Default, empty values -> NULL - if (desc.length() + list.length + info.length() + def.length() == 0 - && !group && nullable && format == Meta.Format.STRING) { + if (desc.length() + list.length + def.length() == 0 && !group + && nullable && format == Format.STRING) { return null; } StringBuilder builder = new StringBuilder(); - builder.append("# ").append(desc); - if (desc.length() > 20) { - builder.append("\n#"); + for (String line : desc.split("\n")) { + builder.append("# ").append(line).append("\n"); } if (group) { - builder.append("This item is used as a group, its content is not expected to be used."); + builder.append("# This item is used as a group, its content is not expected to be used."); } else { - builder.append(" (FORMAT: ").append(format) - .append(nullable ? "" : " (required)"); - builder.append(") ").append(info); + builder.append("# (FORMAT: ").append(format) + .append(nullable ? "" : ", required"); + builder.append(") "); if (list.length > 0) { - builder.append("\n# ALLOWED VALUES:"); + builder.append("\n# ALLOWED VALUES: "); + boolean first = true; for (String value : list) { - builder.append(" \"").append(value).append("\""); + if (!first) { + builder.append(", "); + } + builder.append(BundleHelper.escape(value)); + first = false; } } if (array) { - builder.append("\n# (This item accept a list of comma-separated values)"); + builder.append("\n# (This item accepts a list of ^escaped comma-separated values)"); } } @@ -567,8 +1076,11 @@ public class Bundle> { } /** - * Write the given id to the config file, i.e., "MY_ID = my_curent_value" - * followed by a new line + * Write the given data to the config file, i.e., "MY_ID = my_curent_value" + * followed by a new line. + *

+ * Will prepend a # sign if the is is not set (see + * {@link Bundle#isSet(Enum, boolean)}). * * @param writer * the {@link Writer} to write into @@ -579,12 +1091,15 @@ public class Bundle> { * in case of IO error */ protected void writeValue(Writer writer, E id) throws IOException { - writeValue(writer, id.name(), getString(id)); + boolean set = isSet(id, false); + writeValue(writer, id.name(), getString(id), set); } /** * Write the given data to the config file, i.e., "MY_ID = my_curent_value" - * followed by a new line + * followed by a new line. + *

+ * Will prepend a # sign if the is is not set. * * @param writer * the {@link Writer} to write into @@ -592,12 +1107,19 @@ public class Bundle> { * the id to write * @param value * the id's value + * @param set + * the value is set in this {@link Bundle} * * @throws IOException * in case of IO error */ - protected void writeValue(Writer writer, String id, String value) - throws IOException { + protected void writeValue(Writer writer, String id, String value, + boolean set) throws IOException { + + if (!set) { + writer.write('#'); + } + writer.write(id); writer.write(" = "); @@ -651,7 +1173,7 @@ public class Bundle> { File file = getPropertyFile(dir, name.name(), locale); if (file != null) { Reader reader = new InputStreamReader(new FileInputStream( - file), "UTF8"); + file), "UTF-8"); resetMap(new PropertyResourceBundle(reader)); found = true; } @@ -681,30 +1203,26 @@ public class Bundle> { } /** - * Reset the backing map to the content of the given bundle, or with default - * valiues if bundle is NULL. + * Reset the backing map to the content of the given bundle, or with NULL + * values if bundle is NULL. * * @param bundle * the bundle to copy */ protected void resetMap(ResourceBundle bundle) { this.map.clear(); - for (Field field : type.getDeclaredFields()) { - try { - Meta meta = field.getAnnotation(Meta.class); - if (meta != null) { - E id = Enum.valueOf(type, field.getName()); - - String value; - if (bundle != null) { - value = bundle.getString(id.name()); - } else { - value = meta.def(); + if (bundle != null) { + for (Field field : type.getDeclaredFields()) { + try { + Meta meta = field.getAnnotation(Meta.class); + if (meta != null) { + E id = Enum.valueOf(type, field.getName()); + String value = bundle.getString(id.name()); + this.map.put(id.name(), + value == null ? null : value.trim()); } - - this.map.put(id.name(), value == null ? null : value.trim()); + } catch (MissingResourceException e) { } - } catch (MissingResourceException e) { } } }