Package com.smartfoxserver.v2.buddylist
Interface BuddyProperties
-
- All Known Implementing Classes:
SFSBuddyProperties
public interface BuddyProperties
The BuddyProperties class is attached to each User and represents the Buddy status of each User. In other words these data will reflect in every BuddyList where the user was added. An example is the on-line/off-line status or the BuddyVariables or the Status String which are all common. This allows us to have a central place where these informations are stored at runtime instead of adding them to each Buddy object created in every BuddyList. ----------------------------------------------------------------------------------------- Fundamentally the BuddyProperties object is simply a wrapper for the buddy variables. ----------------------------------------------------------------------------------------- In fact all of the exposed properties: - isOnline - getState - getNickname are nothing but persistent BuddyVariables using special "reserved" keys.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
containsVariable(java.lang.String varName)
java.lang.String
getNickName()
java.util.List<BuddyVariable>
getPersistentVariables()
java.lang.String
getState()
BuddyVariable
getVariable(java.lang.String varName)
java.util.List<BuddyVariable>
getVariables()
int
getVariablesCount()
void
init(java.lang.Object o)
boolean
isChangedSinceLastSave()
boolean
isInited()
boolean
isOnline()
void
removeVariable(java.lang.String varName)
void
setChangedSinceLastSave(boolean flag)
void
setInited()
void
setNickName(java.lang.String buddyNickName)
void
setOnline(boolean flag)
void
setState(java.lang.String state)
void
setVariable(BuddyVariable buddyVariable)
void
setVariables(java.util.List<BuddyVariable> buddyVariables)
-
-
-
Method Detail
-
init
void init(java.lang.Object o)
-
isOnline
boolean isOnline()
-
setOnline
void setOnline(boolean flag)
-
getState
java.lang.String getState()
-
setState
void setState(java.lang.String state)
-
getNickName
java.lang.String getNickName()
-
setNickName
void setNickName(java.lang.String buddyNickName)
-
getVariable
BuddyVariable getVariable(java.lang.String varName)
-
getVariables
java.util.List<BuddyVariable> getVariables()
-
setVariable
void setVariable(BuddyVariable buddyVariable)
-
getPersistentVariables
java.util.List<BuddyVariable> getPersistentVariables()
-
setVariables
void setVariables(java.util.List<BuddyVariable> buddyVariables)
-
removeVariable
void removeVariable(java.lang.String varName)
-
containsVariable
boolean containsVariable(java.lang.String varName)
-
getVariablesCount
int getVariablesCount()
-
isChangedSinceLastSave
boolean isChangedSinceLastSave()
-
setChangedSinceLastSave
void setChangedSinceLastSave(boolean flag)
-
isInited
boolean isInited()
-
setInited
void setInited()
-
-