org.apache.sis.util.iso

Class SimpleInternationalString

Object

AbstractInternationalString

SimpleInternationalString

All Implemented Interfaces:

Serializable, CharSequence, Comparable<InternationalString>, Formattable, InternationalString

public class SimpleInternationalString
extends AbstractInternationalString
implements Serializable

An international string consisting of a single string for all locales. For such a particular case, this implementation is more effective than other implementations provided in this package.

Instantiation

If the characters sequence to wrap is known to be a String instance, then the Simple­International­String(String) constructor is okay. Otherwise use the Types.to­International­String(Char­Sequence) method.

Immutability and thread safety

This class is immutable and thus inherently thread-safe. Subclasses may or may not be immutable, at implementation choice. But implementors are encouraged to make sure that subclasses remain immutable for more predictable behavior.

Since:

0.3

See Also:

Serialized Form

Defined in the sis-utility module

Constructor Summary

Constructors

Constructor and Description
SimpleInternationalString(String text) Creates a new instance from the given string.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Compares this international string with the specified object for equality.
int	hashCode() Returns a hash code value for this international text.
String	toString() Returns the string representation, which is unique for all locales.
String	toString(Locale locale) Returns the same string for all locales.

Methods inherited from class AbstractInternationalString

char­At, compare­To, format­To, length, sub­Sequence

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface CharSequence

chars, code­Points

Constructor Detail

SimpleInternationalString

public SimpleInternationalString(String text)

Creates a new instance from the given string. If the type of the text to wrap is the more generic Char­Sequence interface, then use the Types.to­International­String(Char­Sequence) method instead.

Parameters:

text - the string for all locales.

Method Detail

toString

public String toString()

Returns the string representation, which is unique for all locales.

Specified by:

to­String in interface Char­Sequence

Specified by:

to­String in interface International­String

Overrides:

to­String in class Abstract­International­String

Returns:

the string in the default locale.

toString

public String toString(Locale locale)

Returns the same string for all locales. This is the string given to the constructor.

Specified by:

to­String in interface International­String

Specified by:

to­String in class Abstract­International­String

Parameters:

locale - ignored in the Simple­International­String implementation.

Returns:

the international string as a String.

See Also:

Locale.get­Default(), Locale.ROOT

equals

public boolean equals(Object object)

Compares this international string with the specified object for equality.

Overrides:

equals in class Object

Parameters:

object - the object to compare with this international string.

Returns:

true if the given object is equal to this string.

hashCode

public int hashCode()

Returns a hash code value for this international text.

Overrides:

hash­Code in class Object

Returns:

the hash code value.