Package sfs3.client.entities.managers

Class SFSBuddyManager

java.lang.Object

sfs3.client.entities.managers.SFSBuddyManager

All Implemented Interfaces:

IBuddyManager

public class SFSBuddyManager
extends Object
implements IBuddyManager

The SFSBuddyManager class is the entity in charge of managing the current user's Buddy List system. It keeps track of all the user's buddies, their state and their Buddy Variables. It also provides utility methods to set the user's properties when he is part of the buddies list of other users.

See Also:

• SmartFox.getBuddyManager()

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Buddy>	buddiesByName
protected boolean	inited
protected Map<String,BuddyVariable>	myVariables

Constructor Summary

Constructors

Constructor	Description
SFSBuddyManager(ISmartFox sfs)	Creates a new SFSBuddyManager instance.

Method Summary

Modifier and Type	Method	Description
void	addBuddy(Buddy buddy)
void	clearAll()
boolean	containsBuddy(String name)	Indicates whether a buddy exists in user's buddies list or not.
Buddy	getBuddyById(int id)	Retrieves a Buddy object from its id property.
Buddy	getBuddyByName(String name)	Retrieves a Buddy object from its name property.
Buddy	getBuddyByNickName(String nickName)	Retrieves a Buddy object from its nickName property (if set).
List<Buddy>	getBuddyList()	Returns a list of Buddy objects representing all the buddies in the user's buddies list.
List<String>	getBuddyStates()	Returns a list of strings representing the available custom buddy states.
String	getMyDisplayName()	Gets the nickname of the current User or the User's name, if nickname is not set
String	getMyNickName()	Returns the current user's nickname (if set).
boolean	getMyOnlineState()	Returns the current user's online/offline state.
String	getMyState()	Returns the current user's custom state (if set).
BuddyVariable	getMyVariable(String varName)	Retrieves a Buddy Variable from its name.
List<BuddyVariable>	getMyVariables()	Returns all the Buddy Variables associated with the current user.
List<Buddy>	getOfflineBuddies()	Returns a list of Buddy objects representing all the offline buddies in the user's buddies list.
List<Buddy>	getOnlineBuddies()	Returns a list of Buddy objects representing all the online buddies in the user's buddies list.
boolean	isInited()	Indicates whether the client's Buddy List system is initialized or not.
Buddy	removeBuddyById(int id)
Buddy	removeBuddyByName(String name)
void	setBuddyStates(List<String> states)
void	setInited(boolean inited)
void	setMyNickName(String nickName)
void	setMyOnlineState(boolean isOnline)
void	setMyState(String state)
void	setMyVariable(BuddyVariable bVar)
void	setMyVariables(List<BuddyVariable> variables)

Methods inherited from class java.lang.Object

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

Field Details

buddiesByName

protected Map<String,Buddy> buddiesByName

myVariables

protected Map<String,BuddyVariable> myVariables

inited

protected boolean inited

Constructor Details

SFSBuddyManager

public SFSBuddyManager(ISmartFox sfs)

Creates a new SFSBuddyManager instance.

NOTE: developers never instantiate a SFSBuddyManager manually: this is done by the SmartFoxServer 3 API internally. A reference to the existing instance can be retrieved using the SmartFox.getBuddyManager() method.

Parameters:

sfs - An instance of the SmartFoxServer 3 client API main SmartFox class.

See Also:

• SmartFox.getBuddyManager()

Method Details

isInited

public boolean isInited()

Description copied from interface: IBuddyManager

Indicates whether the client's Buddy List system is initialized or not. If not, an InitBuddyListRequest request should be sent to the server in order to retrieve the persistent Buddy List data.

No Buddy List related operations are allowed until the system is initialized.

Specified by:

isInited in interface IBuddyManager

See Also:

• InitBuddyListRequest

setInited

public void setInited(boolean inited)

Specified by:

setInited in interface IBuddyManager

addBuddy

public void addBuddy(Buddy buddy)

Specified by:

addBuddy in interface IBuddyManager

removeBuddyById

public Buddy removeBuddyById(int id)

Specified by:

removeBuddyById in interface IBuddyManager

removeBuddyByName

public Buddy removeBuddyByName(String name)

Specified by:

removeBuddyByName in interface IBuddyManager

containsBuddy

public boolean containsBuddy(String name)

Description copied from interface: IBuddyManager

Indicates whether a buddy exists in user's buddies list or not.

Specified by:

containsBuddy in interface IBuddyManager

Parameters:

name - The name of the buddy whose presence in the buddies list is to be tested.

Returns:

true if the specified buddy exists in the buddies list.

See Also:

• Buddy.getName()

getBuddyById

public Buddy getBuddyById(int id)

Description copied from interface: IBuddyManager

Retrieves a Buddy object from its id property.

Specified by:

getBuddyById in interface IBuddyManager

Parameters:

id - The id of the buddy to be found.

Returns:

The Buddy object representing the buddy, or null if no buddy with the passed id exists in the buddies list.

See Also:

• Buddy.getId()
• IBuddyManager.getBuddyByName(java.lang.String)
• IBuddyManager.getBuddyByNickName(java.lang.String)

getBuddyByName

public Buddy getBuddyByName(String name)

Description copied from interface: IBuddyManager

Retrieves a Buddy object from its name property.

Specified by:

getBuddyByName in interface IBuddyManager

Parameters:

name - The name of the buddy to be found.

Returns:

The Buddy object representing the buddy, or null if no buddy with the passed name exists in the buddies list.

See Also:

