com.github.croesch.util.generator.LocaleGenerator Maven / Gradle / Ivy

Go to download
package com.github.croesch.util.generator;

import java.util.Locale;

/**
 * Generator for file names.
 * 
 * @author croesch
 * @since Date: 10.03.2011 19:14:05
 */
public final class LocaleGenerator {

  /**
   * the {@link Locale} to generate things from, ensured to be not null
   */
  private final Locale loc;

  /**
   * Constructs a {@link LocaleGenerator} with the given {@link Locale}
   * 
   * @since Date: 10.03.2011
   * @param locale the {@link Locale} that is used to generate things.
   */
  public LocaleGenerator(final Locale locale) {
    if (locale == null) {
      throw new IllegalArgumentException();
    }
    this.loc = locale;
  }

  /**
   * Generates file names from a given {@link Locale} with the given prefix. These filenames will be:

   * prefix
 prefix_language
 
   * prefix_language_country
   * 
   * prefix_language_country_variant
   * 
   * @param prefix the prefix of the generated file names. If prefix is null this will return an array that
   *        contains only null-values.
   * @return an array that contains the generated file names
   */
  public String[] defaultNamesStartingWith(final String prefix) {
    final int numOfVariations = 4;
    final int posOfName = 3;
    final int posOfNameLng = 2;
    final int posOfNameLngCountry = 1;
    final int posOfNameLngCountryVar = 0;

    final String lang = this.loc.getLanguage();
    final String coun = this.loc.getCountry();
    final String vari = this.loc.getVariant();

    final String[] names = new String[numOfVariations];

    if (prefix == null) {
      return names;
    }

    names[posOfName] = prefix;
    if (!"".equals(lang)) {
      names[posOfNameLng] = prefix + "_" + lang;
    }
    if (!"".equals(lang) && !"".equals(coun)) {
      names[posOfNameLngCountry] = prefix + "_" + lang + "_" + coun;
    }
    if (!"".equals(lang) && !"".equals(coun) && !"".equals(vari)) {
      names[posOfNameLngCountryVar] = prefix + "_" + lang + "_" + coun + "_" + vari;
    }
    return names;
  }

  @Override
  public int hashCode() {
    final int prime = 31;
    int result = 1;
    result = prime * result + this.loc.hashCode();
    return result;
  }

  @Override
  public boolean equals(final Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final LocaleGenerator other = (LocaleGenerator) obj;
    if (!this.loc.equals(other.loc)) {
      return false;
    }
    return true;
  }

}