A C D E G H L M N O P R S T U V

A

addChatListener(ChatListener) - Method in class net.sourceforge.obby4j.Client

Register a listener to receive chat messages.

addListener(ProtocolListener) - Method in class net.sourceforge.obby4j.Protocol

Register a listener to receive protocol commands.

addParameter(String) - Method in class net.sourceforge.obby4j.Command

Adds a parameters.

addUserListener(UserListener) - Method in class net.sourceforge.obby4j.Client

Register a listener to receive user join/part notifications.

C

ChatListener - Interface in net.sourceforge.obby4j.listeners

A listener interface for clients interested in obby chat messages.

Client - Class in net.sourceforge.obby4j

The main application entry point for communicating with a obby-compatible server in an OOP fashion.

Client() - Constructor for class net.sourceforge.obby4j.Client

Creates an unconnected client.

colorToHexString(Color) - Static method in class net.sourceforge.obby4j.Protocol

Converts a color to an obby protocol color hex string.

Command - Class in net.sourceforge.obby4j

A command of the obby protocol as sent between clients and servers.

Command(Protocol.Keyword) - Constructor for class net.sourceforge.obby4j.Command

Creates a parameterless command with the given keyword.

Command(Protocol.Keyword, String...) - Constructor for class net.sourceforge.obby4j.Command

Creates a command from a keyword and a number of parameters.

commandReceived(Command) - Method in class net.sourceforge.obby4j.Client

Handles protocol commands to sychronize the client's internal state with one on the server.

commandReceived(Command) - Method in interface net.sourceforge.obby4j.listeners.ProtocolListener

Gets called with every valid obby command received.

connect(InetAddress, int, String, Color) - Method in class net.sourceforge.obby4j.Client

Logs into the server as the given user.

D

Document - Class in net.sourceforge.obby4j

Represents a collaboratively edited document.

Document(Client, Command) - Constructor for class net.sourceforge.obby4j.Document

Creates a new Document instance from a command.

DocumentContents - Class in net.sourceforge.obby4j

Represents the contents of a document and provides state management for sync and edit processes.

DocumentContents(Document) - Constructor for class net.sourceforge.obby4j.DocumentContents

Creates an initially empty document content instance.

DocumentContents.State - Enum in net.sourceforge.obby4j

The states a document's content can be in.

E

equals(Object) - Method in class net.sourceforge.obby4j.Document

equals(Object) - Method in class net.sourceforge.obby4j.User

G

getAuthor() - Method in class net.sourceforge.obby4j.Document

getAuthorDocumentIndex() - Method in class net.sourceforge.obby4j.Document

getColor() - Method in class net.sourceforge.obby4j.User

getCommand() - Method in exception net.sourceforge.obby4j.Net6LoginException

getContents() - Method in class net.sourceforge.obby4j.Document

getDocumentById(String) - Method in class net.sourceforge.obby4j.Client

Searches for a document by its document ID.

getDocumentId() - Method in class net.sourceforge.obby4j.Document

getDocuments() - Method in class net.sourceforge.obby4j.Client

getEncryptionStuff1() - Method in class net.sourceforge.obby4j.ServerMetaData

getEncryptionStuff2() - Method in class net.sourceforge.obby4j.ServerMetaData

getEncryptionStuff3() - Method in class net.sourceforge.obby4j.ServerMetaData

getErrorCode() - Method in exception net.sourceforge.obby4j.Net6LoginException

getIntParam(int) - Method in class net.sourceforge.obby4j.Command

Returns the parameter at the given index as an int.

getKeyword() - Method in class net.sourceforge.obby4j.Command

getName() - Method in class net.sourceforge.obby4j.Document

getNet6Id() - Method in class net.sourceforge.obby4j.User

getObbyId() - Method in class net.sourceforge.obby4j.User

getParam(int) - Method in class net.sourceforge.obby4j.Command

Returns the parameter at the given index.

getParams() - Method in class net.sourceforge.obby4j.Command

Returns all parameters of a command.

getProtocol() - Method in class net.sourceforge.obby4j.Client

getProtocolVersion() - Method in class net.sourceforge.obby4j.ServerMetaData

getSelf() - Method in class net.sourceforge.obby4j.Client

getServerMetaData() - Method in class net.sourceforge.obby4j.Client

getState() - Method in class net.sourceforge.obby4j.DocumentContents

getString() - Method in class net.sourceforge.obby4j.DocumentContents

getSubscribedDocuments() - Method in class net.sourceforge.obby4j.User

getSubscribers() - Method in class net.sourceforge.obby4j.Document

getUserByNet6Id(int) - Method in class net.sourceforge.obby4j.Client

Searches for a user by his net6 user ID.

getUserByObbyId(int) - Method in class net.sourceforge.obby4j.Client

Searches for a user by his obby user ID.

getUsername() - Method in class net.sourceforge.obby4j.User

getUsers() - Method in class net.sourceforge.obby4j.Client

H

hashCode() - Method in class net.sourceforge.obby4j.Document

hashCode() - Method in class net.sourceforge.obby4j.User

hexStringToColor(String) - Static method in class net.sourceforge.obby4j.Protocol

Converts an obby-compatoble hex string of a color to an Color instance.

hexStringToInt(String) - Static method in class net.sourceforge.obby4j.Protocol

Converts an obby hex string to an int.

L

login(User) - Method in class net.sourceforge.obby4j.Protocol

Logs in to the server as the user of the Client instance.

M

messageReceived(User, String) - Method in interface net.sourceforge.obby4j.listeners.ChatListener

Gets called when a chat message is received.

N

net.sourceforge.obby4j - package net.sourceforge.obby4j

