Jid (Babbler 0.6.0)

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(String) 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.
See Also:

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`).

Constructor Summary

Constructors
Constructor and Description
`Jid(String domain)` Deprecated. Use `ofDomain(String)`
`Jid(String local, String domain)` Deprecated. Use `ofLocalAndDomain(String, String)`
`Jid(String local, String domain, String resource)` Deprecated. Use `of(String, String, String)`}

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Jid`	`asBareJid()` Converts this JID into a bare JID, i.e. removes the resource.
`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(String jid)` Returns a JID from a string.
`static Jid`	`of(String local, String domain, String resource)` Returns a bare JID with a domain and resource part, e.g.
`static Jid`	`ofDomain(String domain)` Returns a bare JID with only the domain part, e.g.
`static Jid`	`ofDomainAndResource(String domain, String resource)` Returns a bare JID with a domain and resource part, e.g.
`static Jid`	`ofEscaped(String jid)` Creates a JID from a escaped JID string.
`static Jid`	`ofLocalAndDomain(String local, String domain)` Returns a bare JID with a local and domain part, e.g.
`CharSequence`	`subSequence(int start, int end)`
`String`	`toEscapedString()` Gets the JID in escaped form as described in XEP-0106: JID Escaping.
`String`	`toString()` Converts the JID into its string representation, i.e. [ localpart "@" ] domainpart [ "/" resourcepart ].
`static Jid`	`valueOf(String jid)` Deprecated. Use `of(String)`
`static Jid`	`valueOf(String jid, boolean doUnescape)` Deprecated. Use `of(String)` or `ofEscaped(String)`}
`Jid`	`withLocal(String local)` Returns a new JID with a new local part and the same domain and resource part of the current JID.
`Jid`	`withResource(String resource)` Returns 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
- Constructor Detail
  - Jid
```
@Deprecated
public Jid(String domain)
```
    Deprecated. Use ofDomain(String)
    
    Creates a bare JID with only the domain part.
    
    Parameters:
    
    domain - The domain.
  - Jid
```
@Deprecated
public Jid(String local,
                       String domain)
```
    Deprecated. Use ofLocalAndDomain(String, String)
    
    Creates a bare JID with only the local and domain part.
    
    Parameters:
    
    local - The local part.
    
    domain - The domain part.
  - Jid
```
@Deprecated
public Jid(String local,
                       String domain,
                       String resource)
```
    Deprecated. Use of(String, String, String)}
    
    Creates a full JID with local, domain and resource part.
    
    Parameters:
    
    local - The local part.
    
    domain - The domain part.
    
    resource - The resource part.
- Method Detail
  - valueOf
```
@Deprecated
public static Jid valueOf(String jid)
```
    Deprecated. Use of(String)
    
    Returns a JID from a string. The format must be
    [ localpart "@" ] domainpart [ "/" resourcepart ]
    . The input string will be escaped.
    
    Parameters:
    
    jid - The JID.
    
    Returns:
    
    The JID.
    
    See Also:
    
    XEP-0106: JID Escaping
  - valueOf
```
@Deprecated
public static Jid valueOf(String jid,
                                      boolean doUnescape)
```
    Deprecated. Use of(String) or ofEscaped(String)}
    
    Creates a JID from a string. The format must be
    [ localpart "@" ] domainpart [ "/" resourcepart ]
    
    Parameters:
    
    jid - The JID.
    
    doUnescape - If the jid parameter will be unescaped.
    
    Returns:
    
    The JID.
    
    See Also:
    
    XEP-0106: JID Escaping
  - of
```
public static Jid of(String local,
                     String domain,
                     String resource)
```
    Returns a bare 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.
  - ofDomain
```
public static Jid ofDomain(String domain)
```
    Returns a bare JID with only the domain part, e.g. capulet.com
    
    Parameters:
    
    domain - The domain.
    
    Returns:
    
    The JID.
  - ofLocalAndDomain
```
public static Jid ofLocalAndDomain(String local,
                                   String domain)
```
    Returns 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.
  - ofDomainAndResource
```
public static Jid ofDomainAndResource(String domain,
                                      String resource)
```
    Returns a bare JID with a domain and resource part, e.g. capulet.com/balcony
    
    Parameters:
    
    domain - The domain.
    
    resource - The resource part.
    
    Returns:
    
    The JID.
  - of
```
public static Jid of(String jid)
```
    Returns a JID from a string. The format must be
    [ localpart "@" ] domainpart [ "/" resourcepart ]
    . The input string will be escaped.
    
    Parameters:
    
    jid - The JID.
    
    Returns:
    
    The JID.
    
    See Also:
    
    XEP-0106: JID Escaping
  - ofEscaped
```
public static Jid ofEscaped(String jid)
```
    Creates a JID from a escaped JID string. The format must be
    [ localpart "@" ] domainpart [ "/" resourcepart ]
    
    Parameters:
    
    jid - The JID.
    
    Returns:
    
    The JID.
    
    See Also:
    
    XEP-0106: JID Escaping
  - isFullJid
```
public 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 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 Jid asBareJid()
```
    Converts this JID into a bare JID, i.e. removes the resource.
    
    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(String)
  - withLocal
```
public Jid withLocal(String local)
```
    Returns 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.
  - withResource
```
public Jid withResource(String resource)
```
    Returns 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.
    
    See Also:
    
    asBareJid()
  - getLocal
```
public String getLocal()
```
    Gets the local part of the JID, also known as the name or node.
    
    2.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 chat room associated with a multi-user chat service). The entity represented by an XMPP localpart is addressed within the context of a specific domain (i.e., <localpart@domainpart>).
    
    Returns:
    
    The local part.
  - getDomain
```
public String getDomain()
```
    Gets the domain part.
    
    2.2. Domainpart
    
    The domainpart of a JID is that portion after the '@' character (if any) and before the '/' character (if any); it is the primary identifier and is the only REQUIRED element of a JID (a mere domainpart is a valid JID).
    
    Returns:
    
    The domain part.
  - getResource
```
public String getResource()
```
    Gets the resource part.
    
    2.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 chat room) belonging to the entity associated with an XMPP localpart at a domain (i.e., <localpart@domainpart/resourcepart>).
    
    Returns:
    
    The resource part.
  - toEscapedString
```
public String toEscapedString()
```
    Gets the JID in escaped form as described in XEP-0106: JID Escaping.
    
    Returns:
    
    The escaped JID.
    
    See Also:
    
    toString()
  - length
```
public int length()
```
    Specified by:
    
    length in interface CharSequence
  - charAt
```
public char charAt(int index)
```
    Specified by:
    
    charAt in interface CharSequence
  - subSequence
```
public CharSequence subSequence(int start,
                                int end)
```
    Specified by:
    
    subSequence in interface CharSequence
  - toString
```
public String toString()
```
    Converts the JID into 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 boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public 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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.CharSequence

Field Detail

ESCAPING_FEATURE

Constructor Detail

Jid

Jid

Jid

Method Detail

valueOf

valueOf

of

ofDomain

ofLocalAndDomain

ofDomainAndResource

of

ofEscaped

isFullJid

isBareJid

asBareJid

withLocal

withResource

getLocal

getDomain

getResource

toEscapedString

length

charAt

subSequence

toString

equals

hashCode

compareTo