Package org.jxmpp.jid.impl

Class LocalAndDomainpartJid

java.lang.Object

org.jxmpp.jid.impl.AbstractJid

org.jxmpp.jid.impl.LocalAndDomainpartJid

All Implemented Interfaces:

Serializable, CharSequence, Comparable<Jid>, BareJid, EntityBareJid, EntityJid, Jid

public final class LocalAndDomainpartJid
extends AbstractJid
implements EntityBareJid

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.jxmpp.jid.impl.AbstractJid

cache

Method Summary

Modifier and Type	Method	Description
BareJid	asBareJid()	Return a JID created by removing the Resourcepart from this JID.
DomainBareJid	asDomainBareJid()	Convert this Jid to a DomainBareJid.
DomainFullJid	asDomainFullJidIfPossible()	Convert this Jid to a DomainFullJid if possible.
EntityBareJid	asEntityBareJid()	Return the bare JID of this entity JID.
EntityBareJid	asEntityBareJidIfPossible()	Convert this Jid to a EntityBareJid if possible.
String	asEntityBareJidString()	Return the bare JID string of this full JID.
EntityFullJid	asEntityFullJidIfPossible()	Convert this Jid to a EntityFullJid if possible.
EntityJid	asEntityJidIfPossible()	Convert this Jid to a EntityJid if possible.
FullJid	asFullJidIfPossible()	Convert this Jid to a FullJid if possible.
String	asUnescapedString()	Return the unescaped String representation of this JID.
Domainpart	getDomain()	Get the Domainpart of this Jid.
Localpart	getLocalpart()	Return the Localpart of this JID.
Localpart	getLocalpartOrNull()	Get the localpart of this JID or null.
Resourcepart	getResourceOrNull()	Get the resourcepart of this JID or null.
boolean	hasNoResource()	Check if this is an instance of EntityBareJid or DomainBareJid.
boolean	isParentOf(DomainBareJid domainBareJid)	See Jid.isParentOf(Jid).
boolean	isParentOf(DomainFullJid domainFullJid)	See Jid.isParentOf(Jid).
boolean	isParentOf(EntityBareJid bareJid)	See Jid.isParentOf(Jid).
boolean	isParentOf(EntityFullJid fullJid)	See Jid.isParentOf(Jid).
boolean	isStrictParentOf(DomainBareJid domainBareJid)	See Jid.isStrictParentOf(Jid).
boolean	isStrictParentOf(DomainFullJid domainFullJid)	See Jid.isStrictParentOf(Jid).
boolean	isStrictParentOf(EntityBareJid bareJid)	See Jid.isParentOf(Jid).
boolean	isStrictParentOf(EntityFullJid fullJid)	See Jid.isStrictParentOf(Jid).
String	toString()	Returns the String representation of this JID.

Methods inherited from class org.jxmpp.jid.impl.AbstractJid

asDomainFullJidOrThrow, asEntityBareJidOrThrow, asEntityFullJidOrThrow, asEntityJidOrThrow, asFullJidOrThrow, asUrlEncodedString, charAt, compareTo, downcast, equals, equals, equals, getLocalpartOrThrow, getResourceOrEmpty, getResourceOrThrow, hashCode, hasLocalpart, hasResource, intern, isDomainBareJid, isDomainFullJid, isEntityBareJid, isEntityFullJid, isEntityJid, isParentOf, isStrictParentOf, length, subSequence

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, length, subSequence

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.jxmpp.jid.Jid

asDomainFullJidOrThrow, asEntityBareJidOrThrow, asEntityFullJidOrThrow, asEntityJidOrThrow, asFullJidOrThrow, asUrlEncodedString, downcast, equals, equals, getLocalpartOrThrow, getResourceOrEmpty, getResourceOrThrow, hasLocalpart, hasResource, intern, isDomainBareJid, isDomainFullJid, isEntityBareJid, isEntityFullJid, isEntityJid, isParentOf, isStrictParentOf

Method Details

getLocalpart

public Localpart getLocalpart()

Description copied from interface: EntityJid

Return the Localpart of this JID.

Specified by:

getLocalpart in interface EntityJid

Returns:

the localpart.

toString

public String toString()

Description copied from interface: Jid

Returns the String representation of this JID.

Specified by:

toString in interface CharSequence

Specified by:

toString in interface Jid

Overrides:

toString in class Object

Returns:

the String representation of this JID.

asUnescapedString

public String asUnescapedString()

Description copied from interface: Jid

Return the unescaped String representation of this JID.

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.

For example, if the users inputs 'at&t guy@example.com', the escaped real JID created with JidCreate will be 'at\26t\20guy@example.com', which is what Jid.toString() will return. But Jid.asUnescapedString() will return again 'at&t guy@example.com'.

Specified by:

asUnescapedString in interface Jid

Returns:

the unescaped String representation of this JID.

asEntityBareJidIfPossible

public EntityBareJid asEntityBareJidIfPossible()

Description copied from interface: Jid

Convert this Jid to a EntityBareJid if possible.

Specified by:

asEntityBareJidIfPossible in interface Jid

Returns:

the corresponding EntityBareJid or null.

asEntityFullJidIfPossible

public EntityFullJid asEntityFullJidIfPossible()

Description copied from interface: Jid

Convert this Jid to a EntityFullJid if possible.

Specified by:

asEntityFullJidIfPossible in interface Jid

Returns:

the corresponding EntityFullJid or null.

asDomainFullJidIfPossible

public DomainFullJid asDomainFullJidIfPossible()

