Package rocks.xmpp.core

Class Text

java.lang.Object

rocks.xmpp.core.Text

All Implemented Interfaces:

CharSequence, Comparable<Text>, LanguageElement

public final class Text
extends Object
implements LanguageElement, CharSequence, Comparable<Text>

A common text element which is used by multiple elements and namespaces in XMPP. This list of elements it is used by includes:

• A message's body or subject
• A presence's status
• A stanza error's text
• A stream error's text
• A SASL failure's text

This class is immutable and has a natural ordering which orders its text using a Collator instance of the locale (if any) and is consistent with equals.

See Also:

Message.getBodies(), Message.getSubjects(), Presence.getStatuses(), Failure, StreamError, StanzaError

Constructor Summary

Constructors

Constructor	Description
Text(String text)	Constructs a default status.
Text(String text, Locale language)	Constructs a status with a language attribute.

Method Summary

Modifier and Type	Method	Description
char	charAt(int index)
int	compareTo(Text o)
boolean	equals(Object o)
Locale	getLanguage()	Gets the language.
String	getText()	Gets the text.
int	hashCode()
int	length()
CharSequence	subSequence(int start, int end)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Constructor Detail

Text

public Text(String text)

Constructs a default status.

Parameters:

text - The text.

Text

public Text(String text,
            Locale language)

Constructs a status with a language attribute.

Parameters:

text - The text

language - The language.

Method Detail

getLanguage

public final Locale getLanguage()

Gets the language.

Specified by:

getLanguage in interface LanguageElement

Returns:

The language.

getText

public final String getText()

Gets the text.

Returns:

The text.

length

public final int length()

Specified by:

length in interface CharSequence

charAt

public final char charAt(int index)

Specified by:

charAt in interface CharSequence

subSequence

public final CharSequence subSequence(int start,
                                      int end)

Specified by:

subSequence in interface CharSequence

compareTo

public final int compareTo(Text o)

Specified by:

compareTo in interface Comparable<Text>

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object