rocks.xmpp.extensions.privacy.model

Class Privacy

java.lang.Object

rocks.xmpp.extensions.privacy.model.Privacy

public final class Privacy
extends java.lang.Object

The implementation of the the <query/> element in the jabber:iq:privacy namespace.

This class contains information about the active and default list and holds the privacy lists.

This class is immutable.

See Also:

XEP-0016: Privacy Lists, XML Schema

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE jabber:iq:privacy

Constructor Summary

Constructors

Constructor and Description
Privacy() Creates an empty privacy element.
Privacy(PrivacyList... privacyLists) Creates a privacy element with one or more privacy lists.
Privacy(java.lang.String activeName, java.lang.String defaultName, java.util.Collection<PrivacyList> privacyLists) Creates a privacy element with one or more privacy lists and an active and default name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActiveName() Gets the active list name.
java.lang.String	getDefaultName() Sets the default list name.
java.util.List<PrivacyList>	getPrivacyLists() Gets the privacy lists.
java.lang.String	toString()
static Privacy	withActive(java.lang.String active) Creates a privacy element with an active list.
static Privacy	withDefault(java.lang.String defaultName) Creates a privacy element with a default list.

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

jabber:iq:privacy

See Also:

Constant Field Values

Constructor Detail

Privacy

public Privacy()

Creates an empty privacy element.

Privacy

public Privacy(PrivacyList... privacyLists)

Creates a privacy element with one or more privacy lists.

Parameters:

privacyLists - The privacy list(s).

Privacy

public Privacy(java.lang.String activeName,
               java.lang.String defaultName,
               java.util.Collection<PrivacyList> privacyLists)

Creates a privacy element with one or more privacy lists and an active and default name.

Parameters:

activeName - The active name.

defaultName - The default name.

privacyLists - The privacy list(s).

Method Detail

withActive

public static Privacy withActive(java.lang.String active)

Creates a privacy element with an active list.

Parameters:

active - The active list name. Pass an empty string if you want to decline the use of an active list.

Returns:

The privacy element.

withDefault

public static Privacy withDefault(java.lang.String defaultName)

Creates a privacy element with a default list.

Parameters:

defaultName - The default list name. Pass an empty string if you want to decline the use of a default list.

Returns:

The privacy element.

getActiveName

public final java.lang.String getActiveName()

Gets the active list name.

Returns:

The active list name.

getDefaultName

public final java.lang.String getDefaultName()

Sets the default list name.

Returns:

The default list name.

getPrivacyLists

public final java.util.List<PrivacyList> getPrivacyLists()

Gets the privacy lists.

Returns:

The privacy lists.

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object