xyz.nickr.jitter.api

Interface MessageHistory

All Known Implementing Classes:

MessageHistoryImpl

public interface MessageHistory

Represents a Room's messages.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
MessageHistory	after(Date date) Gets a portion of this history, consisting of messages sent AFTER a certain date.
MessageHistory	before(Date date) Gets a portion of this history, consisting of messages sent BEFORE a certain date.
List<Message>	fullyLoad() Loads as many messages as it can (until it runs out of messages to fetch).
Message	getEarliest() Gets the message that was sent earliest.
Message	getLatest() Gets the message that was sent most recently.
List<Message>	getMessages() Gets all loaded messages.
Room	getRoom() Gets the parent room.
List<Message>	loadMessages(int n) Loads the next n messages.
void	markRead() Marks all messages in this history as read.

Method Detail

getRoom

Room getRoom()

Gets the parent room.

Returns:

The room.

getMessages

List<Message> getMessages()

Gets all loaded messages.

Returns:

The messages.

loadMessages

List<Message> loadMessages(int n)

Loads the next n messages.

Parameters:

n - The number of messages.

Returns:

The messages loaded.

fullyLoad

List<Message> fullyLoad()

Loads as many messages as it can (until it runs out of messages to fetch).

Returns:

The messages loaded.

before

MessageHistory before(Date date)

Gets a portion of this history, consisting of messages sent BEFORE a certain date.

Parameters:

date - The date.

Returns:

The portion of history.

after

MessageHistory after(Date date)

Gets a portion of this history, consisting of messages sent AFTER a certain date.

Parameters:

date - The date.

Returns:

The portion of history.

getEarliest

Message getEarliest()

Gets the message that was sent earliest.

Returns:

The message.

getLatest

Message getLatest()

Gets the message that was sent most recently.

Returns:

The message.

markRead

void markRead()

Marks all messages in this history as read.