datum API Documentation

datum.protocol
Class Protocol

java.lang.Object
  |
  +--datum.protocol.Protocol

public final class Protocol
extends Object

Contains the version and specifications for the datum.protocol. All reserved characters can be escaped using the ESCAPE character folowed by a corresponding character (like TAB or NEW_LINE).


Field Summary
static char DEFINITION
          The first character of a field name definition message.
static char DELIM
          Delimits fields in a message.
static char ESCAPE
          Denotes that the folowing character should be interpreted as an escape character.
static char FIELD_DELIM
           
static char INDEX_DELIM
          Delimits message types from application defined message name portions.
static String MESSAGE_NAME
          The field name which corresponds to a messages's name.
static char NEW_LINE
          Escapes a new line.
static char TAB
          Escapes a tab.
static String UNKNOWN
          The field name for fields which could not be mapped by the Library to a known name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFINITION

public static final char DEFINITION
The first character of a field name definition message. This constant is '*'.

DELIM

public static final char DELIM
Delimits fields in a message. This constant is the tab character, and will remain unchanged.

INDEX_DELIM

public static final char INDEX_DELIM
Delimits message types from application defined message name portions. This constant is '-'.

FIELD_DELIM

public static final char FIELD_DELIM

ESCAPE

public static final char ESCAPE
Denotes that the folowing character should be interpreted as an escape character. This constant is '\'.

TAB

public static final char TAB
Escapes a tab. This constant is 't'.

NEW_LINE

public static final char NEW_LINE
Escapes a new line. This constant is 'n'.

MESSAGE_NAME

public static final String MESSAGE_NAME
The field name which corresponds to a messages's name.

UNKNOWN

public static final String UNKNOWN
The field name for fields which could not be mapped by the Library to a known name.

Up to datum