X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=blobdiff_plain;f=src%2Fbe%2Fnikiroo%2Futils%2Fresources%2FBundle.java;h=fe3ac1a3be4eb2c66580f855ea9df1ee206085dc;hp=3506fdde070d82f0e24d803412a68e17523e0333;hb=abfeadcc2c0da88e32dd49291e8163880fe270f1;hpb=b15a49851835d45d35ba9fdd28521df34021828f

diff --git a/src/be/nikiroo/utils/resources/Bundle.java b/src/be/nikiroo/utils/resources/Bundle.java
index 3506fdd..fe3ac1a 100644
--- a/src/be/nikiroo/utils/resources/Bundle.java
+++ b/src/be/nikiroo/utils/resources/Bundle.java
@@ -5,6 +5,7 @@ import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
 import java.io.Reader;
@@ -92,11 +93,11 @@ public class Bundle<E extends Enum<E>> {
 	/**
 	 * Check if the setting is set into this {@link Bundle}.
 	 * 
-	 * @param id
+	 * @param name
 	 *            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
+	 *            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
 	 */
@@ -133,23 +134,48 @@ public class Bundle<E extends Enum<E>> {
 	 * @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)
+	 * @return the associated value, or <tt>def</tt> 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}.
+	 * <p>
+	 * 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, <tt>def</tt> 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) {
-			try {
-				Meta meta = type.getDeclaredField(id.name()).getAnnotation(
-						Meta.class);
-				rep = meta.def();
-			} catch (NoSuchFieldException e) {
-			} catch (SecurityException e) {
-			}
+			rep = getMetaDef(id.name());
 		}
 
-		if (rep == null) {
-			rep = def;
+		if (rep.isEmpty()) {
+			return def;
+		}
+
+		if (item >= 0) {
+			List<String> values = BundleHelper.parseList(rep, item);
+			if (values != null && item < values.size()) {
+				return values.get(item);
+			}
+
+			return null;
 		}
 
 		return rep;
@@ -168,6 +194,27 @@ public class Bundle<E extends Enum<E>> {
 		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<String> 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).
@@ -185,14 +232,61 @@ public class Bundle<E extends Enum<E>> {
 	 *         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).
+	 * <p>
+	 * Will only accept suffixes that form an existing id.
+	 * <p>
+	 * 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).
+	 * <p>
+	 * Will only accept suffixes that form an existing id.
+	 * <p>
+	 * 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, <tt>def</tt> 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;
@@ -212,14 +306,33 @@ public class Bundle<E extends Enum<E>> {
 	 *            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).
+	 * <p>
+	 * 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) {
-
 		}
 	}
 
@@ -234,8 +347,7 @@ public class Bundle<E extends Enum<E>> {
 	 * @return the associated value
 	 */
 	public Boolean getBoolean(E id) {
-		String str = getString(id);
-		return BundleHelper.parseBoolean(str);
+		return BundleHelper.parseBoolean(getString(id), -1);
 	}
 
 	/**
@@ -252,9 +364,35 @@ public class Bundle<E extends Enum<E>> {
 	 * @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}.
+	 * <p>
+	 * 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;
 	}
@@ -269,7 +407,23 @@ public class Bundle<E extends Enum<E>> {
 	 * 
 	 */
 	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);
 	}
 
 	/**
@@ -283,7 +437,12 @@ public class Bundle<E extends Enum<E>> {
 	 * @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;
 	}
 
 	/**
@@ -300,9 +459,35 @@ public class Bundle<E extends Enum<E>> {
 	 * @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.
+	 * <p>
+	 * 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;
 	}
@@ -317,7 +502,23 @@ public class Bundle<E extends Enum<E>> {
 	 * 
 	 */
 	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);
 	}
 
 	/**
@@ -331,7 +532,7 @@ public class Bundle<E extends Enum<E>> {
 	 * @return the associated value
 	 */
 	public Character getCharacter(E id) {
-		return BundleHelper.parseCharacter(getString(id));
+		return BundleHelper.parseCharacter(getString(id), -1);
 	}
 
 	/**
@@ -348,13 +549,68 @@ public class Bundle<E extends Enum<E>> {
 	 * @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}.
+	 * <p>
+	 * 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.
@@ -369,7 +625,60 @@ public class Bundle<E extends Enum<E>> {
 	 * @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.
+	 * <p>
+	 * The returned value is an ARGB value.
+	 * <p>
+	 * 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.
+	 * <p>
+	 * The returned value is an ARGB value.
+	 * <p>
+	 * 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;
 	}
 
 	/**
@@ -383,7 +692,23 @@ public class Bundle<E extends Enum<E>> {
 	 *            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);
 	}
 
 	/**
@@ -399,7 +724,58 @@ public class Bundle<E extends Enum<E>> {
 	 *         not found or cannot be parsed as a list
 	 */
 	public List<String> 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.
+	 * <p>
+	 * 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<String> getList(E id, List<String> def) {
+		List<String> 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.
+	 * <p>
+	 * 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<String> getList(E id, List<String> def, int item) {
+		String value = getString(id);
+		if (value != null) {
+			return BundleHelper.parseList(value, item);
+		}
+
+		return def;
 	}
 
 	/**
@@ -411,7 +787,23 @@ public class Bundle<E extends Enum<E>> {
 	 *            the new list of values
 	 */
 	public void setList(E id, List<String> 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<String> value, int item) {
+		setString(id, BundleHelper.fromList(value), item);
 	}
 
 	/**
@@ -542,9 +934,35 @@ public class Bundle<E extends Enum<E>> {
 		return changeMap.containsKey(key) || map.containsKey(key);
 	}
 
+	/**
+	 * 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
 	 * <tt>def</tt> if not.
+	 * <p>
+	 * DO NOT get the default meta value (MetaInfo.def()).
 	 * 
 	 * @param key
 	 *            the key to check for
@@ -627,7 +1045,7 @@ public class Bundle<E extends Enum<E>> {
 			}
 
 			if (array) {
-				builder.append("\n# (This item accepts a list of escaped comma-separated values)");
+				builder.append("\n# (This item accepts a list of ^escaped comma-separated values)");
 			}
 		}
 
@@ -751,13 +1169,21 @@ public class Bundle<E extends Enum<E>> {
 
 		boolean found = false;
 		if (!resetToDefault && dir != null) {
-			// Look into Bundles.getDirectory() for .properties files
 			try {
+				// Look into Bundles.getDirectory() for .properties files
 				File file = getPropertyFile(dir, name.name(), locale);
 				if (file != null) {
-					Reader reader = new InputStreamReader(new FileInputStream(
-							file), "UTF-8");
-					resetMap(new PropertyResourceBundle(reader));
+					InputStream in = new FileInputStream(file);
+					try {
+						Reader reader = new InputStreamReader(in, "UTF-8");
+						try {
+							resetMap(new PropertyResourceBundle(reader));
+						} finally {
+							reader.close();
+						}
+					} finally {
+						in.close();
+					}
 					found = true;
 				}
 			} catch (IOException e) {
@@ -786,7 +1212,7 @@ public class Bundle<E extends Enum<E>> {
 	}
 
 	/**
-	 * Reset the backing map to the content of the given bundle, or with default
+	 * Reset the backing map to the content of the given bundle, or with NULL
 	 * values if bundle is NULL.
 	 * 
 	 * @param bundle
@@ -794,22 +1220,18 @@ public class Bundle<E extends Enum<E>> {
 	 */
 	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) {
 			}
 		}
 	}