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 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.

Author:

Robin Collier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Affiliation.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected String	node
protected Affiliation.Type	type

Constructor Summary

Constructors

Constructor and Description
Affiliation(String nodeId, Affiliation.Type affiliation) Constructs an affiliation.

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
String	getNamespace() Returns the root element XML namespace.
String	getNodeId()
Affiliation.Type	getType()
String	toXML() 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

node

protected String node

type

protected Affiliation.Type type

Constructor Detail

Affiliation

public Affiliation(String nodeId,
                   Affiliation.Type affiliation)

Constructs an affiliation.

Parameters:

nodeId - The node the user is affiliated with.

affiliation - The type of affiliation.

Method Detail

getNodeId

public String getNodeId()

getType

public Affiliation.Type getType()

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.

toXML

public String toXML()

Description copied from interface: Element

Returns the XML representation of this Element.

Specified by:

toXML in interface Element

Returns:

the stanza(/packet) extension as XML.