xyz.nickr.jitter.impl

Class RoomImpl

java.lang.Object

xyz.nickr.jitter.impl.RoomImpl

All Implemented Interfaces:

Room

public class RoomImpl
extends Object
implements Room

Constructor Summary

Constructors

Constructor and Description
RoomImpl(Jitter jitter, org.json.JSONObject json)

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	asJSON() Gets the underlying JSON object.
List<Room>	getChannels() Gets this room's subchannels.
String	getID() Gets this room's ID.
Jitter	getJitter() Gets the providing Jitter object.
String	getLastAccessTime() Gets the time this room was last accessed.
Message	getMessage(String id) Gets the Message of a given ID.
MessageHistory	getMessageHistory() Gets this room's message history.
MessageHistory	getMessagesAfter(Message message) Gets this room's message history, with messages after and including the given message.
MessageHistory	getMessagesBefore(Message message) Gets this room's message history, with messages before and including the given message.
String	getName() Gets this room's name.
String	getPathURL() Gets this room's URL path.
List<String>	getTags() Gets this room's tags.
String	getTopic() Gets this room's topic.
RoomType	getType() Gets this room's type.
int	getUnreadItems() Gets the number of unread messages in this room.
int	getUnreadMentions() Gets the number of unread mentions in this room.
String	getURI() Gets this room's URI.
int	getUserCount() Gets this room's user count.
List<RoomUser>	getUsers() Loads and returns this room's users.
int	getVersion() Gets this room's version.
boolean	isFavourite() Gets whether or not this room is marked as a favourite room.
boolean	isLurkEnabled() Gets whether or not the authenticated is lurking in this room.
boolean	isMember() Gets whether or not the current user is a member of this room.
Message	sendMessage(String message) Sends a message to this room.
String	toString()
void	update(org.json.JSONObject data) Updates this Room with the given JSON data.

Methods inherited from class java.lang.Object

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

Methods inherited from interface xyz.nickr.jitter.api.Room

beginEventsStreaming, beginMessageStreaming

Constructor Detail

RoomImpl

public RoomImpl(Jitter jitter,
                org.json.JSONObject json)

Method Detail

getJitter

public Jitter getJitter()

Description copied from interface: Room

Gets the providing Jitter object.

Specified by:

getJitter in interface Room

Returns:

The provider.

asJSON

public org.json.JSONObject asJSON()

Description copied from interface: Room

Gets the underlying JSON object.

Specified by:

asJSON in interface Room

Returns:

The JSON.

update

public void update(org.json.JSONObject data)

Description copied from interface: Room

Updates this Room with the given JSON data.

Specified by:

update in interface Room

Parameters:

data - The data.

getID

public String getID()

Description copied from interface: Room

Gets this room's ID.

Specified by:

getID in interface Room

Returns:

The ID.

getName

public String getName()

Description copied from interface: Room

Gets this room's name.

Specified by:

getName in interface Room

Returns:

The name.

getTopic

public String getTopic()

Description copied from interface: Room

Gets this room's topic.

Specified by:

getTopic in interface Room

Returns:

The topic.

getType

public RoomType getType()

Description copied from interface: Room

Gets this room's type.

Specified by:

getType in interface Room

Returns:

The type.

getURI

public String getURI()

Description copied from interface: Room

Gets this room's URI.

Specified by:

getURI in interface Room

Returns:

The URI.

getUserCount

public int getUserCount()

Description copied from interface: Room

Gets this room's user count.

Specified by:

getUserCount in interface Room

Returns:

The user count.

getUnreadItems

public int getUnreadItems()

Description copied from interface: Room

Gets the number of unread messages in this room.

Specified by:

getUnreadItems in interface Room

Returns:

The count.

getUnreadMentions

public int getUnreadMentions()

Description copied from interface: Room

Gets the number of unread mentions in this room.

Specified by:

getUnreadMentions in interface Room

Returns:

The count.

getLastAccessTime

public String getLastAccessTime()

Description copied from interface: Room

Gets the time this room was last accessed.

Specified by:

getLastAccessTime in interface Room

Returns:

The time it was last accessed.

isMember

public boolean isMember()

Description copied from interface: Room

Gets whether or not the current user is a member of this room.

Specified by:

isMember in interface Room

Returns:

True if it is; false otherwise.

isFavourite

public boolean isFavourite()

Description copied from interface: Room

Gets whether or not this room is marked as a favourite room.

Specified by:

isFavourite in interface Room

Returns:

True if it is; false otherwise.

isLurkEnabled

public boolean isLurkEnabled()

Description copied from interface: Room

Gets whether or not the authenticated is lurking in this room.

Specified by:

isLurkEnabled in interface Room

Returns:

True if it is; false otherwise.

getPathURL

public String getPathURL()

Description copied from interface: Room

Gets this room's URL path.

Specified by:

getPathURL in interface Room

Returns:

The URL path.

getTags

public List<String> getTags()

Description copied from interface: Room

Gets this room's tags.

Specified by:

getTags in interface Room

Returns:

The tags.

getVersion

public int getVersion()

Description copied from interface: Room

Gets this room's version.

Specified by:

getVersion in interface Room

Returns:

The version.

getChannels

public List<Room> getChannels()

Description copied from interface: Room

Gets this room's subchannels.

Specified by:

getChannels in interface Room

Returns:

The subchannels.

getUsers

public List<RoomUser> getUsers()

Description copied from interface: Room

Loads and returns this room's users.

Note: This is a potentially costly operation if there are lots of users. Caching is a good idea for this.

Specified by:

getUsers in interface Room

Returns:

The users.

getMessage

public Message getMessage(String id)

Description copied from interface: Room

Gets the Message of a given ID.

Specified by:

getMessage in interface Room

Parameters:

id - The ID.

Returns:

The message, or null if no such message.

getMessageHistory

public MessageHistory getMessageHistory()

Description copied from interface: Room

Gets this room's message history.

Specified by:

getMessageHistory in interface Room

Returns:

The message history;

getMessagesBefore

public MessageHistory getMessagesBefore(Message message)

Description copied from interface: Room

Gets this room's message history, with messages before and including the given message.

Specified by:

getMessagesBefore in interface Room

Parameters:

message - The message.

Returns:

The message history.

getMessagesAfter

public MessageHistory getMessagesAfter(Message message)

Description copied from interface: Room

Gets this room's message history, with messages after and including the given message.

Specified by:

getMessagesAfter in interface Room

Parameters:

message - The message.

Returns:

The message history.

sendMessage

public Message sendMessage(String message)

Description copied from interface: Room

Sends a message to this room.

Specified by:

sendMessage in interface Room

Parameters:

message - The message.

Returns:

The message.

toString

public String toString()

Overrides:

toString in class Object