Jid (Babbler 0.7.0-beta-1)

java.lang.Object
- rocks.xmpp.addr.Jid

All Implemented Interfaces:

Serializable, CharSequence, Comparable<Jid>
```
public final class Jid
extends Object
implements Comparable<Jid>, Serializable, CharSequence
```
The implementation of the JID as described in Extensible Messaging and Presence Protocol (XMPP): Address Format.
A JID consists of three parts:
[ localpart "@" ] domainpart [ "/" resourcepart ]
The easiest way to create a JID is to use the of(CharSequence) method:
```
 Jid jid = Jid.of("juliet@capulet.lit/balcony");
 
```
You can then get the parts from it via the respective methods:
```
 String local = jid.getLocal(); // juliet
 String domain = jid.getDomain(); // capulet.lit
 String resource = jid.getResource(); // balcony
 
```
This class overrides equals() and hashCode(), so that different instances with the same value are equal:
```
 Jid.of("romeo@capulet.lit/balcony").equals(Jid.of("romeo@capulet.lit/balcony")); // true
 
```
This class also supports XEP-0106: JID Escaping, i.e.
```
 Jid.of("d'artagnan@musketeers.lit")
 
```
is escaped as d\\27artagnan@musketeers.lit.
This class is thread-safe and immutable.
See Also:

RFC 7622 - Extensible Messaging and Presence Protocol (XMPP): Address Format, Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String ESCAPING_FEATURE
The service discovery feature used for determining support of JID escaping (jid\20escaping).

Fields
Modifier and Type	Field and Description
`static String`	`ESCAPING_FEATURE` The service discovery feature used for determining support of JID escaping (`jid\20escaping`).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Jid`	`asBareJid()` Converts this JID into a bare JID, i.e. removes the resource part.
`Jid`	`atSubdomain(CharSequence subdomain)` Creates a new JID at a subdomain and at the same domain as this JID.
`char`	`charAt(int index)`
`int`	`compareTo(Jid o)` Compares this JID with another JID.
`boolean`	`equals(Object o)`
`String`	`getDomain()` Gets the domain part.
`String`	`getLocal()` Gets the local part of the JID, also known as the name or node.
`String`	`getResource()` Gets the resource part.
`int`	`hashCode()`
`boolean`	`isBareJid()` Checks if the JID is a bare JID.
`boolean`	`isFullJid()` Checks if the JID is a full JID.
`int`	`length()`
`static Jid`	`of(CharSequence jid)` Creates a JID from an unescaped string.
`static Jid`	`of(CharSequence local, CharSequence domain, CharSequence resource)` Returns a full JID with a domain and resource part, e.g.
`static Jid`	`ofDomain(CharSequence domain)` Creates a bare JID with only the domain part, e.g.
`static Jid`	`ofDomainAndResource(CharSequence domain, CharSequence resource)` Creates a full JID with a domain and resource part, e.g.
`static Jid`	`ofEscaped(CharSequence jid)` Creates a JID from a escaped JID string.
`static Jid`	`ofLocalAndDomain(CharSequence local, CharSequence domain)` Creates a bare JID with a local and domain part, e.g.
`CharSequence`	`subSequence(int start, int end)`
`String`	`toEscapedString()` Returns the JID in escaped form as described in XEP-0106: JID Escaping.
`String`	`toString()` Returns the JID in its string representation, i.e. [ localpart "@" ] domainpart [ "/" resourcepart ].
`Jid`	`withLocal(CharSequence local)` Creates a new JID with a new local part and the same domain and resource part of the current JID.
`Jid`	`withResource(CharSequence resource)` Creates a new full JID with a resource and the same local and domain part of the current JID.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.CharSequence
chars, codePoints

- Field Detail
  - ESCAPING_FEATURE
```
public static final String ESCAPING_FEATURE
```
    The service discovery feature used for determining support of JID escaping (jid\20escaping).
    
    See Also:
    
    Constant Field Values
- Method Detail
  - of
```
public static Jid of(CharSequence local,
                     CharSequence domain,
                     CharSequence resource)
