org.jxmpp.jid.impl

Class JidCreate

java.lang.Object

org.jxmpp.jid.impl.JidCreate

public class JidCreate
extends java.lang.Object

API to create Jids from Strings and CharSequences.

JIDs created from input received from a XMPP source should use from(String). If the input was user generated, e.g. captured from some sort of user interface, fromUnescaped(String) should be used instead. You can use JidUtil.isValidBareJid(CharSequence) to query, e.g. while the user it entering it, if a given CharSequence is a valid bare JID.

JidCreate uses caches for efficient Jid construction, But it's not guaranteed that the same String or CharSequence will yield the same Jid instance.

Constructor Summary

Constructors

Constructor and Description
JidCreate()

Method Summary

Modifier and Type	Method and Description
static BareJid	bareFrom(java.lang.CharSequence jid) Get a BareJid representing the given CharSequence.
static BareJid	bareFrom(Localpart localpart, DomainBareJid domainBareJid) Get a BareJid constructed from the given Localpart and {link DomainBareJid}.
static BareJid	bareFrom(Localpart localpart, Domainpart domain) Get a BareJid constructed from the given Localpart and Domainpart.
static BareJid	bareFrom(java.lang.String jid) Get a BareJid representing the given String.
static DomainBareJid	domainBareFrom(java.lang.CharSequence jid) Get a domain bare JID.
static DomainBareJid	domainBareFrom(Domainpart domainpart) Get a DomainBareJid consisting of the given Domainpart.
static DomainBareJid	domainBareFrom(java.lang.String jid) Get a domain bare JID.
static DomainFullJid	domainFullFrom(java.lang.CharSequence jid) Get a domain full JID from the given CharSequence.
static DomainFullJid	domainFullFrom(DomainBareJid domainBareJid, Resourcepart resource) Get a domain full JID.
static DomainFullJid	domainFullFrom(Domainpart domainpart, Resourcepart resource) Get a domain full JID.
static DomainFullJid	domainFullFrom(java.lang.String jid) Get a domain full JID from the given String.
static DomainFullJid	donmainFullFrom(java.lang.String jid) Deprecated. use domainFullFrom(String) instead.
static Jid	from(java.lang.CharSequence jid) Get a Jid from a CharSequence.
static Jid	from(java.lang.CharSequence localpart, java.lang.CharSequence domainpart, java.lang.CharSequence resource) Get a Jid from the given parts.
static Jid	from(java.lang.String jidString) Get a Jid from the given String.
static Jid	from(java.lang.String localpart, java.lang.String domainpart, java.lang.String resource) Get a Jid from the given parts.
static Jid	fromUnescaped(java.lang.CharSequence unescapedJid) Get a Jid from the given unescaped CharSequence.
static Jid	fromUnescaped(java.lang.String unescapedJidString) Get a Jid from the given unescaped String.
static FullJid	fullFrom(BareJid bareJid, Resourcepart resource) Get a FullJid constructed from a BareJid and a Resourcepart.
static FullJid	fullFrom(java.lang.CharSequence jid) Get a FullJid representing the given CharSequence.
static FullJid	fullFrom(Localpart localpart, DomainBareJid domainBareJid, Resourcepart resource) Get a FullJid constructed from the given parts.
static FullJid	fullFrom(Localpart localpart, Domainpart domainpart, Resourcepart resource) Get a FullJid constructed from the given parts.
static FullJid	fullFrom(java.lang.String jid) Get a FullJid representing the given String.
static FullJid	fullFrom(java.lang.String localpart, java.lang.String domainpart, java.lang.String resource) Get a FullJid constructed from the given parts.
static DomainBareJid	serverBareFrom(java.lang.String jid) Deprecated. use domainBareFrom(String) instead
static DomainFullJid	serverFullFrom(java.lang.String jid) Deprecated. use domainFullFrom(String) instead

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JidCreate

public JidCreate()

Method Detail

from

