net.sf.wcfart.tbutils.res.Resources Maven / Gradle / Ivy

Go to download
package net.sf.wcfart.tbutils.res;

import java.io.File;
import java.text.MessageFormat;
import java.util.Collection;
import java.util.List;
import java.util.Locale;
import java.util.MissingResourceException;

/**
 * Facade to access key/value pairs and application home directory.
 * 
 * @author av
 */
public class Resources {
  private ReplacingResourceProvider provider;
  private Locale locale;
  private File home;
  private PersistentResourceProvider persistentProvider;
  private CompositeResourceProvider compositeProvider;
  
  static final String PERSISTENT_PROPERTIES = "persistent.properties";

  /**
   * returns a Resources instance in the default locale
   * of the VM. This is NOT the locale of the users browser etc.
   */
  public static Resources instance() {
    return ResourcesFactory.instance().getResources(null, null);
  }

  /**
   * returns a Resources instance in the configured locale, or if
   * no locale was configured, in the browsers locale.
   */
  public static Resources instance(Locale browserLocale) {
    return ResourcesFactory.instance().getResources(browserLocale, null);
  }

  /**
   * returns a Resources instance in the configured locale, or if
   * no locale was configured, in the browsers locale. 
   * 
   * If the package of clazz
   * contains a ResourceBundle named
   * resources.properties 
   * that bundle will be added to the returned Resources.
   */
  public static Resources instance(Locale browserLocale, Class clazz) {
    return ResourcesFactory.instance().getResources(browserLocale, clazz.getPackage().getName() + ".resources");
  }

  /**
   * returns a Resources instance in the default locale. 
   * 

   * If the package of clazz
   * contains a ResourceBundle named
   * resources.properties 
   * that bundle will be added to the returned Resources.
   */
  public static Resources instance(Class clazz) {
    return ResourcesFactory.instance().getResources(Locale.getDefault(), clazz.getPackage().getName() + ".resources");
  }
  
  /**
   * returns a Resources instance in the configured locale, or if
   * no locale was configured, in the browsers locale. 
   * 

   * The named ResourceBundle will be added to the returned Resources.
   */
  public static Resources instance(Locale browserLocale, String bundleName) {
    return ResourcesFactory.instance().getResources(browserLocale, bundleName);
  }
  
  Resources(CompositeResourceProvider compositeProvider, Locale locale, File home) {
    this.locale = locale;
    this.home = home;
    this.compositeProvider = compositeProvider;
    File persistentProperties = new File(home, PERSISTENT_PROPERTIES);
    this.persistentProvider = new FilePersistentResourceProvider(persistentProperties);
    // make persistentProvider the first one to look into
    compositeProvider.add(0, persistentProvider);
    this.provider = new ReplacingResourceProvider(compositeProvider);
  }

  /**
   * looksup a string value. 
   * @param key key in resourcebundle
   * @param defaultValue returnvalue if key was not found
   * @return resource value or defaultValue
   */
  public String getOptionalString(String key, String defaultValue) {
    String s = provider.getString(key);
    if (s == null)
      return defaultValue;
    return s.trim();
  }
  
  /**
   * looks up a string value. 
   * @throws MissingResourceException if key was not found
   */
  public String getString(String key) throws MissingResourceException {
    String s = provider.getString(key);
    if (s == null)
      throw new MissingResourceException("missing resource for " + key, this.getClass().getName(), key);
    return s.trim();
  }

  /**
   * looks up a string value and formats via MessageFormat
   */
  public String getString(String key, Object arg) throws MissingResourceException {
    String fmt = getString(key);
    return MessageFormat.format(fmt, new Object[]{arg});
  }

  /**
   * looks up a string value and formats via MessageFormat
   */
  public String getString(String key, Object arg0, Object arg1) throws MissingResourceException {
    String fmt = getString(key);
    return MessageFormat.format(fmt, new Object[]{arg0, arg1});
  }

  /**
   * looks up a string value and formats via MessageFormat
   */
  public String getString(String key, Object[] args) throws MissingResourceException {
    String fmt = getString(key);
    return MessageFormat.format(fmt, args);
  }

  /**
   * looks up a boolean value 
   */
  public boolean getBoolean(String key) throws MissingResourceException {
    String s = getString(key);
    return "true".equals(s) || "on".equals(s) || "yes".equals(s);
  }

  public boolean getOptionalBoolean(String key, boolean defaultValue) {
    try {
      return getBoolean(key);
    } catch (MissingResourceException e) {
      return defaultValue;
    }
  }

  /**
   * looks up an integervalue 
   */
  public int getInteger(String key) throws MissingResourceException {
    String s = getString(key);
    return Integer.parseInt(s);
  }

  public int getOptionalInteger(String key, int defaultValue) {
    try {
      return getInteger(key);
    } catch (MissingResourceException e) {
      return defaultValue;
    }
  }
  
  /**
   * looks up a long value 
   */
  public long getLong(String key) throws MissingResourceException {
    String s = getString(key);
    return Long.parseLong(s);
  }

  public long getOptionalLong(String key, long defaultValue) {
    try {
      return getLong(key);
    } catch (MissingResourceException e) {
      return defaultValue;
    }
  }
  
  /**
   * looks up a double value 
   */
  public double getDouble(String key) throws MissingResourceException {
    String s = getString(key);
    return Double.parseDouble(s);
  }

  public double getOptionalDouble(String key, double defaultValue) {
    try {
      return getDouble(key);
    } catch (MissingResourceException e) {
      return defaultValue;
    }
  }
  
  /**
   * returns a collection of all known keys. The list maybe incomplete
   * eg. JNDI keys are not returned.
   */
  public Collection