```
    Returns a full JID with a domain and resource part, e.g. capulet.com/balcony
    
    Parameters:
    
    local - The local part.
    
    domain - The domain.
    
    resource - The resource part.
    
    Returns:
    
    The JID.
    
    Throws:
    
    NullPointerException - If the domain is null.
    
    IllegalArgumentException - If the domain, local or resource part are not valid.
  - ofDomain
```
public static Jid ofDomain(CharSequence domain)
```
    Creates a bare JID with only the domain part, e.g. capulet.com
    
    Parameters:
    
    domain - The domain.
    
    Returns:
    
    The JID.
    
    Throws:
    
    NullPointerException - If the domain is null.
    
    IllegalArgumentException - If the domain or local part are not valid.
  - ofLocalAndDomain
```
public static Jid ofLocalAndDomain(CharSequence local,
                                   CharSequence domain)
```
    Creates a bare JID with a local and domain part, e.g. juliet@capulet.com
    
    Parameters:
    
    local - The local part.
    
    domain - The domain.
    
    Returns:
    
    The JID.
    
    Throws:
    
    NullPointerException - If the domain is null.
    
    IllegalArgumentException - If the domain or local part are not valid.
  - ofDomainAndResource
```
public static Jid ofDomainAndResource(CharSequence domain,
                                      CharSequence resource)
