Jid (jxmpp 0.6.3 API)

All Superinterfaces:

CharSequence, Comparable<Jid>, Serializable

All Known Subinterfaces:

BareJid, DomainBareJid, DomainFullJid, DomainJid, EntityBareJid, EntityFullJid, EntityJid, FullJid

All Known Implementing Classes:

AbstractJid, DomainAndResourcepartJid, DomainpartJid, LocalAndDomainpartJid, LocalDomainAndResourcepartJid
```
public interface Jid
extends Comparable<Jid>, CharSequence, Serializable
```
An XMPP address, also known as JID (formerly for "Jabber Identifier"), which acts as globally unique address within the XMPP network.
JIDs are created from String or CharSequence with the JidCreate utility.
```
 Jid jid = JidCreate.from("juliet@capulet.org/balcony");
 EntityBareJid bareJid = JidCreate.entityBareFrom("romeo@montague.net");
 
```
This is the super interface for all JID types, which are constructed from two dimensions: Bare/Full and Domain/Entity. Every JID consists at least of a Domainpart. Bare JID types do not come with a Resourcepart, full JID types always have a Resourcepart. Domain JID types do not possess a Localpart, whereas entity JID types always do.

The following table shows a few examples of JID types.

Example Type

example.org DomainBareJid

example.org/resource DomainFullJid

user@example.org EntityBareJid

user@example.org/resource EntityFullJid

You can retrieve the escaped String representing the Jid with toString() or the unsecaped String of the JID with asUnescapedString().
See Also:

RFC 6120 (XMPP: Core) § 2.1 Global Addresses, RFC 6122 (XMPP: Address Format) § 2.1 Fundamentals

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and 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.
`DomainFullJid`	`asDomainFullJidOrThrow()` Convert this Jid to a `DomainFullJid` or throw an `IllegalStateException` if this is not possible.
`EntityBareJid`	`asEntityBareJidIfPossible()` Convert this Jid to a `EntityBareJid` if possible.
`EntityBareJid`	`asEntityBareJidOrThrow()` Convert this Jid to a `EntityBareJid` or throw an `IllegalStateException` if this is not possible.
`EntityFullJid`	`asEntityFullJidIfPossible()` Convert this Jid to a `EntityFullJid` if possible.
`EntityFullJid`	`asEntityFullJidOrThrow()` Convert this Jid to a `EntityFullJid` or throw an `IllegalStateException` if this is not possible.
`EntityJid`	`asEntityJidIfPossible()` Convert this Jid to a `EntityJid` if possible.
`EntityJid`	`asEntityJidOrThrow()` Convert this Jid to a `EntityJid` or throw an `IllegalStateException` if this is not possible.
`FullJid`	`asFullJidIfPossible()` Convert this Jid to a `FullJid` if possible.
`EntityFullJid`	`asFullJidOrThrow()` Convert this Jid to a `FullJid` or throw an `IllegalStateException` if this is not possible.
`String`	`asUnescapedString()` Return the unescaped String representation of this JID.
`<T extends Jid> T`	`downcast(Class<T> jidClass)` Return the downcasted instance of this Jid.
`boolean`	`equals(CharSequence charSequence)` Compares the given CharSequence with this JID.
`boolean`	`equals(String string)` Compares the given String wit this JID.
`Domainpart`	`getDomain()` Get the `Domainpart` of this Jid.
`Localpart`	`getLocalpartOrNull()` Get the localpart of this JID or null.
`Localpart`	`getLocalpartOrThrow()` Get the localpart of this JID or throw an `IllegalStateException`.
`Resourcepart`	`getResourceOrEmpty()` Get the resourcepart of this JID or return the empty resourcepart.
`Resourcepart`	`getResourceOrNull()` Get the resourcepart of this JID or null.
`Resourcepart`	`getResourceOrThrow()` Get the resourcepart of this JID or throw an `IllegalStateException`.
`boolean`	`hasLocalpart()` Check if this is a Jid with a `Localpart`.
`boolean`	`hasNoResource()` Check if this is an instance of `EntityBareJid` or `DomainBareJid`.
`boolean`	`hasResource()` Check if this is a Jid with a `Resourcepart`.
`String`	`intern()` Returns the canonical String representation of this JID.
`boolean`	`isDomainBareJid()` Check if this is an instance of `DomainBareJid`.
`boolean`	`isDomainFullJid()` Check if this is an instance of `DomainFullJid`.
`boolean`	`isEntityBareJid()` Check if this is an instance of `EntityBareJid`.
`boolean`	`isEntityFullJid()` Check if this is an instance of `EntityFullJid`.
`boolean`	`isEntityJid()` Check if this is a `EntityBareJid` or `EntityFullJid`.
`boolean`	`isParentOf(DomainBareJid domainBareJid)` See `isParentOf(Jid)`.
`boolean`	`isParentOf(DomainFullJid domainFullJid)` See `isParentOf(Jid)`.
`boolean`	`isParentOf(EntityBareJid bareJid)` See `isParentOf(Jid)`.
`boolean`	`isParentOf(EntityFullJid fullJid)` See `isParentOf(Jid)`.
`boolean`	`isParentOf(Jid jid)` Check if this JID is the parent of another JID.
`String`	`toString()` Returns the String representation of this JID.

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface java.lang.CharSequence
charAt, chars, codePoints, length, subSequence

- Method Detail
  - getDomain
```
Domainpart getDomain()
```
    Get the Domainpart of this Jid.
    
    Returns:
    
    the domainpart.
  - toString
```
String toString()
```
    Returns the String representation of this JID.
    
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the String representation of this JID.
  - asUnescapedString
```
String asUnescapedString()
```
    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 toString() will return. But asUnescapedString() will return again 'at&t guy@example.com'.
    
    Returns:
    
    the unescaped String representation of this JID.
  - isEntityJid
```
boolean isEntityJid()
```
    Check if this is a EntityBareJid or EntityFullJid.
    
    Returns:
    
    true if this is an instance of BareJid or FullJid.
  - isEntityBareJid
```
boolean isEntityBareJid()
```
    Check if this is an instance of EntityBareJid.
    
    Returns:
    
    true if this is an instance of BareJid
  - isEntityFullJid
```
boolean isEntityFullJid()
```
    Check if this is an instance of EntityFullJid.
    
    Returns:
    
    true if this is an instance of FullJid
  - isDomainBareJid
```
boolean isDomainBareJid()
```
    Check if this is an instance of DomainBareJid.
    
    Returns:
    
    true if this is an instance of DomainBareJid
  - isDomainFullJid
```
boolean isDomainFullJid()
```
    Check if this is an instance of DomainFullJid.
    
    Returns:
    
    true if this is an instance of DomainFullJid
  - hasNoResource
```
boolean hasNoResource()
```
    Check if this is an instance of EntityBareJid or DomainBareJid.
    
    Returns:
    
    true if this is an instance of BareJid or DomainBareJid
  - hasResource
```
boolean hasResource()
```
    Check if this is a Jid with a Resourcepart.
    
    Returns:
    
    true if this Jid has a resourcepart.
  - hasLocalpart
```
boolean hasLocalpart()
```
    Check if this is a Jid with a Localpart.
    
    Returns:
    
    true if this Jid has a localpart.
  - asBareJid
```
BareJid asBareJid()
```
    Return a JID created by removing the Resourcepart from this JID.
    
    Returns:
    
    this Jid without a Resourcepart.
  - asEntityBareJidIfPossible
```
EntityBareJid asEntityBareJidIfPossible()
```
    Convert this Jid to a EntityBareJid if possible.
    
    Returns:
    
    the corresponding EntityBareJid or null.
  - asEntityBareJidOrThrow
```
EntityBareJid asEntityBareJidOrThrow()
```
    Convert this Jid to a EntityBareJid or throw an IllegalStateException if this is not possible.
    
    Returns:
    
    the corresponding EntityBareJid.
  - asEntityFullJidIfPossible
