rocks.xmpp.extensions.privatedata.rosterdelimiter.model

Class RosterDelimiter

java.lang.Object

rocks.xmpp.extensions.privatedata.rosterdelimiter.model.RosterDelimiter

public final class RosterDelimiter
extends java.lang.Object

The implementation of the <roster/> element in the roster:delimiter namespace.

It allows to store a roster group delimiter in the private storage, in order to display nested roster groups.

2. roster:delimiter Namespace

Therefore, the delimiter SHOULD contain multiple characters in order to avoid inconveniencing the user, but single-character delimiters MUST be honored by the client. The exception is if the delimiter is a single alphanumeric character (a-z, A-Z, 0-9); in this case compliant clients MUST treat the situation as if nesting were disabled, to avoid malicious use of this element by setting ‘e’ or ‘m’ or some other common single character as a delimiter.

A compliant client SHOULD ask for the nested delimiter before requesting the user’s roster, in order to know whether or not to parse the roster ‘group’ fields accordingly. If there is no delimiter stored, a client MAY set a delimiter but MUST either prompt the user for a delimiter, or use a user-configurable default.

This class is immutable.

See Also:

XEP-0083: Nested Roster Groups, XML Schema

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE roster:delimiter

Method Summary

Modifier and Type	Method and Description
static RosterDelimiter	empty()
java.lang.String	getRosterDelimiter() Gets the roster delimiter.
static RosterDelimiter	of(java.lang.String rosterDelimiter)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

roster:delimiter

See Also:

Constant Field Values

Method Detail

of

public static RosterDelimiter of(java.lang.String rosterDelimiter)

empty

public static RosterDelimiter empty()

getRosterDelimiter

public final java.lang.String getRosterDelimiter()

Gets the roster delimiter.

Returns:

The roster delimiter.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object