rocks.xmpp.extensions.privatedata.rosterdelimiter.model

Class RosterDelimiter

java.lang.Object

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

public final class RosterDelimiter
extends 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.

Author:

Christian Schudt

See Also:

XEP-0083: Nested Roster Groups, XML Schema

Constructor Summary

Constructors

Constructor and Description
RosterDelimiter()
RosterDelimiter(String rosterDelimiter)

Method Summary

Modifier and Type	Method and Description
String	getRosterDelimiter()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RosterDelimiter

public RosterDelimiter()

RosterDelimiter

public RosterDelimiter(String rosterDelimiter)

Method Detail

getRosterDelimiter

public String getRosterDelimiter()

toString

public String toString()

Overrides:

toString in class Object