net.sourceforge.obby4j
Enum Protocol.Keyword

java.lang.Object
  java.lang.Enum<Protocol.Keyword>
      net.sourceforge.obby4j.Protocol.Keyword

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Protocol.Keyword>

Enclosing class:

Protocol

public static enum Protocol.Keyword
extends java.lang.Enum<Protocol.Keyword>

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

Enum Constant Summary

net6_client_join
Parameters: net6 user id, user name, obby user id, user color

net6_client_login
Parameters: user name, user color

net6_client_part
Parameters: obby user ID

net6_login_failed
Parameters: net6/obby error code

obby_document
Parameters: document ID, [several sub commands]

obby_document_create
Parameters: obby user ID (author), author document index, document name

obby_message
Parameters by client: chat message

obby_sync_doclist_document
Parameters: obby user ID (author), author document index, document name

obby_sync_final
No parameters.

obby_sync_init
Parameters: number of lines to sync (both users and documents)

obby_sync_usertable_user
Parameters: obby user ID, user name, user color

obby_welcome
Parameters: protocol version, encryption key stuff I (?), encryption key stuff II (?), encryption key stuff III (?)

Method Summary

static Protocol.Keyword	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Protocol.Keyword[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

net6_client_join

public static final Protocol.Keyword net6_client_join

Parameters: net6 user id, user name, obby user id, user color

Sent by server only.

net6_client_login

public static final Protocol.Keyword net6_client_login

Parameters: user name, user color

Sent by client only.

net6_client_part

public static final Protocol.Keyword net6_client_part

Parameters: obby user ID

Sent by server only.

net6_login_failed

public static final Protocol.Keyword net6_login_failed

Parameters: net6/obby error code

Sent by server only.

See Also:

Net6LoginException.ErrorCode

obby_document

public static final Protocol.Keyword obby_document

Parameters: document ID, [several sub commands]

See Also:

Protocol.DocumentKeyword

obby_document_create

public static final Protocol.Keyword obby_document_create

Parameters: obby user ID (author), author document index, document name

Sent by server only.

obby_message

public static final Protocol.Keyword obby_message

Parameters by client: chat message

Parameters by server: obby user ID, chat message

Sent by both client and server.

obby_sync_doclist_document

public static final Protocol.Keyword obby_sync_doclist_document

Parameters: obby user ID (author), author document index, document name

Sent by server only.

obby_sync_final

public static final Protocol.Keyword obby_sync_final

No parameters.

Sent by server only.

obby_sync_init

public static final Protocol.Keyword obby_sync_init

Parameters: number of lines to sync (both users and documents)

Sent by server only.

obby_sync_usertable_user

public static final Protocol.Keyword obby_sync_usertable_user

Parameters: obby user ID, user name, user color

Sent by server only.

obby_welcome

public static final Protocol.Keyword obby_welcome

Parameters: protocol version, encryption key stuff I (?), encryption key stuff II (?), encryption key stuff III (?)

Sent by server only.

Method Detail

valueOf

public static Protocol.Keyword valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

values

public static final Protocol.Keyword[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(Protocol.Keyword c : Protocol.Keyword.values())
        System.out.println(c);

Returns:

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