* It also sports a writable change map, and you can save back the
* {@link Bundle} to file with {@link Bundle#updateFile(String)}.
*
- * @author niki
- *
* @param <E>
* the enum to use to get values out of this class
+ *
+ * @author niki
*/
+
public class Bundle<E extends Enum<E>> {
+ /** The type of E. */
protected Class<E> type;
- protected Enum<?> name;
- private ResourceBundle map;
+ /**
+ * The {@link Enum} associated to this {@link Bundle} (all the keys used in
+ * this {@link Bundle} will be of this type).
+ */
+ protected Enum<?> keyType;
+
+ private TransBundle<E> descriptionBundle;
+
+ /** R/O map */
+ private Map<String, String> map;
+ /** R/W map */
private Map<String, String> changeMap;
/**
*
* @param type
* a runtime instance of the class of E
- *
* @param name
* the name of the {@link Bundles}
+ * @param descriptionBundle
+ * the description {@link TransBundle}, that is, a
+ * {@link TransBundle} dedicated to the description of the values
+ * of the given {@link Bundle} (can be NULL)
*/
- protected Bundle(Class<E> type, Enum<?> name) {
+ protected Bundle(Class<E> type, Enum<?> name,
+ TransBundle<E> descriptionBundle) {
this.type = type;
- this.name = name;
+ this.keyType = name;
+ this.descriptionBundle = descriptionBundle;
+
+ this.map = new HashMap<String, String>();
this.changeMap = new HashMap<String, String>();
setBundle(name, Locale.getDefault(), false);
}
/**
* Return the value associated to the given id as a {@link String}.
*
- * @param mame
+ * @param id
* the id of the value to get
*
* @return the associated value, or NULL if not found (not present in the
* resource file)
*/
public String getString(E id) {
- return getStringX(id, null);
+ return getString(id.name());
}
/**
* Set the value associated to the given id as a {@link String}.
*
- * @param mame
+ * @param id
* the id of the value to get
* @param value
* the value
*
*/
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).
+ * <p>
+ * Will only accept suffixes that form an existing id.
*
- * @param mame
+ * @param id
* the id of the value to get
* @param suffix
* the runtime suffix
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;
/**
* 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 mame
+ * @param id
* the id of the value to get
* @param suffix
* the runtime suffix
String key = id.name()
+ (suffix == null ? "" : "_" + suffix.toUpperCase());
- setString(key, value);
+ try {
+ id = Enum.valueOf(type, key);
+ setString(id, value);
+ } catch (IllegalArgumentException e) {
+
+ }
}
/**
* Return the value associated to the given id as a {@link Boolean}.
*
- * @param mame
+ * @param id
* the id of the value to get
*
* @return the associated value
/**
* Return the value associated to the given id as a {@link Boolean}.
*
- * @param mame
+ * @param id
* the id of the value to get
* @param def
* the default value when it is not present in the config file or
/**
* Return the value associated to the given id as an {@link Integer}.
*
- * @param mame
+ * @param id
* the id of the value to get
*
* @return the associated value
}
/**
- * Return the value associated to the given id as a {@link int}.
+ * Return the value associated to the given id as an int.
*
- * @param mame
+ * @param id
* the id of the value to get
* @param def
* the default value when it is not present in the config file or
/**
* Return the value associated to the given id as a {@link Character}.
*
- * @param mame
+ * @param id
* the id of the value to get
*
* @return the associated value
/**
* Return the value associated to the given id as a {@link Character}.
*
- * @param mame
+ * @param id
* the id of the value to get
* @param def
* the default value when it is not present in the config file or
/**
* Return the value associated to the given id as a {@link Color}.
*
- * @param the
- * id of the value to get
+ * @param id
+ * the id of the value to get
*
* @return the associated value
*/
}
}
+ // 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;
}
/**
* Set the value associated to the given id as a {@link Color}.
*
- * @param the
- * id of the value to get
- *
- * @return the associated value
+ * @param id
+ * the id of the value to set
+ * @param color
+ * the new color
*/
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);
setString(id, "#" + r + g + b + a);
}
+ /**
+ * Create/update 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 update the files in {@link Bundles#getDirectory()}; it <b>MUST</b>
+ * be set.
+ *
+ * @throws IOException
+ * in case of IO errors
+ */
+ public void updateFile() throws IOException {
+ updateFile(Bundles.getDirectory());
+ }
+
/**
* Create/update the .properties file.
* <p>
* "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, <b>MUST NOT</b> be
+ * NULL
*
* @throws IOException
* in case of IO errors
for (Field field : type.getDeclaredFields()) {
Meta meta = field.getAnnotation(Meta.class);
if (meta != null) {
- E id = E.valueOf(type, field.getName());
+ E id = Enum.valueOf(type, field.getName());
String info = getMetaInfo(meta);
if (info != null) {
writer.close();
}
+ /**
+ * The description {@link TransBundle}, that is, a {@link TransBundle}
+ * dedicated to the description of the values of the given {@link Bundle}
+ * (can be NULL).
+ *
+ * @return the description {@link TransBundle}
+ */
+ public TransBundle<E> getDescriptionBundle() {
+ return descriptionBundle;
+ }
+
/**
* Reload the {@link Bundle} data files.
*
* configuration)
*/
public void reload(boolean resetToDefault) {
- setBundle(name, null, resetToDefault);
+ setBundle(keyType, Locale.getDefault(), resetToDefault);
}
/**
* @return true if it does
*/
protected boolean containsKey(String key) {
- if (changeMap.containsKey(key)) {
- return true;
- }
-
- if (map != null) {
- try {
- map.getObject(key);
- return true;
- } catch (MissingResourceException e) {
- }
- }
-
- return false;
+ return changeMap.containsKey(key) || map.containsKey(key);
}
/**
return changeMap.get(key);
}
- if (map != null && containsKey(key)) {
- return map.getString(key);
+ if (map.containsKey(key)) {
+ return map.get(key);
}
return null;
* the associated value
*/
protected void setString(String key, String value) {
- changeMap.put(key, value);
+ changeMap.put(key, value == null ? null : value.trim());
}
/**
* @return the information to display or NULL if none
*/
protected String getMetaInfo(Meta meta) {
- String what = meta.what();
- String where = meta.where();
- String format = meta.format();
+ String desc = meta.description();
+ boolean group = meta.group();
+ Meta.Format format = meta.format();
+ String[] list = meta.list();
+ boolean nullable = meta.nullable();
String info = meta.info();
+ boolean array = meta.array();
- int opt = what.length() + where.length() + format.length();
- if (opt + info.length() == 0)
+ // Default, empty values -> NULL
+ if (desc.length() + list.length + info.length() == 0 && !group
+ && nullable && format == Meta.Format.STRING) {
return null;
+ }
StringBuilder builder = new StringBuilder();
- builder.append("# ");
-
- if (opt > 0) {
- builder.append("(");
- if (what.length() > 0) {
- builder.append("WHAT: " + what);
- if (where.length() + format.length() > 0)
- builder.append(", ");
- }
-
- if (where.length() > 0) {
- builder.append("WHERE: " + where);
- if (format.length() > 0)
- builder.append(", ");
- }
+ builder.append("# ").append(desc);
+ if (desc.length() > 20) {
+ builder.append("\n#");
+ }
- if (format.length() > 0) {
- builder.append("FORMAT: " + format);
+ if (group) {
+ 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);
+
+ if (list.length > 0) {
+ builder.append("\n# ALLOWED VALUES:");
+ for (String value : list) {
+ builder.append(" \"").append(value).append("\"");
+ }
}
- builder.append(")");
- if (info.length() > 0) {
- builder.append("\n# ");
+ if (array) {
+ builder.append("\n# (This item accept a list of comma-separated values)");
}
}
- builder.append(info);
-
return builder.toString();
}
* @return the name
*/
protected String getBundleDisplayName() {
- return name.toString();
+ return keyType.toString();
}
/**
* the path where the .properties files are
*
* @return the source {@link File}
- *
- * @throws IOException
- * in case of IO errors
*/
protected File getUpdateFile(String path) {
- return new File(path, name.name() + ".properties");
+ return new File(path, keyType.name() + ".properties");
}
/**
* configuration)
*/
protected void setBundle(Enum<?> name, Locale locale, boolean resetToDefault) {
- map = null;
changeMap.clear();
String dir = Bundles.getDirectory();
+ 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) {
+ if (!found) {
+ String bname = type.getPackage().getName() + "." + name.name();
try {
- map = ResourceBundle.getBundle(type.getPackage().getName()
- + "." + name.name(), locale,
- new FixedResourceBundleControl());
+ resetMap(ResourceBundle
+ .getBundle(bname, locale, type.getClassLoader(),
+ new FixedResourceBundleControl()));
} catch (Exception e) {
// We have no bundle for this Bundle
- map = null;
+ 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
+ */
+ 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) {
+ }
}
}
}
* the "set" methods ( {@link Bundle#setString(Enum, String)}...) at the
* current time.
*
- * @return a snapshot to use with {@link Bundle#restoreChanges(Object)}
+ * @return a snapshot to use with {@link Bundle#restoreSnapshot(Object)}
*/
- protected Object takeChangesSnapshot() {
+ public Object takeSnapshot() {
return new HashMap<String, String>(changeMap);
}
* the snapshot or NULL
*/
@SuppressWarnings("unchecked")
- protected void restoreChanges(Object snap) {
+ public void restoreSnapshot(Object snap) {
if (snap == null) {
changeMap.clear();
} else {
* Return the resource file that is closer to the {@link Locale}.
*
* @param dir
- * the dirctory to look into
+ * the directory to look into
* @param name
- * the file basename (without <tt>.properties</tt>)
+ * the file base name (without <tt>.properties</tt>)
* @param locale
* the {@link Locale}
*
file = new File(dir, name + loc + ".properties");
if (file.exists()) {
break;
- } else {
- file = null;
}
+
+ file = null;
}
return file;