com.jivesoftware.forum.database
Class DbReadTracker.UserReadTracker

java.lang.Object
  com.jivesoftware.forum.database.DbReadTracker.UserReadTracker

All Implemented Interfaces:

Cacheable, com.tangosol.io.ExternalizableLite, java.io.Serializable

Enclosing class:

DbReadTracker

public static class DbReadTracker.UserReadTracker
extends java.lang.Object
implements Cacheable, com.tangosol.io.ExternalizableLite

Tracks the read status of threads and messages for a user.

See Also:

Serialized Form

Constructor Summary

DbReadTracker.UserReadTracker()
Constructor for internal use only.

DbReadTracker.UserReadTracker(long userID)
Creates a new read track for the specified user.

Method Summary

boolean	equals(java.lang.Object o)
int	getCachedSize() Returns the approximate size of the Object in bytes.
int	getReadStatus(ForumMessage message)
int	getReadStatus(ForumThread thread)
int	hashCode()
void	markRead(Forum forum) Marks an entire forum as read.
boolean	markRead(ForumMessage message)
void	readExternal(java.io.DataInput in)
void	writeExternal(java.io.DataOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

DbReadTracker.UserReadTracker

public DbReadTracker.UserReadTracker(long userID)

Creates a new read track for the specified user.

Parameters:

userID - the ID of the user.

DbReadTracker.UserReadTracker

public DbReadTracker.UserReadTracker()

Constructor for internal use only.

Method Detail

readExternal

public void readExternal(java.io.DataInput in)
                  throws java.io.IOException

Specified by:

readExternal in interface com.tangosol.io.ExternalizableLite

Throws:

java.io.IOException

writeExternal

public void writeExternal(java.io.DataOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface com.tangosol.io.ExternalizableLite

Throws:

java.io.IOException

getReadStatus

public int getReadStatus(ForumThread thread)

getReadStatus

public int getReadStatus(ForumMessage message)

markRead

public boolean markRead(ForumMessage message)

markRead

public void markRead(Forum forum)

Marks an entire forum as read. Essentially, this sets a high water mark, where everything older than the date is automatically considered to be read.

Parameters:

forum - the forum to mark as read.

getCachedSize

public int getCachedSize()

Description copied from interface: Cacheable

Returns the approximate size of the Object in bytes. The size should be considered to be a best estimate of how much memory the Object occupies and may be based on empirical trials or dynamic calculations.

Specified by:

getCachedSize in interface Cacheable

Returns:

the size of the Object in bytes.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object