com.squarespace.cldrengine.api.CLocale Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cldr-engine Show documentation

Squarespace cldr-engine

The newest version!

package com.squarespace.cldrengine.api;

/**
 * Wrapper pairing an application's opaque locale identifier with a
 * parsed and resolved language tag object.
 *
 * Prefixed with 'C' to distinguish it from Java's Locale.
 */
public interface CLocale {

  /**
   * Application's own identifier for the locale, e.g. 'en_US', 'fr-CA', etc.
   * We preserve this since applications may use it as a unique key to
   * resolve translated messages, and may be forced to use a legacy
   * identifier.
   */
  String id();

  /**
   * Language tag that has been parsed and resolved. Parsing canonicalizes
   * the subtags, while resolution includes substituting language and
   * territory aliases and adding likely subtags.
   */
  LanguageTag tag();

}