se.swedenconnect.opensaml.common.utils.LocalizedString Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-addons Show documentation
OpenSAML 5.X utility extension library
The newest version!
/*
 * Copyright 2016-2024 Sweden Connect
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package se.swedenconnect.opensaml.common.utils;

import java.util.Locale;
import java.util.Optional;

import com.google.common.base.Objects;

/**
 * Utility class for a localized string.
 *
 * @author Martin Lindström ([email protected])
 * @see Locale
 */
public class LocalizedString {

  /** Default language tag. */
  public static final String DEFAULT_LANGUAGE_TAG = "en";

  /** Localized string. */
  private String localizedString;

  /** Language of the localized string. */
  private String language;

  /**
   * Default constructor.
   */
  public LocalizedString() {
  }

  /**
   * Creates an instance by parsing the source string that must be on the format {@code -}. The string "en-Hello" will give a LocalizedString where:
   *
   * {@code
   * ls.getLanguage() => "en"
   * ls.getLocalString() => "Hello"}
   * 
   *
   * @param source the string to parse
   */
  public LocalizedString(final String source) {
    final String _source = source.trim();
    final int i = _source.indexOf('-');
    if (i <= 0 || i > 3) {
      throw new IllegalArgumentException("Bad format on localized string, expected -String");
    }
    this.localizedString = _source.substring(i + 1);
    this.language = _source.substring(0, i);
  }

  /**
   * Constructor.
   *
   * @param localString the localized string
   * @param language the language of the string
   */
  public LocalizedString(final String localString, final String language) {
    this.localizedString = localString;
    this.language = language;
  }

  /**
   * Constructor.
   *
   * @param localString the localized string
   * @param locale the locale (the language is obtained using {@link Locale#getLanguage()})
   */
  public LocalizedString(final String localString, final Locale locale) {
    this.localizedString = localString;
    this.language = Optional.ofNullable(locale).map(Locale::getLanguage).orElse(null);
  }

  /**
   * Gets the localized string.
   *
   * @return the localized string
   */
  public String getLocalString() {
    return this.localizedString;
  }

  /**
   * Sets the localized string.
   *
   * @param newString the localized string
   */
  public void setLocalizedString(final String newString) {
    this.localizedString = newString;
  }

  /**
   * Gets the language of the string.
   *
   * @return the language of the string
   */
  public String getLanguage() {
    return this.language != null ? this.language : DEFAULT_LANGUAGE_TAG;
  }

  /**
   * Sets the language of the string.
   *
   * @param newLanguage the language of the string
   */
  public void setLanguage(final String newLanguage) {
    this.language = newLanguage;
  }

  /** {@inheritDoc} */
  @Override
  public int hashCode() {
    int hash = 1;
    hash = hash * 31 + this.language.hashCode();
    hash = hash * 31 + this.localizedString.hashCode();
    return hash;
  }

  /**
   * Determines if two LocalizedStrings are equal, that is, if both thier localized string and language have
   * case-sentivite equality.
   *
   * @param obj the object this object is compared with
   *
   * @return true if the objects are equal, false if not
   */
  @Override
  public boolean equals(final Object obj) {
    if (obj == this) {
      return true;
    }
    if (obj instanceof final LocalizedString otherLString) {
      return Objects.equal(this.localizedString, otherLString.getLocalString())
          && Objects.equal(this.getLanguage(), otherLString.getLanguage());
    }
    return false;
  }

  /** {@inheritDoc} */
  @Override
  public String toString() {
    return String.format("[%s] %s", this.getLanguage(), this.localizedString);
  }

}