LocaleWrapper

java.lang.Object

com.inductiveautomation.ignition.common.i18n.LocaleWrapper

All Implemented Interfaces:: Serializable, Comparable<LocaleWrapper>

public class LocaleWrapper extends Object implements Serializable, Comparable<LocaleWrapper>

A class that represents a locale. It can be created with either a locale object or the lang code, and to-strings nicely.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor

Description

LocaleWrapper(@Nullable String langCode)

Constructs a new LocaleWrapper from a language code string.

LocaleWrapper(Locale locale)

Constructs a new LocaleWrapper from a Locale.
Method Summary

Modifier and Type

Method

Description

int

compareTo(LocaleWrapper o)

boolean

equals(Object obj)

String

getLangCode()

Locale

getLocale()

String

toString()

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- LocaleWrapper
  
  public LocaleWrapper(Locale locale)
  
  Constructs a new LocaleWrapper from a Locale.
  
  Parameters:
  
  locale - The locale to wrap.
- LocaleWrapper
  
  public LocaleWrapper(@Nullable String langCode)
  
  Constructs a new LocaleWrapper from a language code string. If the code is blank, the default locale is used.
  
  Parameters:
  
  langCode - The language code (e.g., "en", "en_US").
Method Details
- getLangCode
  
  public String getLangCode()
  
  Returns:
  
  The string representation of the locale (e.g., "en_US").
- getLocale
  
  public Locale getLocale()
  
  Returns:
  
  The underlying Locale object.
- equals
  
  public boolean equals(Object obj)
  
  Overrides:
  
  equals in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- compareTo
  
  public int compareTo(LocaleWrapper o)
  
  Specified by:
  
  compareTo in interface Comparable<LocaleWrapper>