org.jivesoftware.smackx.muc.packet

Class MUCInitialPresence.History

java.lang.Object

org.jivesoftware.smackx.muc.packet.MUCInitialPresence.History

All Implemented Interfaces:

Element, NamedElement

Enclosing class:

MUCInitialPresence

public static class MUCInitialPresence.History
extends Object
implements NamedElement

The History class controls the number of characters or messages to receive when entering a room.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT

Constructor Summary

Constructors

Constructor and Description
History() Deprecated. use #History(int, int, int, Date) instead.
History(int maxChars, int maxStanzas, int seconds, Date since)

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
int	getMaxChars() Returns the total number of characters to receive in the history.
int	getMaxStanzas() Returns the total number of messages to receive in the history.
int	getSeconds() Returns the number of seconds to use to filter the messages received during that time.
Date	getSince() Returns the since date to use to filter the messages received during that time.
void	setMaxChars(int maxChars) Deprecated. use #History(int, int, int, Date) instead.
void	setMaxStanzas(int maxStanzas) Deprecated. use #History(int, int, int, Date) instead.
void	setSeconds(int seconds) Deprecated. use #History(int, int, int, Date) instead.
void	setSince(Date since) Deprecated. use #History(int, int, int, Date) instead.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

Constructor Detail

History

@Deprecated
public History()

Deprecated. use #History(int, int, int, Date) instead.

Deprecated constructor.

History

public History(int maxChars,
               int maxStanzas,
               int seconds,
               Date since)

Method Detail

getMaxChars

public int getMaxChars()

Returns the total number of characters to receive in the history.

Returns:

total number of characters to receive in the history.

getMaxStanzas

public int getMaxStanzas()

Returns the total number of messages to receive in the history.

Returns:

the total number of messages to receive in the history.

getSeconds

public int getSeconds()

Returns the number of seconds to use to filter the messages received during that time. In other words, only the messages received in the last "X" seconds will be included in the history.

Returns:

the number of seconds to use to filter the messages received during that time.

getSince

public Date getSince()

Returns the since date to use to filter the messages received during that time. In other words, only the messages received since the datetime specified will be included in the history.

Returns:

the since date to use to filter the messages received during that time.

setMaxChars

@Deprecated
public void setMaxChars(int maxChars)

Deprecated. use #History(int, int, int, Date) instead.

Sets the total number of characters to receive in the history.

Parameters:

maxChars - the total number of characters to receive in the history.

setMaxStanzas

@Deprecated
public void setMaxStanzas(int maxStanzas)

Deprecated. use #History(int, int, int, Date) instead.

Sets the total number of messages to receive in the history.

Parameters:

maxStanzas - the total number of messages to receive in the history.

setSeconds

@Deprecated
public void setSeconds(int seconds)

Deprecated. use #History(int, int, int, Date) instead.

Sets the number of seconds to use to filter the messages received during that time. In other words, only the messages received in the last "X" seconds will be included in the history.

Parameters:

seconds - the number of seconds to use to filter the messages received during that time.

setSince

@Deprecated
public void setSince(Date since)

Deprecated. use #History(int, int, int, Date) instead.

Sets the since date to use to filter the messages received during that time. In other words, only the messages received since the datetime specified will be included in the history.

Parameters:

since - the since date to use to filter the messages received during that time.

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.