Jid (jxmpp-jid 0.5.0-alpha3 API)

All Superinterfaces:

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

All Known Subinterfaces:

BareJid, DomainBareJid, DomainFullJid, FullJid, JidWithLocalpart, JidWithResource

All Known Implementing Classes:

AbstractJid, DomainAndResourcepartJid, DomainpartJid, LocalAndDomainpartJid, LocalDomainAndResourcepartJid
```
public interface Jid
extends java.lang.Comparable<Jid>, java.lang.CharSequence, java.io.Serializable
```
An XMPP JID, which acts as globally unique address within the XMPP network. JIDs are created from Strings or CharSequences with the JidCreate utility.
```
 
 Jid jid = JidCreate.from("juliet@capulet.org/balcony");
 BareJid bareJid = JidCreate.from("romeo@montague.net");
 
 
```
This is the super interface for all JID types. Every JID consists at least of a Domainpart. 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`	`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.
`<T extends Jid> T`	`downcast()` Return the downcasted instance of this Jid.
`boolean`	`equals(java.lang.CharSequence charSequence)` Compares the given CharSequence with this JID.
`boolean`	`equals(java.lang.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.
`Resourcepart`	`getResourceOrNull()` Get the resourcepart of this JID or null.
`boolean`	`hasLocalpart()` Check if this is a Jid with a `Localpart`.
`boolean`	`hasNoResource()` Check if this is an instance of `BareJid` or `DomainBareJid`.
`boolean`	`hasResource()` Check if this is a Jid with a `Resourcepart`.
`boolean`	`isBareJid()` Check if this is an instance of `BareJid`.
`boolean`	`isBareOrFullJid()` Check if this is a `BareJid` or `FullJid`.
`boolean`	`isDomainBareJid()` Check if this is an instance of `DomainBareJid`.
`boolean`	`isDomainFullJid()` Check if this is an instance of `DomainFullJid`.
`boolean`	`isFullJid()` Check if this is an instance of `FullJid`.
`boolean`	`isParentOf(BareJid bareJid)` See `isParentOf(Jid)`.
`boolean`	`isParentOf(DomainBareJid domainBareJid)` See `isParentOf(Jid)`.
`boolean`	`isParentOf(DomainFullJid domainFullJid)` See `isParentOf(Jid)`.
`boolean`	`isParentOf(FullJid fullJid)` See `isParentOf(Jid)`.
`boolean`	`isParentOf(Jid jid)` Check if this JID is the parent of another 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 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
```
java.lang.String toString()
```
    Returns the String representation of this JID.
    
    Specified by:
    
    toString in interface java.lang.CharSequence
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the String representation of this JID.
  - asUnescapedString
```
java.lang.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.
  - isBareOrFullJid
```
boolean isBareOrFullJid()
```
    Check if this is a BareJid or FullJid.
    
    Returns:
    
    true if this is an instance of BareJid or FullJid.
  - isBareJid
```
boolean isBareJid()
```
    Check if this is an instance of BareJid.
    
    Returns:
    
    true if this is an instance of BareJid
  - isFullJid
```
boolean isFullJid()
```
    Check if this is an instance of FullJid.
    
    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 BareJid 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.
  - asBareJidIfPossible
```
BareJid asBareJidIfPossible()
```
    Convert this Jid to a BareJid if possible.
    
    Returns:
    
    the corresponding BareJid or null.
  - asFullJidIfPossible
```
FullJid asFullJidIfPossible()
```
    Convert this Jid to a FullJid if possible.
    
    Returns:
    
    the corresponding FullJid or null.
  - asJidWithLocalpartIfPossible
```
JidWithLocalpart asJidWithLocalpartIfPossible()
```
    Convert this Jid to a JidWithLocalpart if possible.
    
    Returns:
    
    the corresponding JidWithLocalpart or null.
  - asJidWithResourcepartIfPossible
```
JidWithResource asJidWithResourcepartIfPossible()
```
    Convert this Jid to a JidWithResource if possible.
    
    Returns:
    
    the corresponding JidWithResourcepart or null.
  - 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.
  - 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.
  - 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.
  - withoutResource
```
Jid withoutResource()
```
    Return a JID created by removing the Resourcepart from this JID.
    
    Returns:
    
    this Jid without a Resourcepart.
  - 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(BareJid bareJid)
```
    See isParentOf(Jid).
    
    Parameters:
    
    bareJid - the bare JID.
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - isParentOf
```
boolean isParentOf(FullJid 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()
```
    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.
    
    Returns:
    
    the downcasted instanced of this
  - equals
```
boolean equals(java.lang.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(java.lang.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).

Interface Jid

Method Summary

Methods inherited from interface java.lang.Comparable

Methods inherited from interface java.lang.CharSequence

Method Detail

getDomain

toString

asUnescapedString

isBareOrFullJid

isBareJid

isFullJid

isDomainBareJid

isDomainFullJid

hasNoResource

hasResource

hasLocalpart

asBareJidIfPossible

asFullJidIfPossible

asJidWithLocalpartIfPossible

asJidWithResourcepartIfPossible

asDomainBareJid

asDomainFullJidIfPossible

getResourceOrNull

getLocalpartOrNull

withoutResource

isParentOf

isParentOf

isParentOf

isParentOf

isParentOf

downcast

equals

equals