diff options
Diffstat (limited to 'java/com/xagasoft')
-rw-r--r-- | java/com/xagasoft/gats/GatsDictionary.java | 2 | ||||
-rw-r--r-- | java/com/xagasoft/gats/GatsInputStream.java | 2 | ||||
-rw-r--r-- | java/com/xagasoft/gats/GatsList.java | 4 | ||||
-rw-r--r-- | java/com/xagasoft/gats/GatsOutputStream.java | 10 | ||||
-rw-r--r-- | java/com/xagasoft/gats/KeyNotFoundException.java | 8 | ||||
-rw-r--r-- | java/com/xagasoft/gats/package-info.java | 6 |
6 files changed, 19 insertions, 13 deletions
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; | |||
8 | import java.util.Hashtable; | 8 | import java.util.Hashtable; |
9 | 9 | ||
10 | /** | 10 | /** |
11 | * Gats dictionary, or hashtable. This stores any number of items, keyed with | 11 | * Gats dictionary, or hash table. This stores any number of items, keyed with |
12 | * strings. The values can be any valid com.xagasoft.gats.GatsObject decendant | 12 | * strings. The values can be any valid com.xagasoft.gats.GatsObject decendant |
13 | * object. This class is often used as the root of complex Gats structures. | 13 | * object. This class is often used as the root of complex Gats structures. |
14 | * <p> | 14 | * <p> |
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; | |||
10 | * the InputStream. | 10 | * the InputStream. |
11 | * <p> | 11 | * <p> |
12 | * At the moment this class will require all data to be available in continuous | 12 | * At the moment this class will require all data to be available in continuous |
13 | * read operations from teh provided InputStream. This means that only complete | 13 | * read operations from the provided InputStream. This means that only complete |
14 | * packets can be read from files on the disk, or that if a socket is provided | 14 | * packets can be read from files on the disk, or that if a socket is provided |
15 | * it is in blocking or synchronous I/O mode. In java, this should rarely be | 15 | * it is in blocking or synchronous I/O mode. In java, this should rarely be |
16 | * an issue. | 16 | * 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; | |||
2 | 2 | ||
3 | import java.io.InputStream; | 3 | import java.io.InputStream; |
4 | import java.io.OutputStream; | 4 | import java.io.OutputStream; |
5 | |||
6 | import java.util.Arrays; | ||
7 | import java.util.Collection; | 5 | import java.util.Collection; |
8 | import java.util.Iterator; | 6 | import java.util.Iterator; |
9 | import java.util.List; | ||
10 | import java.util.LinkedList; | 7 | import java.util.LinkedList; |
8 | import java.util.List; | ||
11 | import java.util.ListIterator; | 9 | import java.util.ListIterator; |
12 | 10 | ||
13 | /** | 11 | /** |
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; | |||
13 | * Each time you write an object with this class it actually writes a Gats | 13 | * Each time you write an object with this class it actually writes a Gats |
14 | * Packet data structure which consists of a 5 byte header followed by the | 14 | * Packet data structure which consists of a 5 byte header followed by the |
15 | * encoded GatsObject data. In the packet header is information about which | 15 | * encoded GatsObject data. In the packet header is information about which |
16 | * version of gats is in use, which options are enabled, etc. This ensures | 16 | * version of Gats is in use, which options are enabled, etc. This ensures |
17 | * that Gats is backward compatible. | 17 | * that Gats is backward compatible. |
18 | * <p> | 18 | * <p> |
19 | * According to the GATS standard only fully formed gats packets may be written | 19 | * According to the GATS standard only fully formed Gats packets may be written |
20 | * to files or sockets to ensure integrity and context. Since each packet can | 20 | * to files or sockets to ensure integrity and context. Since each packet can |
21 | * only contain one GatsObject that means that each writeObject call should | 21 | * only contain one GatsObject that means that each writeObject call should |
22 | * write one fully formed message or data structure to ensure maximum | 22 | * write one fully formed message or data structure to ensure maximum |
@@ -26,9 +26,9 @@ import java.io.DataOutputStream; | |||
26 | * it is highly advisable to pass in a BufferedOutputStream or similar structure | 26 | * it is highly advisable to pass in a BufferedOutputStream or similar structure |
27 | * to ensure maximum performance. | 27 | * to ensure maximum performance. |
28 | * <p> | 28 | * <p> |
29 | * The gats format stipulates that all zero bytes found in between packets are | 29 | * The Gats format stipulates that all zero bytes found in between packets are |
30 | * simply ignored, which allows you to pad streams of sequential gats objects | 30 | * simply ignored, which allows you to pad streams of sequential Gats objects |
31 | * if necesarry. This can be handy in some encoding/compression/encryption | 31 | * if necessary. This can be handy in some encoding/compression/encryption |
32 | * schemes. | 32 | * schemes. |
33 | *@see com.xagasoft.gats.GatsInputStream | 33 | *@see com.xagasoft.gats.GatsInputStream |
34 | */ | 34 | */ |
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 @@ | |||
1 | package com.xagasoft.gats; | 1 | package com.xagasoft.gats; |
2 | 2 | ||
3 | /** | ||
4 | * This exception is thrown by the container classes in Gats when one of the | ||
5 | * casting helper functions is used to extract a value. In those cases, | ||
6 | * in java we could still potentially return a null (at least if we were | ||
7 | * using object types). This has a couple of advantages when working with | ||
8 | * non-object types, and maintains compatability with other implementations | ||
9 | * of the Gats library. | ||
10 | */ | ||
3 | public class KeyNotFoundException extends Exception | 11 | public class KeyNotFoundException extends Exception |
4 | { | 12 | { |
5 | private Object oSrc = null; | 13 | 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 @@ | |||
10 | * and compactly.</li> | 10 | * and compactly.</li> |
11 | * <li>GATS is arbitrary precision. There is no upper bound on any integers | 11 | * <li>GATS is arbitrary precision. There is no upper bound on any integers |
12 | * or floating point values stored in gats.</li> | 12 | * or floating point values stored in gats.</li> |
13 | * <li>GATS is platform, language, and endiness agnostic. Data transmitted or | 13 | * <li>GATS is platform, language, and endianness agnostic. Data transmitted or |
14 | * stored using GATS can be received, read, and used on any platform | 14 | * stored using GATS can be received, read, and used on any platform |
15 | * without worries. The binary format of GATS does <b>not</b> change | 15 | * without worries. The binary format of GATS does <b>not</b> change |
16 | * dependant on the archetecture.</li> | 16 | * dependent on the architecture.</li> |
17 | * <li>GATS gurantees no loss of precision for floating point numbers. When | 17 | * <li>GATS guarantees no loss of precision for floating point numbers. When |
18 | * storing floating point numbers a binary format similar to that employed | 18 | * storing floating point numbers a binary format similar to that employed |
19 | * by computer hardware is used. All exceptional cases are also preserved, | 19 | * by computer hardware is used. All exceptional cases are also preserved, |
20 | * including +/- infinity, NaN, etc.</li> | 20 | * including +/- infinity, NaN, etc.</li> |