org.jxmpp.jid.util

Class JidUtil

java.lang.Object

org.jxmpp.jid.util.JidUtil

public class JidUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JidUtil.NotABareJidStringException

Constructor Summary

Constructors

Constructor and Description
JidUtil()

Method Summary

Modifier and Type	Method and Description
static Set<BareJid>	bareJidSetFrom(Collection<CharSequence> jidStrings)
static void	bareJidsFrom(Collection<CharSequence> jidStrings, Collection<BareJid> output, List<XmppStringprepException> exceptions) Convert a collection of Strings to a Set of BareJid's.
static void	filterBareJid(Collection<? extends Jid> in, Collection<BareJid> out)
static List<BareJid>	filterBareJidList(Collection<? extends Jid> input)
static Set<BareJid>	filterBareJidSet(Collection<? extends Jid> input)
static void	filterDomainBareJid(Collection<? extends Jid> in, Collection<DomainBareJid> out)
static List<DomainBareJid>	filterDomainBareJidList(Collection<? extends Jid> input)
static Set<DomainBareJid>	filterDomainBareJidSet(Collection<? extends Jid> input)
static void	filterDomainFullJid(Collection<? extends Jid> in, Collection<DomainFullJid> out)
static List<DomainFullJid>	filterDomainFullJidList(Collection<? extends Jid> input)
static Set<DomainFullJid>	filterDomainFullJidSet(Collection<? extends Jid> input)
static void	filterFullJid(Collection<? extends Jid> in, Collection<FullJid> out)
static List<FullJid>	filterFullJidList(Collection<? extends Jid> input)
static Set<FullJid>	filterFullJidSet(Collection<? extends Jid> input)
static boolean	isValidBareJid(CharSequence jid) Check if the given CharSequence represents a valid bare JID.
static Set<Jid>	jidSetFrom(Collection<CharSequence> jidStrings)
static void	jidsFrom(Collection<CharSequence> jidStrings, Collection<Jid> output, List<XmppStringprepException> exceptions) Convert a collection of Strings to a Set of Jid's.
static List<String>	toStringList(Collection<? extends Jid> jids)
static void	toStrings(Collection<? extends Jid> jids, Collection<String> jidStrings)
static Set<String>	toStringSet(Collection<? extends Jid> jids)
static BareJid	validateBareJid(CharSequence jidcs) Check if the given CharSequence is a valid bare JID.
static Jid	withoutResource(Jid jid) Safely transform a JID to any JID without a resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

JidUtil

public JidUtil()

Method Detail

withoutResource

public static Jid withoutResource(Jid jid)

Safely transform a JID to any JID without a resource.

Useful for situations where you don't want to put a resource on the wire.

Parameters:

jid -

Returns:

the equivalent JID without resource

isValidBareJid

public static boolean isValidBareJid(CharSequence jid)

Check if the given CharSequence represents a valid bare JID.

This method is meant to validate user input and give fast feedback (e.g. with a red or green light) about if the user entered CharSequence represents a bare JID.

Parameters:

jid -

Returns:

true if @{code jid} represents a valid bare JID, false otherwise

validateBareJid

public static BareJid validateBareJid(CharSequence jidcs)
                               throws JidUtil.NotABareJidStringException,
                                      XmppStringprepException

Check if the given CharSequence is a valid bare JID.

This is a convenience method meant to validate user entered bare JIDs. If the given jid is not a valid bare JID, then this method will throw either JidUtil.NotABareJidStringException or XmppStringprepException. The NotABareJidStringException will contain a meaningful message explaining why the given CharSequence is not a valid bare JID (e.g. "does not contain a '@' character").

Parameters:

jidcs - the JID CharSequence

Returns:

a BareJid instance representing the given JID CharSequence

Throws:

JidUtil.NotABareJidStringException

XmppStringprepException

filterBareJid

public static void filterBareJid(Collection<? extends Jid> in,
                                 Collection<BareJid> out)

filterBareJidSet

public static Set<BareJid> filterBareJidSet(Collection<? extends Jid> input)

filterBareJidList

public static List<BareJid> filterBareJidList(Collection<? extends Jid> input)

filterFullJid

public static void filterFullJid(Collection<? extends Jid> in,
                                 Collection<FullJid> out)

filterFullJidSet

public static Set<FullJid> filterFullJidSet(Collection<? extends Jid> input)

filterFullJidList

public static List<FullJid> filterFullJidList(Collection<? extends Jid> input)

filterDomainBareJid

public static void filterDomainBareJid(Collection<? extends Jid> in,
                                       Collection<DomainBareJid> out)

filterDomainBareJidSet

public static Set<DomainBareJid> filterDomainBareJidSet(Collection<? extends Jid> input)

filterDomainBareJidList

public static List<DomainBareJid> filterDomainBareJidList(Collection<? extends Jid> input)

filterDomainFullJid

public static void filterDomainFullJid(Collection<? extends Jid> in,
                                       Collection<DomainFullJid> out)

filterDomainFullJidSet

public static Set<DomainFullJid> filterDomainFullJidSet(Collection<? extends Jid> input)

filterDomainFullJidList

public static List<DomainFullJid> filterDomainFullJidList(Collection<? extends Jid> input)

bareJidSetFrom

public static Set<BareJid> bareJidSetFrom(Collection<CharSequence> jidStrings)

bareJidsFrom

public static void bareJidsFrom(Collection<CharSequence> jidStrings,
                                Collection<BareJid> output,
                                List<XmppStringprepException> exceptions)

Convert a collection of Strings to a Set of BareJid's.

If the optional argument exceptions is given, then all XmppStringprepException thrown while converting will be added to the list. Otherwise, if an XmppStringprepExceptions is thrown, it will be wrapped in a AssertionError Exception and throw.

Parameters:

jidStrings - the strings that are going to get converted

output - the collection where the BareJid's will be added to

exceptions -

jidSetFrom

public static Set<Jid> jidSetFrom(Collection<CharSequence> jidStrings)

jidsFrom

public static void jidsFrom(Collection<CharSequence> jidStrings,
                            Collection<Jid> output,
                            List<XmppStringprepException> exceptions)

Convert a collection of Strings to a Set of Jid's.

If the optional argument exceptions is given, then all XmppStringprepException thrown while converting will be added to the list. Otherwise, if an XmppStringprepExceptions is thrown, it will be wrapped in a AssertionError Exception and throw.

Parameters:

jidStrings - the strings that are going to get converted

output - the collection where the Jid's will be added to

exceptions -

toStringList

public static List<String> toStringList(Collection<? extends Jid> jids)

toStringSet

public static Set<String> toStringSet(Collection<? extends Jid> jids)

toStrings

public static void toStrings(Collection<? extends Jid> jids,
                             Collection<String> jidStrings)