xyz.nickr.jitter

Class JitterStream

java.lang.Object

xyz.nickr.jitter.JitterStream

public class JitterStream
extends Object

A utility class for managing the Gitter Streaming API on behalf of a Jitter object.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
void	beginEventsStream(Room room) Begins an event stream over a given Room.
void	beginMessagesStream(Room room) Begins a message stream over a given Room.
BufferedReader	getEventsStream(String roomId) Gets a BufferedReader over the given room's events stream.
Jitter	getJitter() The providing Jitter object.
BufferedReader	getMessagesStream(String roomId) Gets a BufferedReader over the given room's messages stream.

Methods inherited from class java.lang.Object

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

Method Detail

getJitter

public Jitter getJitter()

The providing Jitter object.

Returns:

The provider.

getMessagesStream

public BufferedReader getMessagesStream(String roomId)
                                 throws IOException

Gets a BufferedReader over the given room's messages stream.

This is a BLOCKING method! Use beginMessagesStream(Room) for non-blocking

Parameters:

roomId - The room ID.

Returns:

The BufferedReader.

Throws:

IOException - If an error occurs.

getEventsStream

public BufferedReader getEventsStream(String roomId)
                               throws IOException

Gets a BufferedReader over the given room's events stream.

This is a BLOCKING method! Use beginEventsStream(Room) for non-blocking

Parameters:

roomId - The room ID.

Returns:

The BufferedReader.

Throws:

IOException - If an error occurs.

beginMessagesStream

public void beginMessagesStream(Room room)

Begins a message stream over a given Room.

Messages will be propagated through Jitter's event system.

Parameters:

room - The room.

beginEventsStream

public void beginEventsStream(Room room)

Begins an event stream over a given Room.

Events will be propagated through Jitter's event system.

Parameters:

room - The room.