Description copied from interface: Jid

Convert this Jid to a DomainFullJid if possible.

Specified by:

asDomainFullJidIfPossible in interface Jid

Returns:

the corresponding DomainFullJid or null.

isParentOf

public boolean isParentOf(EntityBareJid bareJid)

Description copied from interface: Jid

See Jid.isParentOf(Jid).

Specified by:

isParentOf in interface Jid

Parameters:

bareJid - the bare JID.

Returns:

true if this JID is a parent of the given JID.

isParentOf

public boolean isParentOf(EntityFullJid fullJid)

Description copied from interface: Jid

See Jid.isParentOf(Jid).

Specified by:

isParentOf in interface Jid

Parameters:

fullJid - the full JID.

Returns:

true if this JID is a parent of the given JID.

isParentOf

public boolean isParentOf(DomainBareJid domainBareJid)

Description copied from interface: Jid

See Jid.isParentOf(Jid).

Specified by:

isParentOf in interface Jid

Parameters:

domainBareJid - the domain bare JID.

Returns:

true if this JID is a parent of the given JID.

isParentOf

public boolean isParentOf(DomainFullJid domainFullJid)

Description copied from interface: Jid

See Jid.isParentOf(Jid).

Specified by:

isParentOf in interface Jid

Parameters:

domainFullJid - the domain full JID.

Returns:

true if this JID is a parent of the given JID.

isStrictParentOf

public boolean isStrictParentOf(EntityBareJid bareJid)

Description copied from interface: Jid

See Jid.isParentOf(Jid).

Specified by:

isStrictParentOf in interface Jid

Parameters:

bareJid - the bare JID.

Returns:

true if this JID is a parent of the given JID.

isStrictParentOf

public boolean isStrictParentOf(EntityFullJid fullJid)

Description copied from interface: Jid

See Jid.isStrictParentOf(Jid).

Specified by:

isStrictParentOf in interface Jid

Parameters:

fullJid - the full JID.

Returns:

true if this JID is a parent of the given JID.

isStrictParentOf

public boolean isStrictParentOf(DomainBareJid domainBareJid)

Description copied from interface: Jid

See Jid.isStrictParentOf(Jid).

Specified by:

isStrictParentOf in interface Jid

Parameters:

domainBareJid - the domain bare JID.

Returns:

true if this JID is a parent of the given JID.

isStrictParentOf

public boolean isStrictParentOf(DomainFullJid domainFullJid)

Description copied from interface: Jid

See Jid.isStrictParentOf(Jid).

Specified by:

isStrictParentOf in interface Jid

Parameters:

domainFullJid - the domain full JID.

Returns:

true if this JID is a parent of the given JID.

asDomainBareJid

public DomainBareJid asDomainBareJid()

Description copied from interface: Jid

Convert this Jid to a DomainBareJid.

Note that it is always possible to convert a Jid to a DomainBareJid, since every Jid has a domain part.

Specified by:

asDomainBareJid in interface Jid

Returns:

the corresponding DomainBareJid.

getDomain

public Domainpart getDomain()

Description copied from interface: Jid

Get the Domainpart of this Jid.

Specified by:

getDomain in interface Jid

Returns:

the domainpart.

asBareJid

public BareJid asBareJid()

Description copied from interface: Jid

Return a JID created by removing the Resourcepart from this JID.

Specified by:

asBareJid in interface Jid

Returns:

this Jid without a Resourcepart.

hasNoResource

public boolean hasNoResource()

Description copied from interface: Jid

Check if this is an instance of EntityBareJid or DomainBareJid.

Specified by:

hasNoResource in interface Jid

Specified by:

hasNoResource in class AbstractJid

Returns:

true if this is an instance of BareJid or DomainBareJid

asEntityJidIfPossible

public EntityJid asEntityJidIfPossible()

Description copied from interface: Jid

Convert this Jid to a EntityJid if possible.

Specified by:

asEntityJidIfPossible in interface Jid

Returns:

the corresponding EntityJid or null.

asFullJidIfPossible

public FullJid asFullJidIfPossible()

Description copied from interface: Jid

Convert this Jid to a FullJid if possible.

Specified by:

asFullJidIfPossible in interface Jid

Returns:

the corresponding FullJid or null.

asEntityBareJid

public EntityBareJid asEntityBareJid()

Description copied from interface: EntityJid

Return the bare JID of this entity JID.

Specified by:

asEntityBareJid in interface EntityJid

Returns:

the bare JID.

getResourceOrNull

public Resourcepart getResourceOrNull()

Description copied from interface: Jid

Get the resourcepart of this JID or null.

If the JID is of form <localpart@domain.example/resource> then this method returns 'resource'. If the JID no resourcepart, then null is returned.

Specified by:

getResourceOrNull in interface Jid

Specified by:

getResourceOrNull in class AbstractJid

Returns:

the resource of this JID or null.

getLocalpartOrNull

public Localpart getLocalpartOrNull()

Description copied from interface: Jid

Get the localpart of this JID or null.

If the JID is of form <localpart@domain.example> then this method returns 'localpart'. If the JID has no localpart, then null is returned.

Specified by:

getLocalpartOrNull in interface Jid

Specified by:

getLocalpartOrNull in class AbstractJid

Returns:

the localpart of this JID or null.

asEntityBareJidString

public String asEntityBareJidString()

Description copied from interface: EntityJid

Return the bare JID string of this full JID.

Specified by:

asEntityBareJidString in interface EntityJid

Returns:

the bare JID string.