From 10d20a2c9846305a40d5ab805ecfc2f6b64af6c2 Mon Sep 17 00:00:00 2001 From: fangyidong Date: Sat, 25 Apr 2015 21:41:44 +0800 Subject: [PATCH] Initial Home page --- Home.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..192c616 --- /dev/null +++ b/Home.md @@ -0,0 +1,55 @@ +=== GitHub === +[https://github.com/fangyidong/json-simple https://github.com/fangyidong/json-simple] + +===Overview=== +JSON.simple is a simple Java toolkit for JSON. You can use JSON.simple to encode or decode JSON text. + +===Features=== + * Full compliance with [http://www.ietf.org/rfc/rfc4627.txt JSON specification] (RFC4627) and reliable (see [ComplianceTesting compliance testing]) + + * Provides multiple functionalities such as encode, decode/parse and escape JSON text while keeping the library lightweight + + * Flexible, simple and easy to use by reusing Map and List interfaces + + * Supports streaming output of JSON text + + * Stoppable SAX-like interface for streaming input of JSON text (learn [http://code.google.com/p/json-simple/wiki/DecodingExamples#Example_5_-_Stoppable_SAX-like_content_handler more]) + + * Heap based parser + + * High performance (see [PerformanceTesting performance testing]) + + * No dependency on external libraries + + * Both of the source code and the binary are JDK1.2 compatible + +===Getting Started=== +Note: You need to put the latest [http://json-simple.googlecode.com/files/json-simple-1.1.1.jar json-simple-1.1.1.jar] in your CLASSPATH before compiling and running the example codes. + + * [EncodingExamples Encoding Examples] + * [DecodingExamples Decoding Examples] + * [EscapingExamples Escaping Examples] + * [JSPAndAJAXExamples JSP and AJAX Examples] + +===Mapping Between JSON and Java Entities=== +|| *JSON* || *Java* || +|| string || java.lang.String || +|| number || java.lang.Number || +|| true|false || java.lang.Boolean || +|| null || null || +|| array || java.util.List || +|| object || java.util.Map || + +JSON.simple maps entities from the left side to the right side while decoding or parsing, and maps entities from the right to the left while encoding. While decoding, default concrete class of java.util.List is org.json.simple.JSONArray and default concrete class of java.util.Map is org.json.simple.JSONObject. While encoding, other classes that are not listed on the right side of the table need to implement [http://code.google.com/p/json-simple/source/browse/trunk/src/org/json/simple/JSONAware.java JSONAware] or [http://code.google.com/p/json-simple/source/browse/trunk/src/org/json/simple/JSONStreamAware.java JSONStreamAware] (streaming only) to [http://code.google.com/p/json-simple/wiki/EncodingExamples#Example_6-1_-_Customize_JSON_outputs customize] JSON outputs. In such cases, JSON.simple calls JSONAware.toJSONString() or JSONStreamAware.writeJSONString() to determine the resulting JSON text. + +===Maven Repository=== + * [JSONSimpleInCentralMavenRepository JSON.simple in central maven repository] + +===Developer's Guide=== + * [BuildWithAnt Build With Ant] + * [BuildWithEclipse Build With Eclipse] + * [Lexer The JSON Lexer] + +===Links==== + * [http://json.org JSON.org] + * [http://json-simple.googlecode.com/files/json_simple.zip Initial version of JSON.simple]