Smack

org.jivesoftware.smackx.packet
Class Nick

java.lang.Object
  extended by org.jivesoftware.smackx.packet.Nick
All Implemented Interfaces:
PacketExtension

public class Nick
extends java.lang.Object
implements PacketExtension

A minimalistic implementation of a PacketExtension for nicknames.

Author:
Guus der Kinderen, guus.der.kinderen@gmail.com
See Also:
XEP-0172: User Nickname

Nested Class Summary
static class Nick.Provider
           
 
Field Summary
static java.lang.String ELEMENT_NAME
           
static java.lang.String NAMESPACE
           
 
Constructor Summary
Nick(java.lang.String name)
           
 
Method Summary
 java.lang.String getElementName()
          Returns the root element name.
 java.lang.String getName()
          The value of this nickname
 java.lang.String getNamespace()
          Returns the root element XML namespace.
 void setName(java.lang.String name)
          Sets the value of this nickname
 java.lang.String 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
See Also:
Constant Field Values

ELEMENT_NAME

public static final java.lang.String ELEMENT_NAME
See Also:
Constant Field Values
Constructor Detail

Nick

public Nick(java.lang.String name)
Method Detail

getName

public java.lang.String getName()
The value of this nickname

Returns:
the nickname

setName

public void setName(java.lang.String name)
Sets the value of this nickname

Parameters:
name - the name to set

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

Smack

Copyright © 2003-2007 Jive Software.