```
EntityFullJid asEntityFullJidIfPossible()
```
    Convert this Jid to a EntityFullJid if possible.
    
    Returns:
    
    the corresponding EntityFullJid or null.
  - asEntityFullJidOrThrow
```
EntityFullJid asEntityFullJidOrThrow()
```
    Convert this Jid to a EntityFullJid or throw an IllegalStateException if this is not possible.
    
    Returns:
    
    the corresponding EntityFullJid.
  - asEntityJidIfPossible
```
EntityJid asEntityJidIfPossible()
```
    Convert this Jid to a EntityJid if possible.
    
    Returns:
    
    the corresponding EntityJid or null.
  - asEntityJidOrThrow
```
EntityJid asEntityJidOrThrow()
```
    Convert this Jid to a EntityJid or throw an IllegalStateException if this is not possible.
    
    Returns:
    
    the corresponding EntityJid.
  - asFullJidIfPossible
```
FullJid asFullJidIfPossible()
```
    Convert this Jid to a FullJid if possible.
    
    Returns:
    
    the corresponding FullJid or null.
  - asFullJidOrThrow
```
EntityFullJid asFullJidOrThrow()
```
    Convert this Jid to a FullJid or throw an IllegalStateException if this is not possible.
    
    Returns:
    
    the corresponding FullJid.
  - asDomainBareJid
```
DomainBareJid asDomainBareJid()
```
    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.
    
    Returns:
    
    the corresponding DomainBareJid.
  - asDomainFullJidIfPossible
```
DomainFullJid asDomainFullJidIfPossible()
```
    Convert this Jid to a DomainFullJid if possible.
    
    Returns:
    
    the corresponding DomainFullJid or null.
  - asDomainFullJidOrThrow
```
DomainFullJid asDomainFullJidOrThrow()
```
    Convert this Jid to a DomainFullJid or throw an IllegalStateException if this is not possible.
    
    Returns:
    
    the corresponding DomainFullJid.
  - getResourceOrNull
```
Resourcepart getResourceOrNull()
```
    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.
    
    Returns:
    
    the resource of this JID or null.
  - getResourceOrEmpty
```
Resourcepart getResourceOrEmpty()
```
    Get the resourcepart of this JID or return the empty resourcepart.
    If the JID is of form <localpart@domain.example/resource> then this method returns 'resource'. If the JID no resourcepart, then Resourcepart.EMPTY is returned.
    
    Returns:
    
    the resource of this JID or the empty resourcepart.
  - getResourceOrThrow
```
Resourcepart getResourceOrThrow()
```
    Get the resourcepart of this JID or throw an IllegalStateException.
    If the JID is of form <localpart@domain.example/resource> then this method returns 'resource'. If the JID no resourcepart, then an IllegalStateException is thrown.
    
    Returns:
    
    the resource of this JID.
  - getLocalpartOrNull
```
Localpart getLocalpartOrNull()
```
    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.
    
    Returns:
    
    the localpart of this JID or null.
  - getLocalpartOrThrow
```
Localpart getLocalpartOrThrow()
```
    Get the localpart of this JID or throw an IllegalStateException.
    If the JID is of form <localpart@domain.example> then this method returns 'localpart'. If the JID has no localpart, then null is returned.
    
    Returns:
    
    the localpart of this JID.
  - isParentOf
```
boolean isParentOf(Jid jid)
```
    Check if this JID is the parent of another JID. The parent of relation is defined, under the precondition that the JID parts (localpart, domainpart and resourcepart) are equal, as follows:
