org.jivesoftware.smackx.jiveproperties.packet

Class JivePropertiesExtension

java.lang.Object

org.jivesoftware.smackx.jiveproperties.packet.JivePropertiesExtension

All Implemented Interfaces:

PacketExtension

public class JivePropertiesExtension
extends java.lang.Object
implements PacketExtension

Properties provide an easy mechanism for clients to share data. Each property has a String name, and a value that is a Java primitive (int, long, float, double, boolean) or any Serializable object (a Java object is Serializable when it implements the Serializable interface).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ELEMENT
static java.lang.String	NAMESPACE Namespace used to store packet properties.

Constructor Summary

Constructors

Constructor and Description
JivePropertiesExtension()
JivePropertiesExtension(java.util.Map<java.lang.String,java.lang.Object> properties)

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteProperty(java.lang.String name) Deletes a property.
java.lang.String	getElementName() Returns the root element name.
java.lang.String	getNamespace() Returns the root element XML namespace.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Returns an unmodifiable map of all properties.
java.lang.Object	getProperty(java.lang.String name) Returns the packet property with the specified name or null if the property doesn't exist.
java.util.Collection<java.lang.String>	getPropertyNames() Returns an unmodifiable collection of all the property names that are set.
void	setProperty(java.lang.String name, java.lang.Object value) Sets a property with an Object as the value.
java.lang.CharSequence	toXML() Returns the XML representation of the PacketExtension.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final java.lang.String NAMESPACE

Namespace used to store packet properties.

See Also:

Constant Field Values

ELEMENT

public static final java.lang.String ELEMENT

See Also:

Constant Field Values

Constructor Detail

JivePropertiesExtension

public JivePropertiesExtension()

JivePropertiesExtension

public JivePropertiesExtension(java.util.Map<java.lang.String,java.lang.Object> properties)

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String name)

Returns the packet property with the specified name or null if the property doesn't exist. Property values that were originally primitives will be returned as their object equivalent. For example, an int property will be returned as an Integer, a double as a Double, etc.

Parameters:

name - the name of the property.

Returns:

the property, or null if the property doesn't exist.

setProperty

public void setProperty(java.lang.String name,
               java.lang.Object value)

Sets a property with an Object as the value. The value must be Serializable or an IllegalArgumentException will be thrown.

Parameters:

name - the name of the property.

value - the value of the property.

deleteProperty

public void deleteProperty(java.lang.String name)

Deletes a property.

Parameters:

name - the name of the property to delete.

getPropertyNames

public java.util.Collection<java.lang.String> getPropertyNames()

Returns an unmodifiable collection of all the property names that are set.

Returns:

all property names.

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Returns an unmodifiable map of all properties.

Returns:

all properties.

getElementName

public java.lang.String getElementName()

Description copied from interface: PacketExtension

Returns the root element name.

Specified by:

getElementName in interface PacketExtension

Returns:

the element name.

getNamespace

public java.lang.String getNamespace()

Description copied from interface: PacketExtension

Returns the root element XML namespace.

Specified by:

getNamespace in interface PacketExtension

Returns:

the namespace.

toXML

public java.lang.CharSequence toXML()

Description copied from interface: PacketExtension

Returns the XML representation of the PacketExtension.

Specified by:

toXML in interface PacketExtension

Returns:

the packet extension as XML.