From 04f48e8e0560f7c9d4ea883268a3abdbf3bf7d9c Mon Sep 17 00:00:00 2001 From: Mike Buland Date: Wed, 24 Oct 2012 15:41:33 +0000 Subject: Primarily documentation cleanups. Also removed some extra imports that are no longer used. --- java/FileExample.java | 6 +++++- java/com/xagasoft/gats/GatsDictionary.java | 2 +- java/com/xagasoft/gats/GatsInputStream.java | 2 +- java/com/xagasoft/gats/GatsList.java | 4 +--- java/com/xagasoft/gats/GatsOutputStream.java | 10 +++++----- java/com/xagasoft/gats/KeyNotFoundException.java | 8 ++++++++ java/com/xagasoft/gats/package-info.java | 6 +++--- 7 files changed, 24 insertions(+), 14 deletions(-) diff --git a/java/FileExample.java b/java/FileExample.java index 6f180d9..e0db728 100644 --- a/java/FileExample.java +++ b/java/FileExample.java @@ -6,6 +6,10 @@ import java.io.FileOutputStream; import java.io.FileNotFoundException; import java.io.IOException; +/** + * This simple example class shows several ways of constructing a Gats object + * hierarchy and also how to write and read Gats packets to and from streams. + */ class FileExample { public static void writeFile() @@ -15,7 +19,7 @@ class FileExample GatsDictionary root = new GatsDictionary(); - // Automatically determine the type of gats object and insert it + // Automatically determine the type of Gats object and insert it // for you root.put("String", "This is a string"); root.put("Integer", 445 ); diff --git a/java/com/xagasoft/gats/GatsDictionary.java b/java/com/xagasoft/gats/GatsDictionary.java index a980b9d..96a07a7 100644 --- a/java/com/xagasoft/gats/GatsDictionary.java +++ b/java/com/xagasoft/gats/GatsDictionary.java @@ -8,7 +8,7 @@ import java.util.Set; import java.util.Hashtable; /** - * Gats dictionary, or hashtable. This stores any number of items, keyed with + * Gats dictionary, or hash table. This stores any number of items, keyed with * strings. The values can be any valid com.xagasoft.gats.GatsObject decendant * object. This class is often used as the root of complex Gats structures. *

diff --git a/java/com/xagasoft/gats/GatsInputStream.java b/java/com/xagasoft/gats/GatsInputStream.java index 2417018..84fe40b 100644 --- a/java/com/xagasoft/gats/GatsInputStream.java +++ b/java/com/xagasoft/gats/GatsInputStream.java @@ -10,7 +10,7 @@ import java.io.DataInputStream; * the InputStream. *

* At the moment this class will require all data to be available in continuous - * read operations from teh provided InputStream. This means that only complete + * read operations from the provided InputStream. This means that only complete * packets can be read from files on the disk, or that if a socket is provided * it is in blocking or synchronous I/O mode. In java, this should rarely be * an issue. diff --git a/java/com/xagasoft/gats/GatsList.java b/java/com/xagasoft/gats/GatsList.java index 27c4c11..84a9b31 100644 --- a/java/com/xagasoft/gats/GatsList.java +++ b/java/com/xagasoft/gats/GatsList.java @@ -2,12 +2,10 @@ package com.xagasoft.gats; import java.io.InputStream; import java.io.OutputStream; - -import java.util.Arrays; import java.util.Collection; import java.util.Iterator; -import java.util.List; import java.util.LinkedList; +import java.util.List; import java.util.ListIterator; /** diff --git a/java/com/xagasoft/gats/GatsOutputStream.java b/java/com/xagasoft/gats/GatsOutputStream.java index c67d345..c71491b 100644 --- a/java/com/xagasoft/gats/GatsOutputStream.java +++ b/java/com/xagasoft/gats/GatsOutputStream.java @@ -13,10 +13,10 @@ import java.io.DataOutputStream; * Each time you write an object with this class it actually writes a Gats * Packet data structure which consists of a 5 byte header followed by the * encoded GatsObject data. In the packet header is information about which - * version of gats is in use, which options are enabled, etc. This ensures + * version of Gats is in use, which options are enabled, etc. This ensures * that Gats is backward compatible. *

- * According to the GATS standard only fully formed gats packets may be written + * According to the GATS standard only fully formed Gats packets may be written * to files or sockets to ensure integrity and context. Since each packet can * only contain one GatsObject that means that each writeObject call should * write one fully formed message or data structure to ensure maximum @@ -26,9 +26,9 @@ import java.io.DataOutputStream; * it is highly advisable to pass in a BufferedOutputStream or similar structure * to ensure maximum performance. *

- * The gats format stipulates that all zero bytes found in between packets are - * simply ignored, which allows you to pad streams of sequential gats objects - * if necesarry. This can be handy in some encoding/compression/encryption + * The Gats format stipulates that all zero bytes found in between packets are + * simply ignored, which allows you to pad streams of sequential Gats objects + * if necessary. This can be handy in some encoding/compression/encryption * schemes. *@see com.xagasoft.gats.GatsInputStream */ diff --git a/java/com/xagasoft/gats/KeyNotFoundException.java b/java/com/xagasoft/gats/KeyNotFoundException.java index d46fc47..4b75847 100644 --- a/java/com/xagasoft/gats/KeyNotFoundException.java +++ b/java/com/xagasoft/gats/KeyNotFoundException.java @@ -1,5 +1,13 @@ package com.xagasoft.gats; +/** + * This exception is thrown by the container classes in Gats when one of the + * casting helper functions is used to extract a value. In those cases, + * in java we could still potentially return a null (at least if we were + * using object types). This has a couple of advantages when working with + * non-object types, and maintains compatability with other implementations + * of the Gats library. + */ public class KeyNotFoundException extends Exception { private Object oSrc = null; diff --git a/java/com/xagasoft/gats/package-info.java b/java/com/xagasoft/gats/package-info.java index 9f4824e..6feb5f1 100644 --- a/java/com/xagasoft/gats/package-info.java +++ b/java/com/xagasoft/gats/package-info.java @@ -10,11 +10,11 @@ * and compactly. *

  • GATS is arbitrary precision. There is no upper bound on any integers * or floating point values stored in gats.
    • - *
  • GATS is platform, language, and endiness agnostic. Data transmitted or + *
  • GATS is platform, language, and endianness agnostic. Data transmitted or * stored using GATS can be received, read, and used on any platform * without worries. The binary format of GATS does not change - * dependant on the archetecture.
    • - *
  • GATS gurantees no loss of precision for floating point numbers. When + * dependent on the architecture.
    • + *
  • GATS guarantees no loss of precision for floating point numbers. When * storing floating point numbers a binary format similar to that employed * by computer hardware is used. All exceptional cases are also preserved, * including +/- infinity, NaN, etc.
    • -- cgit v1.2.3