org.opentripplanner.framework.i18n.I18NString Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of application Show documentation

The newest version!

package org.opentripplanner.framework.i18n;

import java.util.Locale;
import javax.annotation.Nullable;

/**
 * This interface is used when providing translations on server side. Sources: OSM tags with
 * multiple languages (like street names), or TranslatedString fields in GTFS-RT Alert messages.
 *
 * @author mabu
 */
public interface I18NString {
  /**
   * Return {@code true} if the given value is not {@code null} or has at least one none
   * white-space character.
   */
  static boolean hasValue(@Nullable I18NString value) {
    return !hasNoValue(value);
  }

  /**
   * Return {@code true} if the given value has at least one none white-space character.
   * Return {@code false} if the value is {@code null} or blank.
   */
  static boolean hasNoValue(@Nullable I18NString value) {
    return value == null || value.toString().isBlank();
  }

  /**
   * Returns default translation (english)
   */
  String toString();

  /**
   * Returns wanted translation
   *
   * @param locale Wanted locale
   */
  String toString(Locale locale);

  static I18NString assertHasValue(@Nullable I18NString value) {
    if (hasNoValue(value)) {
      throw new IllegalArgumentException(
        "Value can not be null, empty or just whitespace: " +
        (value == null ? "null" : "'" + value + "'")
      );
    }
    return value;
  }

  /**
   * Create an instance from a string.
   */
  static I18NString of(String value) {
    return new NonLocalizedString(value);
  }
}