org.jxmpp.jid.impl

Class DomainpartJid

java.lang.Object

org.jxmpp.jid.impl.AbstractJid

org.jxmpp.jid.impl.DomainpartJid

All Implemented Interfaces:

java.io.Serializable, java.lang.CharSequence, java.lang.Comparable<Jid>, DomainBareJid, Jid

public final class DomainpartJid
extends AbstractJid
implements DomainBareJid

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Domainpart	domain

Method Summary

Modifier and Type	Method and Description
BareJid	asBareJidIfPossible() Convert this Jid to a BareJid if possible.
DomainBareJid	asDomainBareJid() Convert this Jid to a DomainBareJid.
DomainFullJid	asDomainFullJidIfPossible() Convert this Jid to a DomainFullJid if possible.
FullJid	asFullJidIfPossible() Convert this Jid to a FullJid if possible.
JidWithLocalpart	asJidWithLocalpartIfPossible() Convert this Jid to a JidWithLocalpart if possible.
JidWithResource	asJidWithResourcepartIfPossible() Convert this Jid to a JidWithResource if possible.
java.lang.String	asUnescapedString() Return the unescaped String representation of this JID.
Domainpart	getDomain() Get the Domainpart 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 BareJid or DomainBareJid.
boolean	isParentOf(BareJid bareJid) See Jid.isParentOf(Jid).
boolean	isParentOf(DomainBareJid domainBareJid) See Jid.isParentOf(Jid).
boolean	isParentOf(DomainFullJid domainFullJid) See Jid.isParentOf(Jid).
boolean	isParentOf(FullJid fullJid) See Jid.isParentOf(Jid).
java.lang.String	toString() Returns the String representation of this JID.
Jid	withoutResource() Return a JID created by removing the Resourcepart from this JID.

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

charAt, compareTo, downcast, equals, equals, equals, hashCode, hasLocalpart, hasResource, isBareJid, isBareOrFullJid, isDomainBareJid, isDomainFullJid, isFullJid, isParentOf, length, subSequence

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jxmpp.jid.Jid

downcast, equals, equals, hasLocalpart, hasResource, isBareJid, isBareOrFullJid, isDomainBareJid, isDomainFullJid, isFullJid, isParentOf

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.CharSequence

charAt, chars, codePoints, length, subSequence

Field Detail

domain

protected final Domainpart domain

Method Detail

getDomain

public Domainpart getDomain()

Description copied from interface: Jid

Get the Domainpart of this Jid.

Specified by:

getDomain in interface Jid

Returns:

the domainpart.

toString

public java.lang.String toString()

Description copied from interface: Jid

Returns the String representation of this JID.

Specified by:

toString in interface java.lang.CharSequence

Specified by:

toString in interface Jid

Overrides:

toString in class java.lang.Object

Returns:

the String representation of this JID.

asUnescapedString

public java.lang.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.

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.

hasNoResource

public boolean hasNoResource()

Description copied from interface: Jid

Check if this is an instance of BareJid 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

asBareJidIfPossible

public BareJid asBareJidIfPossible()

Description copied from interface: Jid

Convert this Jid to a BareJid if possible.

Specified by:

asBareJidIfPossible in interface Jid

Returns:

the corresponding BareJid 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.

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(BareJid 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(FullJid 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.

withoutResource

public Jid withoutResource()

Description copied from interface: Jid

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

Specified by:

withoutResource in interface Jid

Returns:

this Jid without a Resourcepart.

asJidWithLocalpartIfPossible

public JidWithLocalpart asJidWithLocalpartIfPossible()

Description copied from interface: Jid

Convert this Jid to a JidWithLocalpart if possible.

Specified by:

asJidWithLocalpartIfPossible in interface Jid

Returns:

the corresponding JidWithLocalpart or null.

asJidWithResourcepartIfPossible

public JidWithResource asJidWithResourcepartIfPossible()

Description copied from interface: Jid

Convert this Jid to a JidWithResource if possible.

Specified by:

asJidWithResourcepartIfPossible in interface Jid

Returns:

the corresponding JidWithResourcepart or null.

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.