Jid (jxmpp parent 0.4.2 API)

All Superinterfaces:

CharSequence, Comparable<Jid>

All Known Subinterfaces:

BareJid, DomainBareJid, DomainFullJid, FullJid, JidWithLocalpart, JidWithResource

All Known Implementing Classes:

AbstractJid, DomainAndResourcepartJid, DomainpartJid, LocalAndDomainpartJid, LocalDomainAndResourcepartJid
```
public interface Jid
extends Comparable<Jid>, CharSequence
```
A XMPP JID.
This is the super interface for all JID types. Every JID consists at least of a domainpart. You can retrieve the escaped String with toString() or the unsecaped String of the JID with asUnescapedString().

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`	`asDomainBareJidIfPossible()` Convert this Jid to a DomainBareJid if possible.
`DomainFullJid`	`asDomainFullJidIfPossible()` Convert this Jid to a DomainFullJid if possible.
`FullJid`	`asFullJidIfPossible()` Convert this Jid to a FullJid if possible.
`String`	`asUnescapedString()`
`<T extends Jid> T`	`downcast()` 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.
`String`	`getDomain()`
`String`	`getLocalpartOrNull()` Get the localpart of this JID or null.
`String`	`getResourceOrNull()` Get the resourcepart of this JID or null.
`boolean`	`hasLocalpart()`
`boolean`	`hasNoResource()` Check if this is an instance of `BareJid` or `DomainBareJid`.
`boolean`	`hasResource()`
`boolean`	`isBareJid()` Check if this is an instance of `BareJid`.
`boolean`	`isBareOrFullJid()`
`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.
`String`	`toString()` Returns the escaped 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
```
String getDomain()
```
  - toString
```
String toString()
```
    Returns the escaped String representation of this JID.
    
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the escaped String representation of this JID.
  - asUnescapedString
```
String asUnescapedString()
```
  - isBareOrFullJid
```
boolean isBareOrFullJid()
```
  - 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()
```
  - hasLocalpart
```
boolean hasLocalpart()
```
  - 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.
  - asDomainBareJidIfPossible
```
DomainBareJid asDomainBareJidIfPossible()
```
    Convert this Jid to a DomainBareJid if possible.
    
    Returns:
    
    the corresponding DomainBareJid or null.
  - asDomainFullJidIfPossible
```
DomainFullJid asDomainFullJidIfPossible()
```
    Convert this Jid to a DomainFullJid if possible.
    
    Returns:
    
    the corresponding DomainFullJid or null.
  - getResourceOrNull
```
String getResourceOrNull()
```
    Get the resourcepart of this JID or null.
    If the JID is of form then this method returns 'resource'. If the JID no resourcepart, then null is returned.
    
    Returns:
    
    the resource of this JID or null.
  - getLocalpartOrNull
```
String getLocalpartOrNull()
```
    Get the localpart of this JID or null.
    If the JID is of form then this method returns 'localpart'. If the JID has no localpart, then null is returned.
    
    Returns:
    
    the localpart of this JID or null.
  - 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 -
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - isParentOf
```
boolean isParentOf(FullJid fullJid)
```
    See isParentOf(Jid).
    
    Parameters:
    
    fullJid -
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - isParentOf
```
boolean isParentOf(DomainBareJid domainBareJid)
```
    See isParentOf(Jid).
    
    Parameters:
    
    domainBareJid -
    
    Returns:
    
    true if this JID is a parent of the given JID.
  - isParentOf
```
boolean isParentOf(DomainFullJid domainFullJid)
```
    See isParentOf(Jid).
    
    Parameters:
    
    domainFullJid -
    
    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.
    
    Returns:
    
    the downcasted instanced of this
  - 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).

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

asDomainBareJidIfPossible

asDomainFullJidIfPossible

getResourceOrNull

getLocalpartOrNull

isParentOf

isParentOf

isParentOf

isParentOf

isParentOf

downcast

equals

equals