Package org.jxmpp.jid.parts

Class Localpart

java.lang.Object

org.jxmpp.jid.parts.Part

org.jxmpp.jid.parts.Localpart

All Implemented Interfaces:

java.io.Serializable, java.lang.CharSequence

public class Localpart
extends Part

A localpart of an XMPP address (JID). The localpart is the part before the first @ sign in an XMPP address and usually identifies the user (or the XMPP entity) within an XMPP service. It is also often referred to as "username", but note that the actual username used to login may be different from the resulting localpart of the user's JID.

You can create instances of this class from Strings using from(String).

See Also:

RFC 6122 § 2.3. Localpart, Serialized Form

Method Summary

Modifier and Type	Method	Description
java.lang.String	asUnescapedString()	Return the unescaped String representation of this Localpart.
static Localpart	formUnescapedOrNull(java.lang.CharSequence cs)	Get a Localpart from a given CharSequence or null if the input is not a valid localpart.
static Localpart	from(java.lang.String localpart)	Get the Localpart representing the input String.
static Localpart	from(java.lang.String localpart, JxmppContext context)	Get the Localpart representing the input String.
static Localpart	fromOrNull(java.lang.CharSequence cs)	Get a Localpart from a given CharSequence or null if the input is not a valid localpart.
static Localpart	fromOrThrowUnchecked(java.lang.CharSequence cs)	Like from(String) but does throw an unchecked IllegalArgumentException instead of a XmppStringprepException.
static Localpart	fromUnescaped(java.lang.CharSequence unescapedLocalpart)	Get a Localpart from an unescaped CharSequence.
static Localpart	fromUnescaped(java.lang.String unescapedLocalpart)	Get a Localpart from an unescaped String.
static Localpart	fromUnescapedOrThrowUnchecked(java.lang.CharSequence cs)	Like fromUnescaped(String) but does throw an unchecked IllegalArgumentException instead of a XmppStringprepException.

Methods inherited from class org.jxmpp.jid.parts.Part

assertNotLongerThan1023BytesOrEmpty, charAt, equals, hashCode, intern, length, subSequence, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Method Detail

asUnescapedString

public java.lang.String asUnescapedString()

Return the unescaped String representation of this Localpart.

Since certain Unicode code points are disallowed in the localpart of a JID by the required stringprep profile, those need to get escaped when used in a real JID. The unescaped representation of the JID is only for presentation to a human user or for gatewaying to a non-XMPP system.

Returns:

the unescaped String representation of this JID.

Since:

0.6.1

See Also:

Jid.asUnescapedString()

fromOrThrowUnchecked

public static Localpart fromOrThrowUnchecked(java.lang.CharSequence cs)

Like from(String) but does throw an unchecked IllegalArgumentException instead of a XmppStringprepException.

Parameters:

cs - the character sequence which should be transformed to a Localpart

Returns:

the Localpart if no exception occurs

Throws:

java.lang.IllegalArgumentException - if the given input is not a valid Localpart

Since:

0.6.2

See Also:

from(String)

fromUnescapedOrThrowUnchecked

public static Localpart fromUnescapedOrThrowUnchecked(java.lang.CharSequence cs)

Like fromUnescaped(String) but does throw an unchecked IllegalArgumentException instead of a XmppStringprepException.

Parameters:

cs - the character sequence which should be transformed to a Localpart

Returns:

the Localpart if no exception occurs

Since:

0.6.2

See Also:

from(String)

formUnescapedOrNull

public static Localpart formUnescapedOrNull(java.lang.CharSequence cs)

Get a Localpart from a given CharSequence or null if the input is not a valid localpart.

Parameters:

cs - the input CharSequence

Returns:

a Localpart or null

fromUnescaped

public static Localpart fromUnescaped(java.lang.String unescapedLocalpart)
                               throws XmppStringprepException

Get a Localpart from an unescaped String.

Parameters:

unescapedLocalpart - an unescaped String representing a Localpart.

Returns:

a Localpart

Throws:

XmppStringprepException - if an error occurs.

Since:

0.6.2

fromUnescaped

public static Localpart fromUnescaped(java.lang.CharSequence unescapedLocalpart)
                               throws XmppStringprepException

Get a Localpart from an unescaped CharSequence.

Parameters:

unescapedLocalpart - an unescaped CharSequence representing a Localpart.

Returns:

a Localpart

Throws:

XmppStringprepException - if an error occurs.

Since:

0.6.2

fromOrNull

public static Localpart fromOrNull(java.lang.CharSequence cs)

Get a Localpart from a given CharSequence or null if the input is not a valid localpart.

Parameters:

cs - the input CharSequence

Returns:

a Localpart or null

from

public static Localpart from(java.lang.String localpart)
                      throws XmppStringprepException

Get the Localpart representing the input String.

Parameters:

localpart - the input String.

Returns:

the localpart.

Throws:

XmppStringprepException - if an error occurs.

from

public static Localpart from(java.lang.String localpart,
                             JxmppContext context)
                      throws XmppStringprepException

Get the Localpart representing the input String.

Parameters:

localpart - the input String.

context - the JXMPP context.

Returns:

the localpart.

Throws:

XmppStringprepException - if an error occurs.