org.jabber.jabberbeans.Extension
Class RosterBuilder

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

Direct Known Subclasses:

RosterExtensionBuilder

public class RosterBuilder

extends java.lang.Object

implements ExtensionBuilder

RosterBuilder is the class responsible for building complex roster item lists,

Version:

$Revision: 1.1.1.1 $

Author:

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

See Also:

Roster

Field Summary

private boolean	IsIQRoster true if an iq:roster, false for x:roster.
private java.util.Vector	rosterItems List of users

Constructor Summary

RosterBuilder()
Creates a new RosterBuilder instance.

Method Summary

void	addRosterItem(RosterItem e) addRosterItem adds a new RosterItem to the rosterlist.
Extension	build() build builds a Roster object
void	delRosterItem(RosterItem e) delRosterItem deletes a RosterItem from the rosterlist.
java.util.Vector	getRosterItems() getRosterItems returns the vector of roster items.
boolean	isIQRoster() isIQRoster returns true if this is a jabber:iq:roster namespace object, false if is a jabber:x:roster namespace object.
void	reset() reset resets the values in rosterItems so that the class may be reused.
void	setIQRoster(boolean iqRoster) setIQRoster changes whether this is a jabber:iq:roster (true) or a jabber:x:roster (false)

Methods inherited from class java.lang.Object

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

Field Detail

rosterItems

private java.util.Vector rosterItems

List of users

IsIQRoster

private boolean IsIQRoster

true if an iq:roster, false for x:roster.

Constructor Detail

RosterBuilder

public RosterBuilder()

Creates a new RosterBuilder instance.

Method Detail

reset

public void reset()

reset resets the values in rosterItems so that the class may be reused.

Specified by:

reset in interface ExtensionBuilder

addRosterItem

public void addRosterItem(RosterItem e)

addRosterItem adds a new RosterItem to the rosterlist.

Parameters:

e - a RosterItem value

delRosterItem

public void delRosterItem(RosterItem e)

delRosterItem deletes a RosterItem from the rosterlist.

Parameters:

e - a RosterItem value

getRosterItems

public java.util.Vector getRosterItems()

getRosterItems returns the vector of roster items.

Returns:

a Vector value

isIQRoster

public boolean isIQRoster()

isIQRoster returns true if this is a jabber:iq:roster namespace object, false if is a jabber:x:roster namespace object.

Returns:

a boolean value

setIQRoster

public void setIQRoster(boolean iqRoster)

setIQRoster changes whether this is a jabber:iq:roster (true) or a jabber:x:roster (false)

Parameters:

iqRoster - a boolean value

build

public Extension build()
                throws java.lang.InstantiationException

build builds a Roster object

Specified by:

build in interface ExtensionBuilder

Returns:

an Extension value