public static Jid from(java.lang.CharSequence localpart,
                       java.lang.CharSequence domainpart,
                       java.lang.CharSequence resource)
                throws org.jxmpp.stringprep.XmppStringprepException

Get a Jid from the given parts.

Only the domainpart is required.

Parameters:

localpart - a optional localpart.

domainpart - a required domainpart.

resource - a optional resourcepart.

Returns:

a JID which consists of the given parts.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

from

public static Jid from(java.lang.String localpart,
                       java.lang.String domainpart,
                       java.lang.String resource)
                throws org.jxmpp.stringprep.XmppStringprepException

Get a Jid from the given parts.

Only the domainpart is required.

Parameters:

localpart - a optional localpart.

domainpart - a required domainpart.

resource - a optional resourcepart.

Returns:

a JID which consists of the given parts.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

from

public static Jid from(java.lang.CharSequence jid)
                throws org.jxmpp.stringprep.XmppStringprepException

Get a Jid from a CharSequence.

Parameters:

jid - the input CharSequence.

Returns:

the Jid represented by the input CharSequence.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

See Also:

from(String)

from

public static Jid from(java.lang.String jidString)
                throws org.jxmpp.stringprep.XmppStringprepException

Get a Jid from the given String.

Parameters:

jidString - the input String.

Returns:

the Jid represented by the input String.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

See Also:

from(CharSequence)

fromUnescaped

public static Jid fromUnescaped(java.lang.CharSequence unescapedJid)
                         throws org.jxmpp.stringprep.XmppStringprepException

Get a Jid from the given unescaped CharSequence.

Parameters:

unescapedJid - an unescaped CharSequence representing a JID.

Returns:

a JID.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

fromUnescaped

public static Jid fromUnescaped(java.lang.String unescapedJidString)
                         throws org.jxmpp.stringprep.XmppStringprepException

Get a Jid from the given unescaped String.

Parameters:

unescapedJidString - a unescaped String representing a JID.

Returns:

a JID.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

bareFrom

public static BareJid bareFrom(java.lang.CharSequence jid)
                        throws org.jxmpp.stringprep.XmppStringprepException

Get a BareJid representing the given CharSequence.

Parameters:

jid - the input CharSequence.

Returns:

a bare JID representing the given CharSequence.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

bareFrom

public static BareJid bareFrom(java.lang.String jid)
                        throws org.jxmpp.stringprep.XmppStringprepException

Get a BareJid representing the given String.

Parameters:

jid - the input String.

Returns:

a bare JID representing the given String.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

bareFrom

public static BareJid bareFrom(Localpart localpart,
                               DomainBareJid domainBareJid)

Get a BareJid constructed from the given Localpart and {link DomainBareJid}.

Parameters:

localpart - a localpart.

domainBareJid - a domain bare JID.

Returns:

a bare JID.

bareFrom

public static BareJid bareFrom(Localpart localpart,
                               Domainpart domain)

Get a BareJid constructed from the given Localpart and Domainpart.

Parameters:

localpart - a localpart.

domain - a domainpart.

Returns:

a bare JID constructed from the given parts.

fullFrom

public static FullJid fullFrom(java.lang.CharSequence jid)
                        throws org.jxmpp.stringprep.XmppStringprepException

Get a FullJid representing the given CharSequence.

Parameters:

jid - a CharSequence representing a JID.

Returns:

a full JID representing the given CharSequence.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

fullFrom

public static FullJid fullFrom(java.lang.String jid)
                        throws org.jxmpp.stringprep.XmppStringprepException

Get a FullJid representing the given String.

Parameters:

jid - the JID's String.

Returns:

a full JID representing the input String.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

fullFrom

public static FullJid fullFrom(java.lang.String localpart,
                               java.lang.String domainpart,
                               java.lang.String resource)
                        throws org.jxmpp.stringprep.XmppStringprepException

Get a FullJid constructed from the given parts.

Parameters:

localpart - a localpart.

