org.jivesoftware.smackx.packet
Class JingleDescription

java.lang.Object
  extended by org.jivesoftware.smackx.packet.JingleDescription
Direct Known Subclasses:
JingleDescription.Audio

public abstract class JingleDescription
extends java.lang.Object

Jingle content description.

Author:
Alvaro Saurin

Nested Class Summary
static class JingleDescription.Audio
          Jingle audio description
 
Field Summary
static java.lang.String NODENAME
           
 
Constructor Summary
JingleDescription()
          Creates a content description..
 
Method Summary
 void addAudioPayloadTypes(java.util.List<PayloadType> pts)
          Adds a list of payloads to the packet.
 void addPayloadType(PayloadType pt)
          Adds a audio payload type to the packet.
 java.util.List<PayloadType> getAudioPayloadTypesList()
          Return the list of Payload types contained in the description.
 java.lang.String getElementName()
          Returns the XML element name of the element.
abstract  java.lang.String getNamespace()
          Return the namespace.
 java.util.Iterator<PayloadType> getPayloadTypes()
          Returns an Iterator for the audio payloads in the packet.
 int getPayloadTypesCount()
          Returns a count of the audio payloads in the Jingle packet.
 java.util.List<PayloadType> getPayloadTypesList()
          Returns a list for the audio payloads in the packet.
 java.lang.String toXML()
          Convert a Jingle description to XML.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NODENAME

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

JingleDescription

public JingleDescription()
Creates a content description..

Method Detail

getElementName

public java.lang.String getElementName()
Returns the XML element name of the element.

Returns:
the XML element name of the element.

getNamespace

public abstract java.lang.String getNamespace()
Return the namespace.

Returns:
The namespace

addPayloadType

public void addPayloadType(PayloadType pt)
Adds a audio payload type to the packet.

Parameters:
pt - the audio payload type to add.

addAudioPayloadTypes

public void addAudioPayloadTypes(java.util.List<PayloadType> pts)
Adds a list of payloads to the packet.

Parameters:
pts - the payloads to add.

getPayloadTypes

public java.util.Iterator<PayloadType> getPayloadTypes()
Returns an Iterator for the audio payloads in the packet.

Returns:
an Iterator for the audio payloads in the packet.

getPayloadTypesList

public java.util.List<PayloadType> getPayloadTypesList()
Returns a list for the audio payloads in the packet.

Returns:
a list for the audio payloads in the packet.

getAudioPayloadTypesList

public java.util.List<PayloadType> getAudioPayloadTypesList()
Return the list of Payload types contained in the description.

Returns:
a list of PayloadType.Audio

getPayloadTypesCount

public int getPayloadTypesCount()
Returns a count of the audio payloads in the Jingle packet.

Returns:
the number of audio payloads in the Jingle packet.

toXML

public java.lang.String toXML()
Convert a Jingle description to XML.

Returns:
a string with the XML representation