org.jabber.jabberbeans.Extension
Class OOBBuilder

java.lang.Object
  |
  +--org.jabber.jabberbeans.Extension.OOBBuilder

public class OOBBuilder

extends java.lang.Object

implements ExtensionBuilder

A OOBBuilder is used to generate an OOB packet (either jabber:x:oob or jabber:iq:oob)

Version:

$Revision: 1.1.1.1 $

Author:

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

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

OOBBuilder()
construct a new OOBBuilder object.

Method Summary

Extension	build() build an OOB Extension based on the current builder state.
java.lang.String	getDescription() get a description of what this OOB represents
java.lang.String	getURL() get the URL which this OOB is pointing to
boolean	isIQ() return whether this is a jabber:iq:oob or a jabber:x:oob extension
void	reset() reset to a default state, so the object can be reused
void	setDescription(java.lang.String value) set a description of what this OOB represents
void	setIQ(boolean value) set whether this is a jabber:iq:oob or a jabber:x:oob extension
void	setURL(java.lang.String value) set the URL which this OOB is pointing to

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, 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

OOBBuilder

public OOBBuilder()

construct a new OOBBuilder object.

Method Detail

reset

public void reset()

reset to a default state, so the object can be reused

Specified by:

reset in interface ExtensionBuilder

isIQ

public boolean isIQ()

return whether this is a jabber:iq:oob or a jabber:x:oob extension

Returns:

True for a jabber:iq:oob extension, False for a jabber:x:oob extension

setIQ

public void setIQ(boolean value)

set whether this is a jabber:iq:oob or a jabber:x:oob extension

Parameters:

value - True for a jabber:iq:oob extension, False for a jabber:x:oob extension

getURL

public java.lang.String getURL()

get the URL which this OOB is pointing to

Returns:

String holding the URL

setURL

public void setURL(java.lang.String value)

set the URL which this OOB is pointing to

Parameters:

value - String holding the URL

getDescription

public java.lang.String getDescription()

get a description of what this OOB represents

Returns:

String holding a description of the URL.

setDescription

public void setDescription(java.lang.String value)

set a description of what this OOB represents

Parameters:

value - String holding a description of the URL.

build

public Extension build()

build an OOB Extension based on the current builder state.

Specified by:

build in interface ExtensionBuilder

Returns:

new OOB Extension