JSONzip (org.json 20131017 API)

java.lang.Object
- org.json.zip.JSONzip

All Implemented Interfaces:

None, PostMortem

Direct Known Subclasses:

Compressor, Decompressor
```
public abstract class JSONzip
extends Object
implements None, PostMortem
```
JSONzip is a binary-encoded JSON dialect. It is designed to compress the messages in a session. It is adaptive, so with each message seen, it should improve its compression. It minimizes JSON's overhead, reducing punctuation to a small number of bits. It uses Huffman encoding to reduce the average size of characters. It uses caches (or Keeps) to keep recently seen strings and values, so repetitive content (such as object keys) can be substantially reduced. It uses a character encoding called Kim (Keep it minimal) that is smaller than UTF-8 for most East European, African, and Asian scripts. JSONzip tends to reduce most content by about half. If there is a lot of recurring information, the reduction can be much more dramatic. FOR EVALUATION PURPOSES ONLY. THIS PACKAGE HAS NOT YET BEEN TESTED ADEQUATELY FOR PRODUCTION USE.

Version:

2013-04-18

Author:

JSON.org

Field Summary

Fields
Modifier and Type	Field and Description
`static byte[]`	`bcd` The characters in JSON numbers can be reduced to 4 bits each.
`static int`	`end` The end of string code.
`static int`	`endOfNumber` The end of number code.
`static long`	`int14` The number of integers that can be encoded in 14 bits.
`static long`	`int4` The number of integers that can be encoded in 4 bits.
`static long`	`int7` The number of integers that can be encoded in 7 bits.
`static int`	`maxSubstringLength` The maximum substring length when registering many.
`static int`	`minSubstringLength` The minimum substring length.
`protected Huff`	`namehuff` A Huffman encoder for names.
`protected org.json.zip.MapKeep`	`namekeep` A place to keep the names (keys).
`static boolean`	`probe` The package supports tracing for debugging.
`protected org.json.zip.MapKeep`	`stringkeep` A place to keep the strings.
`protected Huff`	`substringhuff` A Huffman encoder for string values.
`protected org.json.zip.TrieKeep`	`substringkeep` A place to keep the strings.
`static int`	`substringLimit` The maximum number of substrings added to the substrings keep per string.
`static int[]`	`twos` Powers of 2.
`protected org.json.zip.MapKeep`	`values` A place to keep the values.
`static int`	`zipArrayString` The value code for an array with a string as its first element.
`static int`	`zipArrayValue` The value code for an array with a non-string value as its first element.
`static int`	`zipEmptyArray` The value code for an empty array.
`static int`	`zipEmptyObject` The value code for an empty object.
`static int`	`zipFalse` The value code for false.
`static int`	`zipNull` The value code for null.
`static int`	`zipObject` The value code for a non-empty object.
`static int`	`zipTrue` The value code for true.

Fields inherited from interface org.json.zip.None
none

Constructor Summary

Constructors
Modifier Constructor and Description

protected JSONzip()
Initialize the data structures.

Constructors
Modifier	Constructor and Description
`protected`	`JSONzip()` Initialize the data structures.

Method Summary

Methods
Modifier and Type Method and Description

protected void begin()

boolean postMortem(PostMortem pm)
This method is used for testing the implementation of JSONzip.
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods
Modifier and Type	Method and Description
`protected void`	`begin()`
`boolean`	`postMortem(PostMortem pm)` This method is used for testing the implementation of JSONzip.

- Field Detail
  - twos
```
public static final int[] twos
```
    Powers of 2.
  - bcd
```
public static final byte[] bcd
```
    The characters in JSON numbers can be reduced to 4 bits each.
  - int4
```
public static final long int4
```
    The number of integers that can be encoded in 4 bits.
    
    See Also:
    Constant Field Values
  - int7
```
public static final long int7
```
    The number of integers that can be encoded in 7 bits.
    
    See Also:
    Constant Field Values
  - int14
```
public static final long int14
```
    The number of integers that can be encoded in 14 bits.
    
    See Also:
    Constant Field Values
  - end
```
public static final int end
```
    The end of string code.
    
    See Also:
    Constant Field Values
  - endOfNumber
```
public static final int endOfNumber
```
    The end of number code.
  - maxSubstringLength
```
public static final int maxSubstringLength
```
    The maximum substring length when registering many. The registration of one substring may be longer.
    
    See Also:
    Constant Field Values
  - minSubstringLength
```
public static final int minSubstringLength
```
    The minimum substring length.
    
    See Also:
    Constant Field Values
  - probe
```
public static final boolean probe
```
    The package supports tracing for debugging.
    
    See Also:
    Constant Field Values
  - substringLimit
```
public static final int substringLimit
```
    The maximum number of substrings added to the substrings keep per string.
    
    See Also:
    Constant Field Values
  - zipEmptyObject
```
public static final int zipEmptyObject
```
    The value code for an empty object.
    
    See Also:
    Constant Field Values
  - zipEmptyArray
```
public static final int zipEmptyArray
```
    The value code for an empty array.
    
    See Also:
    Constant Field Values
  - zipTrue
```
public static final int zipTrue
```
    The value code for true.
    
    See Also:
    Constant Field Values
  - zipFalse
```
public static final int zipFalse
```
    The value code for false.
    
    See Also:
    Constant Field Values
  - zipNull
```
public static final int zipNull
```
    The value code for null.
    
    See Also:
    Constant Field Values
  - zipObject
```
public static final int zipObject
```
    The value code for a non-empty object.
    
    See Also:
    Constant Field Values
  - zipArrayString
```
public static final int zipArrayString
```
    The value code for an array with a string as its first element.
    
    See Also:
    Constant Field Values
  - zipArrayValue
```
public static final int zipArrayValue
```
    The value code for an array with a non-string value as its first element.
    
    See Also:
    Constant Field Values
  - namehuff
```
protected final Huff namehuff
```
    A Huffman encoder for names.
  - namekeep
```
protected final org.json.zip.MapKeep namekeep
```
    A place to keep the names (keys).
  - stringkeep
```
protected final org.json.zip.MapKeep stringkeep
```
    A place to keep the strings.
  - substringhuff
```
protected final Huff substringhuff
```
    A Huffman encoder for string values.
  - substringkeep
```
protected final org.json.zip.TrieKeep substringkeep
```
    A place to keep the strings.
  - values
```
protected final org.json.zip.MapKeep values
```
    A place to keep the values.
- Constructor Detail
  - JSONzip
```
protected JSONzip()
```
    Initialize the data structures.
- Method Detail
  - begin
```
protected void begin()
```
  - postMortem
```
public boolean postMortem(PostMortem pm)
```
    This method is used for testing the implementation of JSONzip. It is not suitable for any other purpose. It is used to compare a Compressor and a Decompressor, verifying that the data structures that were built during zipping and unzipping were the same.
    
    Specified by:
    
    postMortem in interface PostMortem
    
    Parameters:
    pm - Another object of the same type.
    
    Returns:
    true if the structures match.

Class JSONzip

Field Summary

Fields inherited from interface org.json.zip.None

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

twos

bcd

int4

int7

int14

end

endOfNumber

maxSubstringLength

minSubstringLength

probe

substringLimit

zipEmptyObject

zipEmptyArray

zipTrue

zipFalse

zipNull

zipObject

zipArrayString

zipArrayValue

namehuff

namekeep

stringkeep

substringhuff

substringkeep

values

Constructor Detail

JSONzip

Method Detail

begin

postMortem