com.smartfoxserver.v2.buddylist

Class SFSBuddyList

java.lang.Object

com.smartfoxserver.v2.buddylist.SFSBuddyList

All Implemented Interfaces:

BuddyList

public class SFSBuddyList
extends java.lang.Object
implements BuddyList

An SFSBuddyList represents one BuddyList in the Buddy System.

BuddyLists are managed by a SFSBuddyListManager which is a component of the SFSZone

Constructor Summary

Constructors

Constructor and Description
SFSBuddyList(java.lang.String ownerName)
SFSBuddyList(java.lang.String ownerName, BuddyListManager buddyListManager)

Method Summary

Modifier and Type	Method and Description
Buddy	addBuddy(Buddy buddy) Used by the BuddyManager only.
void	clearAll()
boolean	containsBuddy(java.lang.String buddyName) Checks if a Buddy is contained in the BuddyList
java.util.List<Buddy>	getBuddies() Get a list of all Buddies in the BuddyList
Buddy	getBuddy(java.lang.String buddyName) Get a Buddy from the BuddyList by name
BuddyListManager	getBuddyListManager() Get a reference to the BuddyManager managing this BuddyList
User	getOwner() Get the User that owns this BuddyList
java.lang.String	getOwnerName() Get the name of the owner of this BuddyList
int	getRuntimeSize() Obtain the size of the BuddyList, including the temp buddies
int	getSize() Obtain the size of the BuddyList.
boolean	isBuddyBlocked(java.lang.String buddyName) Checks whether the specified Buddy is blocked in this BuddyList
boolean	isEmpty() Checks if the BuddyList is empty
boolean	isFull() Checks if the BuddyList is full
Buddy	removeBuddy(java.lang.String buddyName) Used by the BuddyManager only.
void	setBuddyListManager(BuddyListManager buddyListManager)
ISFSArray	toSFSArray()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SFSBuddyList

public SFSBuddyList(java.lang.String ownerName)

SFSBuddyList

public SFSBuddyList(java.lang.String ownerName,
                    BuddyListManager buddyListManager)

Method Detail

addBuddy

public Buddy addBuddy(Buddy buddy)
               throws SFSBuddyListException

Description copied from interface: BuddyList

Used by the BuddyManager only.
If you want to add a Buddy to User's list please use the BuddyAPI

Specified by:

addBuddy in interface BuddyList

Throws:

SFSBuddyListException

See Also:

SFSBuddyApi.addBuddy(User, String, boolean, boolean, boolean)

removeBuddy

public Buddy removeBuddy(java.lang.String buddyName)

Description copied from interface: BuddyList

Used by the BuddyManager only.
If you want to remove a Buddy from the User's list please use the BuddyAPI.

Specified by:

removeBuddy in interface BuddyList

See Also:

SFSBuddyApi.removeBuddy(User, String, boolean, boolean)

containsBuddy

public boolean containsBuddy(java.lang.String buddyName)

Description copied from interface: BuddyList

Checks if a Buddy is contained in the BuddyList

Specified by:

containsBuddy in interface BuddyList

Parameters:

buddyName - the Buddy name

Returns:

true if the list contains a Buddy with the provided name

isBuddyBlocked

public boolean isBuddyBlocked(java.lang.String buddyName)

Description copied from interface: BuddyList

Checks whether the specified Buddy is blocked in this BuddyList

Specified by:

isBuddyBlocked in interface BuddyList

Parameters:

buddyName - the name of the Buddy

Returns:

true if the Buddy is blocked

getSize

public int getSize()

Description copied from interface: BuddyList

Obtain the size of the BuddyList. The returned value does not count the temporary Buddies

Specified by:

getSize in interface BuddyList

Returns:

the size of the BuddyList without counting the temporary Buddies

getRuntimeSize

public int getRuntimeSize()

Description copied from interface: BuddyList

Obtain the size of the BuddyList, including the temp buddies

Specified by:

getRuntimeSize in interface BuddyList

Returns:

the size of the BuddyList

isEmpty

public boolean isEmpty()

Description copied from interface: BuddyList

Checks if the BuddyList is empty

Specified by:

isEmpty in interface BuddyList

Returns:

true if the BuddyList is empty

isFull

public boolean isFull()

Description copied from interface: BuddyList

Checks if the BuddyList is full

Specified by:

isFull in interface BuddyList

Returns:

true if the BuddyList is full

clearAll

public void clearAll()

Specified by:

clearAll in interface BuddyList

getBuddy

public Buddy getBuddy(java.lang.String buddyName)

Description copied from interface: BuddyList

Get a Buddy from the BuddyList by name

Specified by:

getBuddy in interface BuddyList

Parameters:

buddyName - the name of the Buddy

Returns:

the Buddy object or null if no Buddy exists with that name

getBuddies

public java.util.List<Buddy> getBuddies()

Description copied from interface: BuddyList

Get a list of all Buddies in the BuddyList

Specified by:

getBuddies in interface BuddyList

Returns:

all the Buddy objects in the BuddyList

getBuddyListManager

public BuddyListManager getBuddyListManager()

Description copied from interface: BuddyList

Get a reference to the BuddyManager managing this BuddyList

Specified by:

getBuddyListManager in interface BuddyList

Returns:

a the BuddyManager

setBuddyListManager

public void setBuddyListManager(BuddyListManager buddyListManager)

Specified by:

setBuddyListManager in interface BuddyList

getOwnerName

public java.lang.String getOwnerName()

Description copied from interface: BuddyList

Get the name of the owner of this BuddyList

Specified by:

getOwnerName in interface BuddyList

Returns:

the owner's name

getOwner

public User getOwner()

Description copied from interface: BuddyList

Get the User that owns this BuddyList

Specified by:

getOwner in interface BuddyList

Returns:

the BuddyList owner

toSFSArray

public ISFSArray toSFSArray()

Specified by:

toSFSArray in interface BuddyList

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object