de.lessvoid.xml.tools.SpecialValuesReplace Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of nifty Show documentation
Nifty GUI is a Java Library that supports the building of interactive user interfaces for games or similar applications. It utilizes OpenGL for rendering and it can be easily integrated into many rendering systems. The configuration of the GUI is stored in xml files with little supporting Java code. In short Nifty helps you to layout stuff, display it in a cool way and interact with it :)
The newest version!
package de.lessvoid.xml.tools;

import java.text.MessageFormat;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.Properties;
import java.util.logging.Level;
import java.util.logging.Logger;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * @author Marc Pompl
 * @author void (added some additional features)
 * @created 12.06.2010
 */
public class SpecialValuesReplace {
  private static final String KEY_PROP = "PROP.";
  private static final String KEY_ENV = "ENV.";
  private static final String KEY_CALL = "CALL.";

  private static final Logger log = Logger.getLogger(SpecialValuesReplace.class.getName());

  /**
   * Tries to replace values surrounded by "${...}". All pieces of the input that are not
   * part of a "${...}" expression are returned unmodified. Replacement is executed for
   * all "${...}" values contained in the input. Yes, this means there is support for
   * multiple "${...}" expressions in input! :)

   * 

   * Example inputs:
   * 
   * {@code ${ENV.myEnv}} checks and returns if {@code myEnv} exists in
   * {@link System.getEnv()}.
   *
   * {@code ${PROP.myProp}} checks and returns if myProp exists in
   * the given properties. If properties is {@code null}, {@link System.getProperties()}
   * is checked instead.{@code ${CALL.myMethod()}} calls the method {@code myMethod()} on the
   * given {@code object} if it's not {@code null}
   * 
   *
   * {@code ${resourceBundleId.key}} tries to find the ResourceBundle with the
   * given {@code id} on the given list of ResourceBundles. And then calls
   * {@code resourceBundle.get(key)} to translate the value.
   * 
   * 
   * @param input (may be {@code null})
   * @param resourceBundles Map of pre loaded ResourceBundles with a String id
   * @param methodCallTarget if the input contains ${CALL...} the target object to call the method with
   * @param properties if the input contains ${PROP...} the properties to use (may be {@code null} in this case
   *                   System.getProperties() are used)
   * @param locale 
   * 
   * @return the parsed input
   */
  @Nonnull
  public static String replace(
      @Nullable final String input,
      @Nonnull final Map resourceBundles,
      @Nullable final Object methodCallTarget,
      @Nullable final Properties properties,
      @Nonnull final Locale locale) {
    if (input == null) {
      return "";
    }
    if (!Split.containsKey(input)) {
      return input;
    }
    List parts = Split.split(input);
    for (int idx=0; idx parts, final int idx) {
    if (idx == 0) {
      return null;
    }
    return parts.get(idx - 1);
  }

  @Nonnull
  private static String removeQuotes(@Nonnull final String input) {
    return input.substring(2, input.length()-1);
  }

  private static boolean isSpecialTag(@Nullable final String input, @Nullable final String prev) {
    boolean isSpecialTag = input != null && input.startsWith("${") && input.endsWith("}");
    if (!isSpecialTag) {
      return false;
    }
    if (endsWithQuote(prev)) {
      return false;
    }
    return true;
  }
  

  private static String handleENV(@Nonnull final String value) {
    String name = removeQuotes(value).substring(KEY_ENV.length());
    if (System.getenv().containsKey(name)) {
      String env = System.getenv().get(name);
      if (env != null && env.length() > 0) {
        return env;
      }
    }
    return value;
  }

  @Nullable
  private static String handleProperties(@Nonnull final String input, final Properties properties) {
    String name = removeQuotes(input).substring(KEY_PROP.length());
    String value = readFromProperties(name, properties);
    if (value == null) {
      value = readFromProperties(name, System.getProperties());
    }
    if (value != null) {
      return value;
    }
    return input;
  }

  @Nullable
  private static String readFromProperties(final String name, @Nullable final Properties properties) {
    if (properties != null) {
      if (properties.containsKey(name)) {
        String value = properties.getProperty(name);
        if (value != null && value.length() > 0) {
          return value;
        }
      }
    }
    return null;
  }

  private static String handleCall(@Nonnull final String value, @Nullable final Object object) {
    if (object != null) {
      String methodName = removeQuotes(value).substring(KEY_CALL.length());
      MethodInvoker methodInvoker = new MethodInvoker(methodName, object);
      Object response = methodInvoker.invoke();
      if (response != null) {
        return response.toString();
      }
    }
    return value;
  }

  private static String handleLocalize(
      @Nonnull final String value,
      @Nonnull final Map resourceBundles,
      @Nonnull final Locale locale) {
    if (value.contains(".")) {
      String removedQuotes = removeQuotes(value);
      String resourceSelector = removedQuotes.substring(0, removedQuotes.indexOf("."));
      String resourceKey = removedQuotes.substring(removedQuotes.indexOf(".") + 1);
      BundleInfo bundleInfo = resourceBundles.get(resourceSelector);
      if (bundleInfo == null) {
        if (log.isLoggable(Level.WARNING)) {
          log.warning("no resource bundle defined for: " + resourceSelector);
        }
        return value;
      }
      try {
        return bundleInfo.getString(resourceKey, locale);
      } catch(MissingResourceException e) {
        if (log.isLoggable(Level.WARNING)) {
          log.warning("Missing resource: " + resourceSelector + "." + resourceKey);
        }
        return "<" + resourceKey + ">";
      }
    }
    return value;
  }
}