package be.nikiroo.utils.resources;
-import java.awt.Color;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileInputStream;
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 iSet(E id, boolean includeDefaultValue) {
+ if (getString(id.toString(), null) == null) {
+ if (!includeDefaultValue || getString(id) == null) {
+ return false;
+ }
+ }
+
+ return true;
+ }
+
/**
* Return the value associated to the given id as a {@link String}.
*
* resource file)
*/
public String getString(E id) {
- return getString(id.name());
+ return getString(id, null);
}
/**
- * Set the value associated to the given id as a {@link String}.
+ * Return the value associated to the given id as a {@link String}.
+ * <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
+ *
+ * @return the associated value, or NULL if not found (not present in the
+ * resource file)
+ */
+ public String getString(E id, String def) {
+ String rep = getString(id.name(), null);
+ if (rep == null) {
+ MetaInfo<E> info = new MetaInfo<E>(type, this, id);
+ rep = info.getDefaultString();
+ }
+
+ if (rep == null) {
+ rep = def;
+ }
+
+ return rep;
+ }
+
+ /**
+ * 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
*
* 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
* Will only accept suffixes that form an existing id.
*
* @param id
- * the id of the value to get
+ * the id of the value to set
* @param suffix
* the runtime suffix
* @param value
/**
* 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
*/
public Boolean getBoolean(E id) {
String str = getString(id);
- if (str != null && str.length() > 0) {
- if (str.equalsIgnoreCase("true") || str.equalsIgnoreCase("on")
- || str.equalsIgnoreCase("yes"))
- return true;
- if (str.equalsIgnoreCase("false") || str.equalsIgnoreCase("off")
- || str.equalsIgnoreCase("no"))
- return false;
-
- }
-
- return null;
+ return BundleHelper.parseBoolean(str);
}
/**
* 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
return def;
}
+ /**
+ * 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
+ *
+ */
+ public void setBoolean(E id, boolean value) {
+ setString(id.name(), BundleHelper.fromBoolean(value));
+ }
+
/**
* Return the value associated to the given id as an {@link Integer}.
+ * <p>
+ * If no value is associated, take the default one if any.
*
* @param id
* the id of the value to get
* @return the associated value
*/
public Integer getInteger(E id) {
- try {
- return Integer.parseInt(getString(id));
- } catch (Exception e) {
- }
-
- return null;
+ return BundleHelper.parseInteger(getString(id));
}
/**
* 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
return def;
}
+ /**
+ * 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
+ *
+ */
+ public void setInteger(E id, int value) {
+ setString(id.name(), BundleHelper.fromInteger(value));
+ }
+
/**
* 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
* @return the associated value
*/
public Character getCharacter(E id) {
- String s = getString(id).trim();
- if (s.length() > 0) {
- return s.charAt(0);
- }
-
- return null;
+ return BundleHelper.parseCharacter(getString(id));
}
/**
* 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
* @return the associated value
*/
public char getCharacter(E id, char def) {
- String s = getString(id).trim();
- if (s.length() > 0) {
- return s.charAt(0);
- }
+ Character car = getCharacter(id);
+ if (car != null)
+ return car;
return def;
}
/**
- * Return the value associated to the given id as a {@link Color}.
+ * 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
*
* @return the associated value
*/
- public Color getColor(E id) {
- Color color = null;
-
- String bg = getString(id).trim();
- if (bg.startsWith("#") && (bg.length() == 7 || bg.length() == 9)) {
- try {
- int r = Integer.parseInt(bg.substring(1, 3), 16);
- int g = Integer.parseInt(bg.substring(3, 5), 16);
- int b = Integer.parseInt(bg.substring(5, 7), 16);
- int a = 255;
- if (bg.length() == 9) {
- a = Integer.parseInt(bg.substring(7, 9), 16);
- }
- color = new Color(r, g, b, a);
- } catch (NumberFormatException e) {
- color = null; // no changes
- }
- }
-
- // Try by name if still not found
- if (color == null) {
- try {
- Field field = Color.class.getField(bg);
- color = (Color) field.get(null);
- } catch (Exception e) {
- }
- }
- //
-
- return color;
+ public Integer getColor(E id) {
+ return BundleHelper.parseColor(getString(id));
}
/**
- * Set the value associated to the given id as a {@link Color}.
+ * Set the value associated to the given id as a colour.
+ * <p>
+ * The value is a BGRA value.
*
* @param id
* the id of the value to set
* @param color
- * the new color
+ * the new colour
*/
- public void setColor(E id, Color color) {
- // Check for named colours first
- try {
- Field[] fields = Color.class.getFields();
- for (Field field : fields) {
- if (field.equals(color)) {
- setString(id, field.getName());
- return;
- }
- }
- } catch (Exception e) {
- }
- //
-
- String r = Integer.toString(color.getRed(), 16);
- String g = Integer.toString(color.getGreen(), 16);
- String b = Integer.toString(color.getBlue(), 16);
- String a = "";
- if (color.getAlpha() < 255) {
- a = Integer.toString(color.getAlpha(), 16);
- }
+ public void setColor(E id, Integer color) {
+ setString(id, BundleHelper.fromColor(color));
+ }
+
+ /**
+ * 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
+ *
+ * @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) {
+ return BundleHelper.parseList(getString(id));
+ }
- setString(id, "#" + r + g + b + a);
+ /**
+ * Set the value associated to the given id as a list of values.
+ *
+ * @param id
+ * the id of the value to set
+ * @param list
+ * the new list of values
+ */
+ public void setList(E id, List<String> list) {
+ setString(id, BundleHelper.fromList(list));
}
/**
writer.close();
}
+ /**
+ * Delete the .properties file.
+ * <p>
+ * 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).
+ * <p>
+ * Will delete the files in {@link Bundles#getDirectory()}; it <b>MUST</b>
+ * be set.
+ *
+ * @return TRUE if the file was deleted
+ */
+ public boolean deleteFile() {
+ return deleteFile(Bundles.getDirectory());
+ }
+
+ /**
+ * Delete the .properties file.
+ * <p>
+ * 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).
+ *
+ * @param path
+ * the path where the .properties files are, <b>MUST NOT</b> be
+ * NULL
+ *
+ * @return TRUE if the file was deleted
+ */
+ public boolean deleteFile(String path) {
+ File file = getUpdateFile(path);
+ return file.delete();
+ }
+
/**
* The description {@link TransBundle}, that is, a {@link TransBundle}
* dedicated to the description of the values of the given {@link Bundle}
}
/**
- * Get the value for the given key if it exists in the internal map, or NULL
- * if not.
+ * Get the value for the given key if it exists in the internal map, or
+ * <tt>def</tt> if not.
*
* @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 <tt>def</tt> if not found
*/
- protected String getString(String key) {
+ protected String getString(String key, String def) {
if (changeMap.containsKey(key)) {
return changeMap.get(key);
}
return map.get(key);
}
- return null;
+ return def;
}
/**
Meta.Format format = meta.format();
String[] list = meta.list();
boolean nullable = meta.nullable();
- String info = meta.info();
+ String def = meta.def();
boolean array = meta.array();
// Default, empty values -> NULL
- if (desc.length() + list.length + info.length() == 0 && !group
+ if (desc.length() + list.length + def.length() == 0 && !group
&& nullable && format == Meta.Format.STRING) {
return null;
}
} else {
builder.append(" (FORMAT: ").append(format)
.append(nullable ? "" : " (required)");
- builder.append(") ").append(info);
+ builder.append(") ");
if (list.length > 0) {
builder.append("\n# ALLOWED VALUES:");
protected void setBundle(Enum<?> name, Locale locale, boolean resetToDefault) {
changeMap.clear();
String dir = Bundles.getDirectory();
+ String bname = type.getPackage().getName() + "." + name.name();
boolean found = false;
if (!resetToDefault && dir != null) {
+ // Look into Bundles.getDirectory() for .properties files
try {
File file = getPropertyFile(dir, name.name(), locale);
if (file != null) {
}
if (!found) {
- String bname = type.getPackage().getName() + "." + name.name();
+ // Look into the package itself for resources
try {
resetMap(ResourceBundle
.getBundle(bname, locale, type.getClassLoader(),
new FixedResourceBundleControl()));
+ found = true;
+ } catch (MissingResourceException e) {
} catch (Exception e) {
- // We have no bundle for this Bundle
- System.err.println("No bundle found for: " + bname);
- resetMap(null);
+ e.printStackTrace();
}
}
+
+ if (!found) {
+ // 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.
+ * Reset the backing map to the content of the given bundle, or with default
+ * valiues if bundle is NULL.
*
* @param bundle
* the bundle to copy
*/
protected 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) {
+ 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();
+ }
+
+ this.map.put(id.name(), value == null ? null : value.trim());
}
+ } catch (MissingResourceException e) {
}
}
}
if (snap instanceof Map) {
changeMap = (Map<String, String>) snap;
} else {
- throw new Error(
+ throw new RuntimeException(
"Restoring changes in a Bundle must be done on a changes snapshot, "
+ "or NULL to discard current changes");
}
if (file.exists()) {
break;
}
-
+
file = null;
}
git://git.nikiroo.be / nikiroo-utils.git / blobdiff