public final class BareJID extends Object implements Comparable<BareJID>
BareJID
class holds a single, bare JID. When the object is created the parameters are
checked and processed through the stringprep. An exception is throw in case of stringprep processing error. The
instances of the class are immutable objects.
BareJID
class.
Modifier and Type | Method and Description |
---|---|
static BareJID |
bareJIDInstance(String jid)
The method creates an instance of the
BareJID class. |
static BareJID |
bareJIDInstance(String p_localpart,
String p_domain)
The method creates an instance of the
BareJID class. |
static BareJID |
bareJIDInstanceNS(String jid)
The method creates an instance of the
BareJID class. |
static BareJID |
bareJIDInstanceNS(String p_localpart,
String p_domain)
The method creates an instance of the
BareJID class. |
int |
compareTo(BareJID o)
Method compares the
BareJID instance to the object given as a parameter. |
boolean |
equals(Object b)
Method compares whether this
BareJID instance represents the same user bare JID as the one given in
parameter. |
String |
getDomain()
Method returns a domain part of the
BareJID . |
String |
getLocalpart()
Method returns a localpart (nickname) of the
BareJID . |
int |
hashCode()
Method returns a hash code calculated for the
BareJID instance. |
static String |
jidToBareJID(String jid)
A utility method to strip the resource part from the given JID string.
|
static String[] |
parseJID(String jid)
A utility method to parse and split the given JID string into separate parts.
|
String |
toString()
Method returns a
String representation of the BareJID instance. |
static String |
toString(BareJID bareJid,
String p_resource)
A utility method to construct a
String representing user JID from given parameters. |
static String |
toString(String p_localpart,
String p_domain)
A utility method to construct a
String representing user JID from given parameters. |
static String |
toString(String p_localpart,
String p_domain,
String p_resource)
A utility method to construct a
String representing user JID from given parameters. |
static void |
useStringprepProcessor(String stringprepProcessor)
Changes stringprep processor implementation used for the JID checking.
|
public static BareJID bareJIDInstance(String jid) throws TigaseStringprepException
BareJID
class. The bare JID is parsed and constructed from the
String
parameter.
jid
- is a String
parameter used to create the bare JID instance.BareJID
class which corresponds to the JID given as the parameter.TigaseStringprepException
- if the stringprep processing fails for any JID part used to create the
instance.public static BareJID bareJIDInstance(String p_localpart, String p_domain) throws TigaseStringprepException
BareJID
class. The bare JID is parsed and constructed from two
String
parameters.
p_localpart
- is a String
parameter assumed to be a JID localpart (nickname) and used to create
the bare JID instance. The localpart parameter can be null.p_domain
- is a String
parameter assumed to be a JID domain part and used to create the bare
JID instance. This parameter must not be null.BareJID
class which corresponds to the JID given as the parameter.TigaseStringprepException
- if the stringprep processing fails for any JID part used to create the
instance.public static BareJID bareJIDInstanceNS(String jid)
BareJID
class. The bare JID is parsed and constructed from the
String
parameter. Note, this method does not perform stringprep processing on input
parameters.
jid
- is a String
parameter used to create the bare JID instance.BareJID
class which corresponds to the JID given as the parameter or
null if passed string/domain was null or effectively empty.public static BareJID bareJIDInstanceNS(String p_localpart, String p_domain)
BareJID
class. The bare JID is parsed and constructed from two
String
parameters. Note, this method does not perform stringprep processing on input
parameters.
p_localpart
- is a String
parameter assumed to be a JID localpart (nickname) and used to create
the bare JID instance. The localpart parameter can be null.p_domain
- is a String
parameter assumed to be a JID domain part and used to create the bare
JID instance. This parameter must not be null.BareJID
class which corresponds to the JID given as the parameter or null if
passed domain was null or effectively empty.public static String jidToBareJID(String jid)
jid
- is a String
representing user full JID.String
instance of the JID wihout resource part.public static String[] parseJID(String jid)
String
array: jid
- is a String
representing user full JID.String
array with parsed JID parts. The array may contain null elements.public static String toString(String p_localpart, String p_domain)
String
representing user JID from given parameters. The method
doesn't perform any checkings and it doesn't run stringprep processing on the given parameter. This is a pure
string manipulation utility method.p_localpart
- is a JID's localpart (nickname)p_domain
- is a JID's domain part.String
representing user's JID build from given parameters. If the localpart is null
then the method simply returns parameter given as domain part.public static String toString(String p_localpart, String p_domain, String p_resource)
String
representing user JID from given parameters. The method
doesn't perform any checkings and it doesn't run stringprep processing on the given parameter. This is a pure
string manipulation utility method.p_localpart
- is a JID's localpart (nickname)p_domain
- is a JID's domain part.p_resource
- is a JID's resource part.String
representing user's JID build from given parameters. If the localpart and
resource part is null then the method simply returns parameter given as domain part.public static String toString(BareJID bareJid, String p_resource)
String
representing user JID from given parameters. The method
doesn't perform any checkings and it doesn't run stringprep processing on the resource parameter.bareJid
- is a BareJID
instance.p_resource
- is a JID's resource part.String
representing user's JID build from given parameters.public static void useStringprepProcessor(String stringprepProcessor)
JID
and BareJID
instances are created using a new
processor.stringprepProcessor
- is a String
value with stringprep processor name or class name
implementing stringprep processing interface.public int compareTo(BareJID o)
BareJID
instance to the object given as a parameter. The method implements the
compareTo
specification contract and returns values as we would expect from the call:
bareJID_1.toString().compareTo(bareJID_2.toString())
compareTo
in interface Comparable<BareJID>
o
- is an BareJID
instance with which the comparision is performed.bareJID_1.toString().compareTo(bareJID_2.toString())
public boolean equals(Object b)
BareJID
instance represents the same user bare JID as the one given in
parameter. It returns true
of both the localpart (nickname) and domain part are the same for both
objects.public String getDomain()
BareJID
. Please note the String
returned is parsed,
checked and processed via stringprep, hence it represents a valid domain name as defined in XMPP RFC.BareJID
instance.public String getLocalpart()
BareJID
. Please note the String
returned
is parsed, checked and processed via stringprep, hence it represents a valid localpart as defined in XMPP RFC.BareJID
instance.public int hashCode()
BareJID
instance.Copyright © 2004–2019 "Tigase, Inc.". All rights reserved.