net.sourceforge.obby4j.listeners - package net.sourceforge.obby4j.listeners

Net6LoginException - Exception in net.sourceforge.obby4j

An exception representing a net.sourceforge.obby4j.Protocol.Keyword.net6_login_failed reply from the server.

Net6LoginException(Command) - Constructor for exception net.sourceforge.obby4j.Net6LoginException

Creates a new exception providing access to the error code sent by the server.

Net6LoginException.ErrorCode - Enum in net.sourceforge.obby4j

All net6 and obby error codes known to this class.

O

obbyDecode(String) - Static method in class net.sourceforge.obby4j.Protocol

Decodes a message transferred via the obby protocol by unescaping backslashes, newline characters and colons.

obbyEncode(String) - Static method in class net.sourceforge.obby4j.Protocol

Encodes a message for transfer via the obby protocol by escaping backslashes, newline characters and colons.

P

parseCommand(String) - Static method in class net.sourceforge.obby4j.Command

Parses a single line received from a server into a Command instance.

Protocol - Class in net.sourceforge.obby4j

Provides encapsulation of low-level obby protocol messages and utility methods for converting protocol parameters into more meaningful Java types.

Protocol(InetAddress, int) - Constructor for class net.sourceforge.obby4j.Protocol

Creates a new Protocol instance to handle the low-level details of the obby protocol.

Protocol.DocumentKeyword - Enum in net.sourceforge.obby4j

A list of all subcommand keywords of the obby_document command known to this implementation of the obby protocol.

Protocol.Keyword - Enum in net.sourceforge.obby4j

A list of all protocol keywords known to this implementation of the obby protocol.

ProtocolListener - Interface in net.sourceforge.obby4j.listeners

A listener interface for clients interested in low-level protocol messages.

R

recordDelete(int, int) - Method in class net.sourceforge.obby4j.DocumentContents

TODO javadoc

recordInsert(String, int) - Method in class net.sourceforge.obby4j.DocumentContents

TODO javadoc

removeChatListener(ChatListener) - Method in class net.sourceforge.obby4j.Client

Unregister a listener from receiving chat messages.

removeListener(ProtocolListener) - Method in class net.sourceforge.obby4j.Protocol

Unregister a listener from receiving protocol commands.

removeUserListener(UserListener) - Method in class net.sourceforge.obby4j.Client

Unregister a listener from receiving user join/part notifications.

run() - Method in class net.sourceforge.obby4j.Protocol

Handles incoming messages from the server.

S

sendMessage(String) - Method in class net.sourceforge.obby4j.Client

Sends a chat message to other users.

sendMessage(String) - Method in class net.sourceforge.obby4j.Protocol

Sends a chat message to other users.

ServerMetaData - Class in net.sourceforge.obby4j

Represents meta-data about the server like protocol version, support for encryption mechanims, etc.

ServerMetaData(Command) - Constructor for class net.sourceforge.obby4j.ServerMetaData

Creates new meta-data about a server.

subscribe(Document) - Method in class net.sourceforge.obby4j.Client

Subscribes this client to a document.

subscribe() - Method in class net.sourceforge.obby4j.Document

Subscribes a client to this document.

subscribe(Document) - Method in class net.sourceforge.obby4j.Protocol

Subscribes this client to a document.

T

toString() - Method in class net.sourceforge.obby4j.Command

Returns a String representation of a command exactly as it would be send over the network.

toString() - Method in class net.sourceforge.obby4j.Document

toString() - Method in class net.sourceforge.obby4j.DocumentContents

toString() - Method in class net.sourceforge.obby4j.User

Returns a string represenation of a user instance.

U

unsubscribe(Document) - Method in class net.sourceforge.obby4j.Client

Unsubscribes this client from a document.

unsubscribe() - Method in class net.sourceforge.obby4j.Document

Unsubscribes a client from this document.

unsubscribe(Document) - Method in class net.sourceforge.obby4j.Protocol

Unsubscribes this client from a document.

User - Class in net.sourceforge.obby4j

An obby user.

User(String, Color) - Constructor for class net.sourceforge.obby4j.User

Creates a user with the given name and color.

User(String, String) - Constructor for class net.sourceforge.obby4j.User

Creates a user with the given name and color with the color given as hex string.

User(Command) - Constructor for class net.sourceforge.obby4j.User

Creates a user from a command.

User(int, String, int, String) - Constructor for class net.sourceforge.obby4j.User

Creates a new user with the given net6 user ID, user name, obby user ID and color with the color given as hex string.

userJoined(User) - Method in interface net.sourceforge.obby4j.listeners.UserListener

Gets called when a user has joined a session.

UserListener - Interface in net.sourceforge.obby4j.listeners

A listener for clients interested in knowing when a user joins or parts from a session.

userParted(User) - Method in interface net.sourceforge.obby4j.listeners.UserListener

Gets called when a user has parted from a session.

V

valueOf(String) - Static method in enum net.sourceforge.obby4j.DocumentContents.State

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.sourceforge.obby4j.Net6LoginException.ErrorCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.sourceforge.obby4j.Protocol.DocumentKeyword

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum net.sourceforge.obby4j.Protocol.Keyword

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.sourceforge.obby4j.DocumentContents.State

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum net.sourceforge.obby4j.Net6LoginException.ErrorCode

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum net.sourceforge.obby4j.Protocol.DocumentKeyword

Returns an array containing the constants of this enum type, in the order they're declared.

values() - Static method in enum net.sourceforge.obby4j.Protocol.Keyword

Returns an array containing the constants of this enum type, in the order they're declared.

A C D E G H L M N O P R S T U V