Skip to content

Commit

Permalink
- Updated documentation
Browse files Browse the repository at this point in the history
- Updated README
- Updated CHANGELOG

Signed-off-by: Ralph Niemitz <[email protected]>
  • Loading branch information
RalleYTN committed Dec 20, 2017
1 parent 6fe8cf6 commit 3d9448e
Show file tree
Hide file tree
Showing 57 changed files with 224 additions and 145 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# Version 1.1.0

- Added the method `JSONObject#compact()`
- Added the method `JSONObject#toXML(String)`
- Added the method `JSONArray#toXML(String)`


# Version 1.0.0

- Release
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ It was a casting hell. And on top of that, you could not serialize and deseriali
- [x] formatting and minimizing JSON data
- [x] light weight JSON writing
- [x] a `JSONObject` and `JSONArray` class allowing for reading and writing of JSON data even without serializing
- [x] converting JSON into XML

# Requirements

Expand Down
4 changes: 2 additions & 2 deletions docs/allclasses-frame.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:37 CET 2017 -->
<title>All Classes</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions docs/allclasses-noframe.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:37 CET 2017 -->
<title>All Classes</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions docs/constant-values.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:37 CET 2017 -->
<title>Constant Field Values</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand Down
51 changes: 36 additions & 15 deletions docs/de/ralleytn/simple/json/JSONArray.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:36 CET 2017 -->
<title>JSONArray</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand All @@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9,"i28":9,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":9,"i35":9,"i36":9,"i37":9,"i38":9,"i39":9,"i40":9,"i41":9,"i42":9,"i43":9,"i44":10};
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":9,"i20":9,"i21":9,"i22":9,"i23":9,"i24":9,"i25":9,"i26":9,"i27":9,"i28":9,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":9,"i36":9,"i37":9,"i38":9,"i39":9,"i40":9,"i41":9,"i42":9,"i43":9,"i44":9,"i45":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -135,7 +135,7 @@ <h2 title="Class JSONArray" class="title">Class JSONArray</h2>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.0.0</dd>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>1.0.0</dd>
<dd>1.1.0</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>FangYidong([email protected]), Ralph Niemitz/RalleYTN([email protected])</dd>
<dt><span class="seeLabel">See Also:</span></dt>
Expand Down Expand Up @@ -448,76 +448,80 @@ <h3>Method Summary</h3>
</td>
</tr>
<tr id="i34" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#toXML-java.lang.String-">toXML</a></span>(java.lang.String&nbsp;rootName)</code>&nbsp;</td>
</tr>
<tr id="i35" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-boolean:A-java.io.Writer-">writeJSONString</a></span>(boolean[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i35" class="rowColor">
<tr id="i36" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-byte:A-java.io.Writer-">writeJSONString</a></span>(byte[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i36" class="altColor">
<tr id="i37" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-char:A-java.io.Writer-">writeJSONString</a></span>(char[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i37" class="rowColor">
<tr id="i38" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-java.util.Collection-java.io.Writer-">writeJSONString</a></span>(java.util.Collection&lt;?&gt;&nbsp;collection,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode a Collection into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i38" class="altColor">
<tr id="i39" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-double:A-java.io.Writer-">writeJSONString</a></span>(double[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i39" class="rowColor">
<tr id="i40" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-float:A-java.io.Writer-">writeJSONString</a></span>(float[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i40" class="altColor">
<tr id="i41" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-int:A-java.io.Writer-">writeJSONString</a></span>(int[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i41" class="rowColor">
<tr id="i42" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-long:A-java.io.Writer-">writeJSONString</a></span>(long[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i42" class="altColor">
<tr id="i43" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-short:A-java.io.Writer-">writeJSONString</a></span>(short[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i43" class="rowColor">
<tr id="i44" class="altColor">
<td class="colFirst"><code>static &lt;T&gt;&nbsp;void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-T:A-java.io.Writer-">writeJSONString</a></span>(T[]&nbsp;array,
java.io.Writer&nbsp;writer)</code>
<div class="block">Encode an array into JSON text and write it to a Writer.</div>
</td>
</tr>
<tr id="i44" class="altColor">
<tr id="i45" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../de/ralleytn/simple/json/JSONArray.html#writeJSONString-java.io.Writer-">writeJSONString</a></span>(java.io.Writer&nbsp;writer)</code>
<div class="block">Writes a JSON encoded string on a Writer.</div>
Expand Down Expand Up @@ -1720,7 +1724,7 @@ <h4>toObjectArray</h4>
<a name="toArrayArray--">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>toArrayArray</h4>
<pre>public&nbsp;<a href="../../../../de/ralleytn/simple/json/JSONArray.html" title="class in de.ralleytn.simple.json">JSONArray</a>[]&nbsp;toArrayArray()</pre>
Expand All @@ -1733,6 +1737,23 @@ <h4>toArrayArray</h4>
</dl>
</li>
</ul>
<a name="toXML-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toXML</h4>
<pre>public&nbsp;java.lang.String&nbsp;toXML(java.lang.String&nbsp;rootName)</pre>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>rootName</code> - name of the root element</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this JSON array as XML</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1.0</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
4 changes: 2 additions & 2 deletions docs/de/ralleytn/simple/json/JSONAttribute.Type.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:36 CET 2017 -->
<title>JSONAttribute.Type</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions docs/de/ralleytn/simple/json/JSONAttribute.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:36 CET 2017 -->
<title>JSONAttribute</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions docs/de/ralleytn/simple/json/JSONAware.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:36 CET 2017 -->
<title>JSONAware</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions docs/de/ralleytn/simple/json/JSONContainerFactory.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:36 CET 2017 -->
<title>JSONContainerFactory</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down
4 changes: 2 additions & 2 deletions docs/de/ralleytn/simple/json/JSONContentHandler.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:36 CET 2017 -->
<title>JSONContentHandler</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down
6 changes: 3 additions & 3 deletions docs/de/ralleytn/simple/json/JSONFormatter.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_131) on Sun Jul 30 18:33:33 CEST 2017 -->
<!-- Generated by javadoc (1.8.0_131) on Wed Dec 20 18:20:36 CET 2017 -->
<title>JSONFormatter</title>
<meta name="date" content="2017-07-30">
<meta name="date" content="2017-12-20">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -108,7 +108,7 @@ <h2 title="Class JSONFormatter" class="title">Class JSONFormatter</h2>
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="typeNameLabel">JSONFormatter</span>
<pre>public class <span class="typeNameLabel">JSONFormatter</span>
extends java.lang.Object</pre>
<div class="block">Provides static methods for formatting and minimizing JSON data.</div>
<dl>
Expand Down
Loading

0 comments on commit 3d9448e

Please sign in to comment.