```
    Creates a full JID with a domain and resource part, e.g. capulet.com/balcony
    
    Parameters:
    
    domain - The domain.
    
    resource - The resource part.
    
    Returns:
    
    The JID.
    
    Throws:
    
    NullPointerException - If the domain is null.
    
    IllegalArgumentException - If the domain or resource are not valid.
  - of
```
public static Jid of(CharSequence jid)
```
    Creates a JID from an unescaped string. The format must be
    [ localpart "@" ] domainpart [ "/" resourcepart ]
    The input string will be escaped.
    
    Parameters:
    
    jid - The JID.
    
    Returns:
    
    The JID.
    
    Throws:
    
    NullPointerException - If the jid is null.
    
    IllegalArgumentException - If the jid could not be parsed or is not valid.
    
    See Also:
    
    XEP-0106: JID Escaping
  - ofEscaped
```
public static Jid ofEscaped(CharSequence jid)
```
    Creates a JID from a escaped JID string. The format must be
    [ localpart "@" ] domainpart [ "/" resourcepart ]
    
    Parameters:
    
    jid - The JID.
    
    Returns:
    
    The JID.
    
    Throws:
    
    NullPointerException - If the jid is null.
    
    IllegalArgumentException - If the jid could not be parsed or is not valid.
    
    See Also:
    
    XEP-0106: JID Escaping
  - isFullJid
```
public final boolean isFullJid()
```
    Checks if the JID is a full JID.
    
    The term "full JID" refers to an XMPP address of the form <localpart@domainpart/resourcepart> (for a particular authorized client or device associated with an account) or of the form <domainpart/resourcepart> (for a particular resource or script associated with a server).
    
    Returns:
    
    True, if the JID is a full JID; otherwise false.
  - isBareJid
```
public final boolean isBareJid()
```
    Checks if the JID is a bare JID.
    
    The term "bare JID" refers to an XMPP address of the form <localpart@domainpart> (for an account at a server) or of the form <domainpart> (for a server).
    
    Returns:
    
    True, if the JID is a bare JID; otherwise false.
  - asBareJid
```
public final Jid asBareJid()
```
    Converts this JID into a bare JID, i.e. removes the resource part.
    
    The term "bare JID" refers to an XMPP address of the form <localpart@domainpart> (for an account at a server) or of the form <domainpart> (for a server).
    
    Returns:
    
    The bare JID.
    
    See Also:
    
    withResource(CharSequence)
  - withLocal
```
public final Jid withLocal(CharSequence local)
```
    Creates a new JID with a new local part and the same domain and resource part of the current JID.
    
    Parameters:
    
    local - The local part.
    
    Returns:
    
    The JID with a new local part.
    
    Throws:
    
    IllegalArgumentException - If the local is not a valid local part.
    
    See Also:
    
    withResource(CharSequence)
  - withResource
```
public final Jid withResource(CharSequence resource)
```
    Creates a new full JID with a resource and the same local and domain part of the current JID.
    
    Parameters:
    
    resource - The resource.
    
    Returns:
    
    The full JID with a resource.
    
    Throws:
    
    IllegalArgumentException - If the resource is not a valid resource part.
    
    See Also:
    
    asBareJid(), withLocal(CharSequence)
  - atSubdomain
```
public final Jid atSubdomain(CharSequence subdomain)
```
    Creates a new JID at a subdomain and at the same domain as this JID.
    
    Parameters:
    
    subdomain - The subdomain.
    
    Returns:
    
    The JID at a subdomain.
    
    Throws:
    
    NullPointerException - If subdomain is null.
    
    IllegalArgumentException - If subdomain is not a valid subdomain name.
  - getLocal
```
public final String getLocal()
```
    Gets the local part of the JID, also known as the name or node.
    
    3.3. Localpart
    
    The localpart of a JID is an optional identifier placed before the domainpart and separated from the latter by the '@' character. Typically, a localpart uniquely identifies the entity requesting and using network access provided by a server (i.e., a local account), although it can also represent other kinds of entities (e.g., a chatroom associated with a multi-user chat service [XEP-0045]). The entity represented by an XMPP localpart is addressed within the context of a specific domain (i.e., <localpart@domainpart>).
    
    Returns:
    
    The local part or null.
  - getDomain
```
public final String getDomain()
```
    Gets the domain part.
    
    3.2. Domainpart
    
    The domainpart is the primary identifier and is the only REQUIRED element of a JID (a mere domainpart is a valid JID). Typically, a domainpart identifies the "home" server to which clients connect for XML routing and data management functionality.
    
    Returns:
    
    The domain part.
  - getResource
```
public final String getResource()
```
    Gets the resource part.
    
    3.4. Resourcepart
    
    The resourcepart of a JID is an optional identifier placed after the domainpart and separated from the latter by the '/' character. A resourcepart can modify either a <localpart@domainpart> address or a mere <domainpart> address. Typically, a resourcepart uniquely identifies a specific connection (e.g., a device or location) or object (e.g., an occupant in a multi-user chatroom [XEP-0045]) belonging to the entity associated with an XMPP localpart at a domain (i.e., <localpart@domainpart/resourcepart>).
    
    Returns:
    
    The resource part or null.
  - toEscapedString
```
public final String toEscapedString()
```
    Returns the JID in escaped form as described in XEP-0106: JID Escaping.
    
    Returns:
    
    The escaped JID.
    
    See Also:
    
    toString()
  - length
```
public final int length()
```
    Specified by:
    
    length in interface CharSequence
  - charAt
```
public final char charAt(int index)
```
    Specified by:
    
    charAt in interface CharSequence
  - subSequence
```
public final CharSequence subSequence(int start,
                                      int end)
```
    Specified by:
    
    subSequence in interface CharSequence
  - toString
```
public final String toString()
```
    Returns the JID in its string representation, i.e. [ localpart "@" ] domainpart [ "/" resourcepart ].
    
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    The JID.
    
    See Also:
    
    toEscapedString()
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public final int compareTo(Jid o)
```
    Compares this JID with another JID. First domain parts are compared. If these are equal, local parts are compared and if these are equal, too, resource parts are compared.
    
    Specified by:
    
    compareTo in interface Comparable<Jid>
    
    Parameters:
    
    o - The other JID.
    
    Returns:
    
    The comparison result.

Class Jid

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.CharSequence

Field Detail

ESCAPING_FEATURE

Method Detail

of

ofDomain

ofLocalAndDomain

ofDomainAndResource

of

ofEscaped

isFullJid

isBareJid

asBareJid

withLocal

withResource

atSubdomain

getLocal

getDomain

getResource

toEscapedString

length

charAt

subSequence

toString

equals

hashCode

compareTo