• Buddy.getName()
• IBuddyManager.getBuddyById(int)
• IBuddyManager.getBuddyByNickName(java.lang.String)

getBuddyByNickName

public Buddy getBuddyByNickName(String nickName)

Description copied from interface: IBuddyManager

Retrieves a Buddy object from its nickName property (if set).

Specified by:

getBuddyByNickName in interface IBuddyManager

Parameters:

nickName - The nickName of the buddy to be found.

Returns:

The Buddy object representing the buddy, or null if no buddy with the passed nickName exists in the buddies list.

See Also:

• Buddy.getNickName()
• IBuddyManager.getBuddyById(int)
• IBuddyManager.getBuddyByName(java.lang.String)

getOfflineBuddies

public List<Buddy> getOfflineBuddies()

Description copied from interface: IBuddyManager

Returns a list of Buddy objects representing all the offline buddies in the user's buddies list.

Specified by:

getOfflineBuddies in interface IBuddyManager

See Also:

• Buddy.isOnline()

getOnlineBuddies

public List<Buddy> getOnlineBuddies()

Description copied from interface: IBuddyManager

Returns a list of Buddy objects representing all the online buddies in the user's buddies list.

Specified by:

getOnlineBuddies in interface IBuddyManager

See Also:

• Buddy.isOnline()

getBuddyList

public List<Buddy> getBuddyList()

Description copied from interface: IBuddyManager

Returns a list of Buddy objects representing all the buddies in the user's buddies list. The list is null if the Buddy List system is not initialized.

Specified by:

getBuddyList in interface IBuddyManager

See Also:

• IBuddyManager.isInited()

getBuddyStates

public List<String> getBuddyStates()

Description copied from interface: IBuddyManager

Returns a list of strings representing the available custom buddy states. The custom states are received by the client upon initialization of the Buddy List system. They can be configured by means of the SmartFoxServer 3 Administration Tool.

Specified by:

getBuddyStates in interface IBuddyManager

See Also:

• Buddy.getState()

getMyVariable

public BuddyVariable getMyVariable(String varName)

Description copied from interface: IBuddyManager

Retrieves a Buddy Variable from its name.

Specified by:

getMyVariable in interface IBuddyManager

Parameters:

varName - The name of the Buddy Variable to be retrieved.

Returns:

The BuddyVariable object representing the Buddy Variable, or null if no Buddy Variable with the passed name is associated with the current user.

See Also:

• IBuddyManager.getMyVariables()
• SetBuddyVariablesRequest

getMyVariables

public List<BuddyVariable> getMyVariables()

Description copied from interface: IBuddyManager

Returns all the Buddy Variables associated with the current user.

Specified by:

getMyVariables in interface IBuddyManager

See Also:

• BuddyVariable
• IBuddyManager.getMyVariable(String)

getMyOnlineState

public boolean getMyOnlineState()

Description copied from interface: IBuddyManager

Returns the current user's online/offline state. If true, the user appears to be online in the buddies list of other users who have him as a buddy.

The online state of a user in a buddy list is handled by means of a reserved Buddy Variable (see ReservedBuddyVariables class); it can be changed using the dedicated GoOnlineRequest request.

Specified by:

getMyOnlineState in interface IBuddyManager

See Also:

• Buddy.isOnline()
• ReservedBuddyVariables
• GoOnlineRequest

getMyNickName

public String getMyNickName()

Description copied from interface: IBuddyManager

Returns the current user's nickname (if set). If the nickname was never set before, null is returned.

As the nickname of a user in a buddy list is handled by means of a reserved Buddy Variable (see ReservedBuddyVariables class), it can be set using the SetBuddyVariablesRequest request.

Specified by:

getMyNickName in interface IBuddyManager

See Also:

• Buddy.getNickName()
• ReservedBuddyVariables
• SetBuddyVariablesRequest

getMyState

public String getMyState()

Description copied from interface: IBuddyManager

Returns the current user's custom state (if set). Examples of custom states are "Available", "Busy", "Be right back", etc. If the custom state was never set before, null is returned.

As the custom state of a user in a buddy list is handled by means of a reserved Buddy Variable (see ReservedBuddyVariables class), it can be set using the SetBuddyVariablesRequest request.

Specified by:

getMyState in interface IBuddyManager

See Also:

• Buddy.getState()
• ReservedBuddyVariables
• SetBuddyVariablesRequest

getMyDisplayName

public String getMyDisplayName()

Description copied from interface: IBuddyManager

Gets the nickname of the current User or the User's name, if nickname is not set

Specified by:

getMyDisplayName in interface IBuddyManager

Returns:

nickname of the current User or the User's name, if nickname is not set

setMyVariable

public void setMyVariable(BuddyVariable bVar)

Specified by:

setMyVariable in interface IBuddyManager

setMyVariables

public void setMyVariables(List<BuddyVariable> variables)

Specified by:

setMyVariables in interface IBuddyManager

setMyOnlineState

public void setMyOnlineState(boolean isOnline)
                      throws SFSException

Specified by:

setMyOnlineState in interface IBuddyManager

Throws:

SFSException

setMyNickName

public void setMyNickName(String nickName)
                   throws SFSException

Specified by:

setMyNickName in interface IBuddyManager

Throws:

SFSException

setMyState

public void setMyState(String state)
                throws SFSException

Specified by:

setMyState in interface IBuddyManager

Throws:

SFSException

setBuddyStates

public void setBuddyStates(List<String> states)

Specified by:

setBuddyStates in interface IBuddyManager

clearAll

public void clearAll()

Specified by:

clearAll in interface IBuddyManager