|
Openfire 3.3.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.openfire.muc.HistoryStrategy
public class HistoryStrategy
Multi-User Chat rooms may cache history of the conversations in the room in order to play them back to newly arriving members.
This class is an internal component of MUCRoomHistory that describes the strategy that can be used, and provides a method of administering the history behavior.
Nested Class Summary | |
---|---|
static class |
HistoryStrategy.Type
Strategy type. |
Constructor Summary | |
---|---|
HistoryStrategy(HistoryStrategy parentStrategy)
Create a history strategy with the given parent strategy (for defaults) or null if no parent exists. |
Method Summary | |
---|---|
void |
addMessage(Message packet)
Add a message to the current chat history. |
int |
getMaxNumber()
Obtain the maximum number of messages for strategies using message number limitations. |
Iterator<Message> |
getMessageHistory()
Obtain the current history as an iterator of messages to play back to a new room member. |
ListIterator<Message> |
getReverseMessageHistory()
Obtain the current history to be iterated in reverse mode. |
HistoryStrategy.Type |
getType()
Obtain the type of history strategy being used. |
boolean |
hasChangedSubject()
Returns true if there is a message within the history of the room that has changed the room's subject. |
void |
setContext(String prefix)
Sets the prefix to use for retrieving and saving settings (and also triggers an immediate loading of properties). |
void |
setMaxNumber(int max)
Set the maximum number of messages for strategies using message number limitations. |
void |
setType(HistoryStrategy.Type newType)
Set the type of history strategy being used. |
void |
setTypeFromString(String typeName)
Obtain the strategy type from string name. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HistoryStrategy(HistoryStrategy parentStrategy)
parentStrategy
- The parent strategy of this strategy or null if none exists.Method Detail |
---|
public int getMaxNumber()
public void setMaxNumber(int max)
max
- the maximum number of messages to store in applicable strategies.public void setType(HistoryStrategy.Type newType)
newType
- The new type of chat history to use.public HistoryStrategy.Type getType()
public void addMessage(Message packet)
packet
- The packet to add to the chatroom's history.public Iterator<Message> getMessageHistory()
public ListIterator<Message> getReverseMessageHistory()
public void setTypeFromString(String typeName)
typeName
- the text name of the strategy type.public void setContext(String prefix)
prefix
- the prefix to use (without trailing dot) on property names.public boolean hasChangedSubject()
|
Openfire 3.3.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |