org.omnaest.i18nbinder.test.I18nFacade Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-i18nbinder-plugin-test Show documentation
The newest version!
package org.omnaest.i18nbinder.test;

import java.util.Locale;
import java.util.MissingResourceException;
import javax.annotation.Generated;

import java.util.Map;
import java.util.LinkedHashMap;
import java.util.ResourceBundle;

import org.omnaest.i18nbinder.test.i18nfacade.I18n;
/**
 * This is an automatically with i18nBinder generated facade class.


 * To modify please adapt the underlying property files.


 * If the facade class is instantiated with a given {@link Locale} using {@link #I18nFacade(Locale)} all non static methods will use this predefined {@link Locale} when invoked.


 * The facade methods will silently ignore all {@link MissingResourceException}s by default. To alter this behavior see {@link #I18nFacade(Locale, boolean)}


 * @see I18n
 */ 
@Generated(value = "http://code.google.com/p/i18n-binder/", date = "2012-06-24T18:35:00+02:00")
public class I18nFacade {
  /** @see I18n */
  public final I18n I18n;
   /** Static access helper for the underlying resource */
   public static class Resource
  {
    /** Internally used {@link ResourceBasedTranslator}. Changing this implementation affects the behavior of the whole facade */
    public static ResourceBasedTranslator resourceBasedTranslator = new ResourceBasedTranslator()
    {
      @Override
      public String translate( String baseName, String key, Locale locale )
      {
        ResourceBundle resourceBundle = ResourceBundle.getBundle( baseName,locale );
        return resourceBundle.getString( key );
      }

      @Override
      public String[] resolveAllKeys( String baseName, Locale locale )
      {
        ResourceBundle resourceBundle = ResourceBundle.getBundle( baseName,locale );
        return resourceBundle.keySet().toArray( new String[0] );
      }
    };

  }
  /** Defines which {@link ResourceBasedTranslator} the facade should use. This affects all available instances. */
  public static void use( ResourceBasedTranslator resourceBasedTranslator )
  {
    I18nFacade.Resource.resourceBasedTranslator = resourceBasedTranslator;
  }


  /**
   * Basic interface which is used by the facade to resolve translated values for given keys

   * 

   * Any implementation should be thread safe   */ 
  public static interface ResourceBasedTranslator {
    /**
     * Returns the translated value for the given key respecting the base name and the given {@link Locale}
     * @param baseName
     * @param key
     * @param locale
     * @return
     */ 
    public String translate( String baseName, String key, Locale locale );
    /**
     * Returns all available keys for the given {@link Locale}
     * @param baseName
     * @param locale
     * @return
     */ 
    public String[] resolveAllKeys( String baseName, Locale locale );
  }


  /**
   * A {@link Translator} offers several methods to translate arbitrary keys into their i18n counterpart based on the initially
   * given {@link Locale}.
   * 
   * @see #translate(String)
   * @see #translate(String[]) 
   * @see #allPropertyKeys() 
   */ 
  public static class Translator {

    private final String baseName;
    private final Locale locale;
    private final boolean silentlyIgnoreMissingResourceException;

    /**
     * @see Translator
     * @param baseName
     * @param locale
     */ 
    public Translator( String baseName, Locale locale )
    {
      this(baseName,locale,true);
    }

    /**
     * @see Translator
     * @param baseName
     * @param locale
     */ 
    public Translator( String baseName, Locale locale, boolean silentlyIgnoreMissingResourceException )
    {
      super();
      this.baseName = baseName;
      this.locale = locale;
      this.silentlyIgnoreMissingResourceException = silentlyIgnoreMissingResourceException;
    }

    /**
     * Returns the translated property key for the given {@link Locale}
     * @see Translator
     * @see #translate(String)
     * @see #translate(String[])
     */ 
    public String translate(Locale locale, String key)
    {
      try
      {
        return I18nFacade.Resource.resourceBasedTranslator.translate( this.baseName, key, locale );
      }
      catch ( MissingResourceException e )
      {
        if (!this.silentlyIgnoreMissingResourceException)
        {
          throw e;
        }
        return null;
      }
    }

    /**
     * Returns the translated property key for the predefined {@link Locale}
     * @see Translator
     * @see #translate(Locale, String)
     * @see #translate(String[])
     */ 
    public String translate( String key )
    {
      return translate( this.locale, key );
    }

    /**
     * Returns a translation {@link Map} with the given property keys and their respective values for the given {@link Locale}.
     * @param keys 
     * @see Translator
     * @see #allPropertyKeys()
     * @see #translate(String)
     */ 
    public Map translate( Locale locale, String... keys )
    {
      Map retmap = new LinkedHashMap();
      for ( String key : keys )
      {
        retmap.put( key, translate( locale, key ) );
      }
      return retmap;
    }

    /**
     * Returns a translation {@link Map} with the given property keys and their respective values for the predefined {@link Locale}.
     * @param keys 
     * @see Translator
     * @see #allPropertyKeys()
     * @see #translate(String)
     */ 
    public Map translate( String... keys )
    {
      return translate( this.locale, keys );
    }

    /**
     * Returns all available property keys for the given {@link Locale}. 
     * @see Translator
     * @see #allPropertyKeys()
     * @see #translate(String[])
     */ 
    public String[] allPropertyKeys(Locale locale)
    {
      return I18nFacade.Resource.resourceBasedTranslator.resolveAllKeys( this.baseName, locale );
    }

    /**
     * Returns all available property keys for the predefined {@link Locale}. 
     * @see Translator
     * @see #allPropertyKeys(Locale)
     * @see #translate(String[])
     */ 
    public String[] allPropertyKeys()
    {
      return allPropertyKeys( this.locale );
    }

    /**
     * Returns a translation {@link Map} for the predefined {@link Locale} including all available i18n keys resolved using 
     * {@link #allPropertyKeys()} and their respective translation values resolved using {@link #translate(String...)} 
     * @see Translator
     * @see #allPropertyKeys(Locale)
     * @see #translate(String[])
     * @return {@link Map}
     */ 
    public Map translationMap()
    {
      return this.translate( this.allPropertyKeys() );
    }

    /**
     * Similar to {@link #translationMap()} for the given {@link Locale} instead. 
     * @see Translator
     * @see #allPropertyKeys(Locale)
     * @see #translate(String[])
     * @param locale
     * @return {@link Map}
     */ 
    public Map translationMap( Locale locale )
    {
      return this.translate( locale, this.allPropertyKeys( locale ) );
    }

  }


  /**
   * This {@link I18nFacade} constructor will create a new instance which silently ignores any {@link MissingResourceException} 
   * @see I18nFacade
   * @param locale
   */ 
  public I18nFacade( Locale locale )
  {
    this(locale,true);
  }
  

  /**
   * @see I18nFacade
   * @param locale
   * @param silentlyIgnoreMissingResourceException
   */ 
  public I18nFacade( Locale locale, boolean silentlyIgnoreMissingResourceException )
  {
    super();
    this.I18n = new I18n( locale, silentlyIgnoreMissingResourceException );
  }
  
}