```
 | this JID (parentOf) | other JID           | result |
 |---------------------+---------------------+--------|
 | dom.example         | dom.example         | true   |
 | dom.example         | dom.example/res     | true   |
 | dom.example         | loc@dom.example     | true   |
 | dom.example         | loc@dom.example/res | true   |
 | dom.example/res     | dom.exmple          | false  |
 | dom.example/res     | dom.example/res     | true   |
 | dom.example/res     | loc@dom.example     | false  |
 | dom.example/res     | loc@dom.example/res | false  |
 | loc@dom.example     | dom.example         | false  |
 | loc@dom.example     | dom.example/res     | false  |
 | loc@dom.example     | loc@dom.example     | true   |
 | loc@dom.example     | loc@dom.example/res | true   |
 | loc@dom.example/res | dom.example         | false  |
 | loc@dom.example/res | dom.example/res     | false  |
 | loc@dom.example/res | loc@dom.example     | false  |
 | loc@dom.example/res | loc@dom.example/res | true   |
 
```
    Parameters:
    
    jid - the other JID to compare with
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - isParentOf
```
boolean isParentOf(EntityBareJid bareJid)
```
    See isParentOf(Jid).
    
    Parameters:
    
    bareJid - the bare JID.
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - isParentOf
```
boolean isParentOf(EntityFullJid fullJid)
```
    See isParentOf(Jid).
    
    Parameters:
    
    fullJid - the full JID.
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - isParentOf
```
boolean isParentOf(DomainBareJid domainBareJid)
```
    See isParentOf(Jid).
    
    Parameters:
    
    domainBareJid - the domain bare JID.
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - isParentOf
```
boolean isParentOf(DomainFullJid domainFullJid)
```
    See isParentOf(Jid).
    
    Parameters:
    
    domainFullJid - the domain full JID.
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - downcast
```
<T extends Jid> T downcast(Class<T> jidClass)
                    throws ClassCastException
```
    Return the downcasted instance of this Jid. This method is unsafe, make sure to check that this is actually of the type of are casting to.
    
    Type Parameters:
    
    T - the Jid type to downcast to.
    
    Parameters:
    
    jidClass - the class of JID to downcast too.
    
    Returns:
    
    the downcasted instanced of this
    
    Throws:
    
    ClassCastException - if this JID is not assignable to the type T.
  - equals
```
boolean equals(CharSequence charSequence)
```
    Compares the given CharSequence with this JID. Returns true if equals(charSequence.toString() would return true.
    
    Parameters:
    
    charSequence - the CharSequence to compare this JID with.
    
    Returns:
    
    true if if equals(charSequence.toString() would return true.
    
    See Also:
    
    equals(String)
  - equals
```
boolean equals(String string)
```
    Compares the given String wit this JID.
    Returns true if toString().equals(string), that is if the String representation of this JID matches the given string.
    
    Parameters:
    
    string - the String to compare this JID with.
    
    Returns:
    
    true if toString().equals(string).
  - intern
```
String intern()
```
    Returns the canonical String representation of this JID. See String.intern() for details.
    
    Returns:
    
    the canonical String representation.

Example	Type
`example.org`	`DomainBareJid`
`example.org/resource`	`DomainFullJid`
`user@example.org`	`EntityBareJid`
`user@example.org/resource`	`EntityFullJid`

Interface Jid

Method Summary

Methods inherited from interface java.lang.Comparable

Methods inherited from interface java.lang.CharSequence

Method Detail

getDomain

toString

asUnescapedString

isEntityJid

isEntityBareJid

isEntityFullJid

isDomainBareJid

isDomainFullJid

hasNoResource

hasResource

hasLocalpart

asBareJid

asEntityBareJidIfPossible

asEntityBareJidOrThrow

asEntityFullJidIfPossible

asEntityFullJidOrThrow

asEntityJidIfPossible

asEntityJidOrThrow

asFullJidIfPossible

asFullJidOrThrow

asDomainBareJid

asDomainFullJidIfPossible

asDomainFullJidOrThrow

getResourceOrNull

getResourceOrEmpty

getResourceOrThrow

getLocalpartOrNull

getLocalpartOrThrow

isParentOf

isParentOf

isParentOf

isParentOf

isParentOf

downcast

equals

equals

intern