org.jabber.jabberbeans.Extension
Class OOB

java.lang.Object
  |
  +--org.jabber.jabberbeans.XMLData
        |
        +--org.jabber.jabberbeans.Extension.OOB

public class OOB

extends XMLData

implements MessageExtension, QueryExtension, PresenceExtension

An OOB object represents Out-of-band referenced data, and represents the core data passed via a jabber:x:oob or jabber:iq:oob namespace extension. Additional functionality (URL verification, user download facility, mini-HTTP server) is not provided here.

Version:

$Revision: 1.1.1.1 $

Author:

David Waite <dwaite@jabber.com>, $Author: lucky $

See Also:

Serialized Form

Field Summary

private java.lang.String	description String holding and description of the data being referenced.
private boolean	IQ This boolean is set true for jabber:iq:oob, left false for jabber:x:oob
private java.lang.String	URL String holding the URL of the out-of-band data.

Constructor Summary

OOB(OOBBuilder builder)
Construct a new OOB object based on the builder state

Method Summary

void	appendItem(java.lang.StringBuffer retval) appendItem appends the XML representation of the current packet data to the specified StringBuffer.
java.lang.String	getDescription() get a Description of the resource which this OOB represents
java.lang.String	getURL() get the URL to which this OOB is pointing
boolean	isIQ() Determine if this is a jabber:x:oob or jabber:iq:oob extension

Methods inherited from class org.jabber.jabberbeans.XMLData

appendAttrib, appendAttrib, appendChild, appendChild, escapeString, toString

Methods inherited from class java.lang.Object

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

Field Detail

IQ

private boolean IQ

This boolean is set true for jabber:iq:oob, left false for jabber:x:oob

URL

private java.lang.String URL

String holding the URL of the out-of-band data.

description

private java.lang.String description

String holding and description of the data being referenced.

Constructor Detail

OOB

public OOB(OOBBuilder builder)

Construct a new OOB object based on the builder state

Parameters:

builder - OOBBuilderwhich holds the values which this object will be created.

Method Detail

isIQ

public boolean isIQ()

Determine if this is a jabber:x:oob or jabber:iq:oob extension

Returns:

True if this is a jabber:iq:oob extension, False if this is a jabber:x:oob extension

getURL

public java.lang.String getURL()

get the URL to which this OOB is pointing

Returns:

String holding the URL this OOB is based around

getDescription

public java.lang.String getDescription()

get a Description of the resource which this OOB represents

Returns:

Stringholding a description of the URL.

appendItem

public void appendItem(java.lang.StringBuffer retval)

appendItem appends the XML representation of the current packet data to the specified StringBuffer.

Overrides:

appendItem in class XMLData

Parameters:

retval - The StringBuffer to append to