Lots of documentation, an example program, and also some visibility cleanup.

1 files changed, 27 insertions, 3 deletions

diff --git a/java/com/xagasoft/gats/GatsObject.java b/java/com/xagasoft/gats/GatsObject.java
index 8c398e8..fc3fb5a 100644
--- a/java/com/xagasoft/gats/GatsObject.java
+++ b/java/com/xagasoft/gats/GatsObject.java
@@ -3,6 +3,13 @@ package com.xagasoft.gats;
 import java.io.InputStream;
 import java.io.OutputStream;
 
+/**
+ * The abstract base class of all Gats storage classes.  You probably don't
+ * need to worry about these functions at all, maybe getType.  The IO functions
+ * in this class shouldn't really be used since they won't contain the proper
+ * packet header info.  See com.xagasoft.gats.GatsOutputStream and
+ * com.xagasoft.gats.GatsInputStream for that.
+ */
 public abstract class GatsObject
 {
         public final static int INTEGER = 1;
@@ -12,12 +19,29 @@ public abstract class GatsObject
         public final static int DICTIONARY = 5;
         public final static int BOOLEAN = 6;
 
+        /**
+         * Gets the type of the current object, type can be one of INTEGER, FLOAT,
+         * STRING, LIST, DICTIONARY, or BOOLEAN.
+         */
         public abstract int getType();
 
-        public abstract void read( InputStream is, char cType ) throws java.io.IOException;
-        public abstract void write( OutputStream os ) throws java.io.IOException;
+        /**
+         * Read an object from the given input stream, with a particular type, this
+         * function is used internally.
+         */
+        abstract void read( InputStream is, char cType ) throws java.io.IOException;
 
-        public static GatsObject read( InputStream is ) throws java.io.IOException
+        /**
+         * Write the current object to the output stream.
+         */
+        abstract void write( OutputStream os ) throws java.io.IOException;
+
+        /**
+         * Static function that returns a new object deserialized from an input
+         * stream.  This still doesn't take advantage of packet data, so you
+         * probably shouldn't use this yourself.
+         */
+        static GatsObject read( InputStream is ) throws java.io.IOException
         {
                 char type = (char)is.read();
                 GatsObject goRet = null;