domainpart - a domainpart.

resource - a resourcepart.

Returns:

a full JID.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

fullFrom

public static FullJid fullFrom(Localpart localpart,
                               DomainBareJid domainBareJid,
                               Resourcepart resource)

Get a FullJid constructed from the given parts.

Parameters:

localpart - a localpart.

domainBareJid - a domain bare JID..

resource - a resourcepart

Returns:

a full JID.

fullFrom

public static FullJid fullFrom(Localpart localpart,
                               Domainpart domainpart,
                               Resourcepart resource)

Get a FullJid constructed from the given parts.

Parameters:

localpart - the localpart.

domainpart - the domainpart.

resource - the resourcepart.

Returns:

a full JID.

fullFrom

public static FullJid fullFrom(BareJid bareJid,
                               Resourcepart resource)

Get a FullJid constructed from a BareJid and a Resourcepart.

Parameters:

bareJid - a bare JID.

resource - a resourcepart.

Returns:

a full JID.

serverBareFrom

@Deprecated
public static DomainBareJid serverBareFrom(java.lang.String jid)
                                                throws org.jxmpp.stringprep.XmppStringprepException

Deprecated. use domainBareFrom(String) instead

Deprecated.

Parameters:

jid - the JID.

Returns:

a DopmainBareJid

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error happens.

domainBareFrom

public static DomainBareJid domainBareFrom(java.lang.CharSequence jid)
                                    throws org.jxmpp.stringprep.XmppStringprepException

Get a domain bare JID.

Parameters:

jid - the JID CharSequence.

Returns:

a domain bare JID.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

domainBareFrom

public static DomainBareJid domainBareFrom(java.lang.String jid)
                                    throws org.jxmpp.stringprep.XmppStringprepException

Get a domain bare JID.

Parameters:

jid - the JID String.

Returns:

a domain bare JID.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error occurs.

domainBareFrom

public static DomainBareJid domainBareFrom(Domainpart domainpart)

Get a DomainBareJid consisting of the given Domainpart.

Parameters:

domainpart - the domainpart.

Returns:

a domain bare JID.

serverFullFrom

@Deprecated
public static DomainFullJid serverFullFrom(java.lang.String jid)
                                                throws org.jxmpp.stringprep.XmppStringprepException

Deprecated. use domainFullFrom(String) instead

Deprecated.

Parameters:

jid - the JID.

Returns:

a DomainFullJid

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error happens.

donmainFullFrom

@Deprecated
public static DomainFullJid donmainFullFrom(java.lang.String jid)
                                                 throws org.jxmpp.stringprep.XmppStringprepException

Deprecated. use domainFullFrom(String) instead.

Get a domain full JID from the given String.

Parameters:

jid - the JID.

Returns:

a DomainFullJid.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error happens.

domainFullFrom

public static DomainFullJid domainFullFrom(java.lang.CharSequence jid)
                                    throws org.jxmpp.stringprep.XmppStringprepException

Get a domain full JID from the given CharSequence.

Parameters:

jid - the JID.

Returns:

a domain full JID.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error happens.

domainFullFrom

public static DomainFullJid domainFullFrom(java.lang.String jid)
                                    throws org.jxmpp.stringprep.XmppStringprepException

Get a domain full JID from the given String.

Parameters:

jid - the JID.

Returns:

a DomainFullJid.

Throws:

org.jxmpp.stringprep.XmppStringprepException - if an error happens.

domainFullFrom

public static DomainFullJid domainFullFrom(Domainpart domainpart,
                                           Resourcepart resource)

Get a domain full JID.

Parameters:

domainpart - the domainpart.

resource - the resourcepart.

Returns:

a domain full JID.

domainFullFrom

public static DomainFullJid domainFullFrom(DomainBareJid domainBareJid,
                                           Resourcepart resource)

Get a domain full JID.

Parameters:

domainBareJid - a domain bare JID.

resource - a resourcepart.

Returns:

a domain full JID.