org.jivesoftware.smackx.pubsub

Class Affiliation

java.lang.Object

org.jivesoftware.smackx.pubsub.Affiliation

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class Affiliation
extends Object
implements ExtensionElement

Represents a affiliation between a user and a node, where the Affiliation.Type defines the type of affiliation. Affiliations are retrieved from the PubSubManager.getAffiliations() method, which gets affiliations for the calling user, based on the identity that is associated with the XMPPConnection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Affiliation.AffiliationNamespace
static class	Affiliation.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
Affiliation(org.jxmpp.jid.BareJid jid, Affiliation.Type affiliation) Construct a affiliation modification request.
Affiliation(org.jxmpp.jid.BareJid jid, Affiliation.Type affiliation, Affiliation.AffiliationNamespace namespace)
Affiliation(String node, Affiliation.Type affiliation) Constructs an affiliation.
Affiliation(String node, Affiliation.Type affiliation, Affiliation.AffiliationNamespace namespace) Constructs an affiliation.

Method Summary

Modifier and Type	Method and Description
Affiliation.Type	getAffiliation()
String	getElementName() Returns the root element name.
org.jxmpp.jid.BareJid	getJid()
String	getNamespace() Returns the root element XML namespace.
String	getNode()
String	getNodeId() Deprecated. use getNode() instead.
PubSubNamespace	getPubSubNamespace()
Affiliation.Type	getType() Deprecated. use getAffiliation() instead.
boolean	isAffiliationModification() Check if this is an affiliation element to modify affiliations on a node.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

Affiliation

public Affiliation(String node,
                   Affiliation.Type affiliation)

Constructs an affiliation.

Parameters:

node - The node the user is affiliated with.

affiliation - the optional affiliation.

Affiliation

public Affiliation(String node,
                   Affiliation.Type affiliation,
                   Affiliation.AffiliationNamespace namespace)

Constructs an affiliation.

Parameters:

node - The node the user is affiliated with.

affiliation - the optional affiliation.

namespace - the affiliation's namespace.

Affiliation

public Affiliation(org.jxmpp.jid.BareJid jid,
                   Affiliation.Type affiliation)

Construct a affiliation modification request.

Parameters:

jid -

affiliation -

Affiliation

public Affiliation(org.jxmpp.jid.BareJid jid,
                   Affiliation.Type affiliation,
                   Affiliation.AffiliationNamespace namespace)

Method Detail

getNodeId

@Deprecated
public String getNodeId()

Deprecated. use getNode() instead.

Get the node.

Returns:

the node.

getNode

public String getNode()

getType

@Deprecated
public Affiliation.Type getType()

Deprecated. use getAffiliation() instead.

Get the type.

Returns:

the type.

getAffiliation

public Affiliation.Type getAffiliation()

getJid

public org.jxmpp.jid.BareJid getJid()

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

getPubSubNamespace

public PubSubNamespace getPubSubNamespace()

isAffiliationModification

public boolean isAffiliationModification()

Check if this is an affiliation element to modify affiliations on a node.

Returns:

true if this is an affiliation element to modify affiliations on a node, false otherwise.

Since:

4.2

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.