Backups/JSON-java
1
0
Fork 0
mirror of https://github.com/stleary/JSON-java.git synced 2025-08-02 11:05:28 -04:00
Code Issues Projects Releases Wiki Activity

Minor Adjustments Example.md

Browse Source 
Added syntax highlighting, standardised indentation
This commit is contained in:
TheCommandBlock 2022-10-06 00:48:34 +02:00 committed by GitHub
parent 8439039da7
commit 61801c623e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 285 additions and 285 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

570
Examples.md
View File

@ -1,7 +1,7 @@
<h1>Examples</h1> <h1>Examples</h1>
<p>Imports used in the examples: </p> <p>Imports used in the examples: </p>
``` ```java
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.Properties; import java.util.Properties;
@ -14,208 +14,208 @@ import java.util.Properties;
<h3>Using JSONArray</h3> <h3>Using JSONArray</h3>
``` ```java
private static void JSONExampleArray1() { private static void JSONExampleArray1() {
//We create a JSONObject from a String containing an array using JSONArray //We create a JSONObject from a String containing an array using JSONArray
//Firstly, we declare an Array in a String //Firstly, we declare an Array in a String
String arrayStr = String arrayStr =
"["+"true,"+"false,"+ "\"true\","+ "\"false\","+"\"hello\","+"23.45e-4,"+ "["+"true,"+"false,"+ "\"true\","+ "\"false\","+"\"hello\","+"23.45e-4,"+
"\"23.45\","+"42,"+"\"43\","+"["+"\"world\""+"],"+ "\"23.45\","+"42,"+"\"43\","+"["+"\"world\""+"],"+
"{"+ "{"+
"\"key1\":\"value1\","+ "\"key1\":\"value1\","+
"\"key2\":\"value2\","+ "\"key2\":\"value2\","+
"\"key3\":\"value3\","+ "\"key3\":\"value3\","+
"\"key4\":\"value4\""+ "\"key4\":\"value4\""+
"},"+ "},"+
"0,"+"\"-1\""+ "0,"+"\"-1\""+
"]"; "]";
//Then, we initializate the JSONArray thanks to its constructor //Then, we initializate the JSONArray thanks to its constructor
JSONArray array = new JSONArray(arrayStr); JSONArray array = new JSONArray(arrayStr);
System.out.println("Values array: "+ array); System.out.println("Values array: "+ array);
//We convert that array into a JSONObject, but first, we need the labels, so we need another JSONArray with the labels. //We convert that array into a JSONObject, but first, we need the labels, so we need another JSONArray with the labels.
//Here we will use an auxiliary function to get one for the example. //Here we will use an auxiliary function to get one for the example.
JSONArray list = listNumberArray(array.length()); JSONArray list = listNumberArray(array.length());
System.out.println("Label Array: "+ list.toString()); System.out.println("Label Array: "+ list.toString());
//Now, we construct the JSONObject using both the value array and the label array. //Now, we construct the JSONObject using both the value array and the label array.
JSONObject object = array.toJSONObject(list); JSONObject object = array.toJSONObject(list);
System.out.println("Final JSONOBject: " + object); System.out.println("Final JSONOBject: " + object);
} }
//This method creates an JSONArray of labels in which those are generated by their positions //This method creates an JSONArray of labels in which those are generated by their positions
private static JSONArray listNumberArray(int max){ private static JSONArray listNumberArray(int max){
JSONArray res = new JSONArray(); JSONArray res = new JSONArray();
for (int i=0; i<max;i++) { for (int i=0; i<max;i++) {
//The value of the labels must be an String in order to make it work //The value of the labels must be an String in order to make it work
res.put(String.valueOf(i)); res.put(String.valueOf(i));
}
return res;
} }
return res;
}
``` ```
``` ```java
private static void JSONExampleArray2() { private static void JSONExampleArray2() {
//We can also create an Array without a String by creating an empty array and adding elements to it //We can also create an Array without a String by creating an empty array and adding elements to it
JSONArray array = new JSONArray(); JSONArray array = new JSONArray();
//Adding elements with .put() //Adding elements with .put()
array.put("value"); array.put("value");
array.put(5); array.put(5);
array.put(-23.45e67); array.put(-23.45e67);
array.put(true); array.put(true);
//We convert it to JSONObject providing a label arrray like last time
JSONArray list = listNumberArray(array.length()); //We convert it to JSONObject providing a label arrray like last time
JSONObject object = array.toJSONObject(list);
System.out.println("Final JSONOBject: " + object); JSONArray list = listNumberArray(array.length());
} JSONObject object = array.toJSONObject(list);
System.out.println("Final JSONOBject: " + object);
}
``` ```
<h3>Using JSONStringer</h3> <h3>Using JSONStringer</h3>
``` ```java
private static void JSONExampleStringer() { private static void JSONExampleStringer() {
//We initializate the JSONStringer //We initializate the JSONStringer
JSONStringer jsonStringer = new JSONStringer(); JSONStringer jsonStringer = new JSONStringer();
//Now we start the process of adding elements with .object() //Now we start the process of adding elements with .object()
jsonStringer.object(); jsonStringer.object();
//We can now add elements as keys and values with .values () and .key() //We can now add elements as keys and values with .values () and .key()
jsonStringer.key("trueValue").value(true); jsonStringer.key("trueValue").value(true);
jsonStringer.key("falseValue").value(false); jsonStringer.key("falseValue").value(false);
jsonStringer.key("nullValue").value(null); jsonStringer.key("nullValue").value(null);
jsonStringer.key("stringValue").value("hello world!"); jsonStringer.key("stringValue").value("hello world!");
jsonStringer.key("complexStringValue").value("h\be\tllo w\u1234orld!"); jsonStringer.key("complexStringValue").value("h\be\tllo w\u1234orld!");
jsonStringer.key("intValue").value(42); jsonStringer.key("intValue").value(42);
jsonStringer.key("doubleValue").value(-23.45e67); jsonStringer.key("doubleValue").value(-23.45e67);
//We end this prcedure with .ednObject //We end this prcedure with .ednObject
jsonStringer.endObject(); jsonStringer.endObject();
//Once we have a JSONStringer, we convert it to JSONObject generating a String and using JSONObject's contructor. //Once we have a JSONStringer, we convert it to JSONObject generating a String and using JSONObject's contructor.
String str = jsonStringer.toString(); String str = jsonStringer.toString();
JSONObject jsonObject = new JSONObject(str); JSONObject jsonObject = new JSONObject(str);
System.out.println("Final JSONOBject: " + jsonObject); System.out.println("Final JSONOBject: " + jsonObject);
} }
``` ```
<h3>Using JSONObject</h3> <h3>Using JSONObject</h3>
```java
private static void JSONExampleObject1() {
//We can create a JSONObject from a String with the class builder
String string = "{\"0\":\"value\",\"1\":5,\"2\":-2.345E68,\"3\":true}";
JSONObject example = new JSONObject(string);
System.out.println("Final JSONObject: " + example);
}
``` ```
private static void JSONExampleObject1() { ```java
private static void JSONExampleObject2() {
//We can create a JSONObject from a String with the class builder //We can also create a JSONObject directly without messing around with any of the other functions.
String string = "{\"0\":\"value\",\"1\":5,\"2\":-2.345E68,\"3\":true}"; JSONObject example = new JSONObject();
JSONObject example = new JSONObject(string);
System.out.println("Final JSONObject: " + example);
//Now we add the keys and values in a similar way as the Stringer method
} example.put("key", "value");
//As you can see, the first entry is the key and the second would be its associeted value.
example.put("key2", 5);
example.put("key3", -23.45e67);
example.put("trueValue", true);
//We can't add null values thougth
//example.put("nullValue", null); //This is not possible
System.out.println("Final JSONOBject: " + example);
}
``` ```
``` ```java
private static void JSONExampleObject2() { private static void JSONExampleObject3() {
//We can also create a JSONObject directly without messing around with any of the other functions. //We can also create a JSONObject with a Java Map
//YoU will need a Map whose keys are Strings. The values can be whatever you want
JSONObject example = new JSONObject(); Map<String,Double> map = new HashMap<String, Double>();
map.put("key1", 1.0);
map.put("key2", -23.45e67);
//Now we add the keys and values in a similar way as the Stringer method //We create the JSONObject with the map with its class builder
example.put("key", "value");
//As you can see, the first entry is the key and the second would be its associeted value. JSONObject example = new JSONObject(map);
System.out.println("Final JSONOBject: " + example);
example.put("key2", 5); }
example.put("key3", -23.45e67);
example.put("trueValue", true);
//We can't add null values thougth
//example.put("nullValue", null); //This is not possible
System.out.println("Final JSONOBject: " + example);
}
```
```
private static void JSONExampleObject3() {
//We can also create a JSONObject with a Java Map
//YoU will need a Map whose keys are Strings. The values can be whatever you want
Map<String,Double> map = new HashMap<String, Double>();
map.put("key1", 1.0);
map.put("key2", -23.45e67);
//We create the JSONObject with the map with its class builder
JSONObject example = new JSONObject(map);
System.out.println("Final JSONOBject: " + example);
}
``` ```
<h3>Using JSONWriter</h3> <h3>Using JSONWriter</h3>
``` ```java
private static void JSONExamplWriter() { private static void JSONExamplWriter() {
//This method works in a very similar way to Object and Stringer in the construction of the JSON. //This method works in a very similar way to Object and Stringer in the construction of the JSON.
//The difference is that it needs a Java object called "Appendable" like StringBuilder //The difference is that it needs a Java object called "Appendable" like StringBuilder
StringBuilder write = new StringBuilder(); StringBuilder write = new StringBuilder();
JSONWriter jsonWriter = new JSONWriter(write); JSONWriter jsonWriter = new JSONWriter(write);
//We behave now the same way as Stringer //We behave now the same way as Stringer
jsonWriter.object(); jsonWriter.object();
jsonWriter.key("trueValue").value(true); jsonWriter.key("trueValue").value(true);
jsonWriter.key("falseValue").value(false); jsonWriter.key("falseValue").value(false);
jsonWriter.key("nullValue").value(null); jsonWriter.key("nullValue").value(null);
jsonWriter.key("stringValue").value("hello world!"); jsonWriter.key("stringValue").value("hello world!");
jsonWriter.key("complexStringValue").value("h\be\tllo w\u1234orld!"); jsonWriter.key("complexStringValue").value("h\be\tllo w\u1234orld!");
jsonWriter.key("intValue").value(42); jsonWriter.key("intValue").value(42);
jsonWriter.key("doubleValue").value(-23.45e67); jsonWriter.key("doubleValue").value(-23.45e67);
jsonWriter.endObject(); jsonWriter.endObject();
//The resoult should be in the "write" object //The resoult should be in the "write" object
System.out.println("JSON: " + write.toString()); System.out.println("JSON: " + write.toString());
//The difference is that we don't get a JSONObject in this one. //The difference is that we don't get a JSONObject in this one.
} }
``` ```
``` ```java
private static void JSONExampleTokener() { private static void JSONExampleTokener() {
//A partir de una String podemos crear un JSONTokener, que lo podemos usar alternativamente para JSONArray,JSONObject //A partir de una String podemos crear un JSONTokener, que lo podemos usar alternativamente para JSONArray,JSONObject
String string = "this is not a valid JSON string"; String string = "this is not a valid JSON string";
JSONTokener token = new JSONTokener(string); JSONTokener token = new JSONTokener(string);
//Now you can use the token in JSONObject and Array the same way as a String
JSONObject object = new JSONObject(token); //Now you can use the token in JSONObject and Array the same way as a String
JSONArray array = new JSONArray(token);
JSONObject object = new JSONObject(token);
} JSONArray array = new JSONArray(token);
}
``` ```
<h2>Part 2: Conversion methods</h2> <h2>Part 2: Conversion methods</h2>
<p>We don't need to have a JSON document to work. This project also admits conversions from other type of files.</p> <p>We don't need to have a JSON document to work. This project also admits conversions from other type of files.</p>
@ -223,144 +223,144 @@ import java.util.Properties;
<h3>Extra: Conversion to JSONArray</h3> <h3>Extra: Conversion to JSONArray</h3>
``` ```java
private static void JSONObjectToArray() { private static void JSONObjectToArray() {
//We start with a JSONObject //We start with a JSONObject
String string = "{\"0\":\"value\",\"1\":5,\"2\":-2.345E68,\"3\":true}"; String string = "{\"0\":\"value\",\"1\":5,\"2\":-2.345E68,\"3\":true}";
JSONObject example = new JSONObject(string); JSONObject example = new JSONObject(string);
//We need a list of key strings like the reverse operation //We need a list of key strings like the reverse operation
JSONArray keyStrings = listNumberArray(example.length()); JSONArray keyStrings = listNumberArray(example.length());
//Then we convert to the Array using both elelements //Then we convert to the Array using both elelements
JSONArray array = example.toJSONArray(keyStrings); JSONArray array = example.toJSONArray(keyStrings);
System.out.println("Final JSONArray: " + array); System.out.println("Final JSONArray: " + array);
} }
``` ```
<h3>XML Conversions</h3> <h3>XML Conversions</h3>
``` ```java
private static void XMLToExampleConversion() { private static void XMLToExampleConversion() {
//We start with a JSONObject //We start with a JSONObject
String string = "{\"0\":\"value\",\"1\":5,\"2\":-2.345E68,\"3\":true}";
JSONObject example = new JSONObject(string);
//We obtain a String with XML format with toString() String string = "{\"0\":\"value\",\"1\":5,\"2\":-2.345E68,\"3\":true}";
JSONObject example = new JSONObject(string);
String output = XML.toString(example); //We obtain a String with XML format with toString()
System.out.println("Final XML: " + output);
} String output = XML.toString(example);
System.out.println("Final XML: " + output);
}
``` ```
``` ```java
private static void XMLFromExampleConversion() { private static void XMLFromExampleConversion() {
//We start with a string with the XML format //We start with a string with the XML format
String string = "<0>value</0><1>5</1><2>-2.345E+68</2><3>true</3>"; String string = "<0>value</0><1>5</1><2>-2.345E+68</2><3>true</3>";
//We obtain a JSONObject with toJSONOBject() //We obtain a JSONObject with toJSONOBject()
JSONObject output = XML.toJSONObject(string); JSONObject output = XML.toJSONObject(string);
System.out.println("Final JSONObject: " + output); System.out.println("Final JSONObject: " + output);
} }
``` ```
<h3>Cookie Conversions</h3> <h3>Cookie Conversions</h3>
```java
private static void CookieToExampleConversion() {
//We start with a JSONObject
//The JSONOBject needs to entries that gives the cookie a name and gives the field "name" a name too.
//The Cokkie format doesn't support booleans
String string = "{\"name\":\"Cookie-Name\",\"value\":\"name\",\"1\":5,\"2\":-2.345E68,\"3\":'true'}";
JSONObject example = new JSONObject(string);
//We obtain a String with Cookie format with toString()
String output = Cookie.toString(example);
System.out.println("Final Cookie: " + output);
}
``` ```
private static void CookieToExampleConversion() { ```java
private static void CookieFromExampleConversion() {
//We start with a JSONObject //We start with a string with the Cookie format
//The JSONOBject needs to entries that gives the cookie a name and gives the field "name" a name too.
//The Cokkie format doesn't support booleans
String string = "{\"name\":\"Cookie-Name\",\"value\":\"name\",\"1\":5,\"2\":-2.345E68,\"3\":'true'}"; String string = "Cookie-Name=name;1=5;2=-2.345E%2b68;3=true";
JSONObject example = new JSONObject(string);
//We obtain a String with Cookie format with toString()
String output = Cookie.toString(example); //We obtain a JSONObject with toJSONOBject()
System.out.println("Final Cookie: " + output);
}
```
```
private static void CookieFromExampleConversion() {
//We start with a string with the Cookie format JSONObject output = Cookie.toJSONObject(string);
System.out.println("Final JSONObject: " + output);
String string = "Cookie-Name=name;1=5;2=-2.345E%2b68;3=true"; }
//We obtain a JSONObject with toJSONOBject()
JSONObject output = Cookie.toJSONObject(string);
System.out.println("Final JSONObject: " + output);
}
``` ```
<h3>HTTP Conversions</h3> <h3>HTTP Conversions</h3>
```java
private static void HTTPToExampleConversion() {
//We start with a JSONObject
//The JSONObject must have the minimun header for a HTTP request or header
String string = "{\"Method\":\"POST\",\"Request-URI\":'/',\"HTTP-Version\":'HTTP/1.1',\"Value1\":true,\"Value2\":2,\"Value3\":-2.345E68}";
JSONObject example = new JSONObject(string);
//We obtain a String with HTTP format with toString()
String output = HTTP.toString(example);
System.out.println("Final HTTP: " + output);
}
``` ```
private static void HTTPToExampleConversion() { ```java
private static void HTTPFromExampleConversion() {
//We start with a JSONObject //We start with a string with the HTTP format
//The JSONObject must have the minimun header for a HTTP request or header
String string = "{\"Method\":\"POST\",\"Request-URI\":'/',\"HTTP-Version\":'HTTP/1.1',\"Value1\":true,\"Value2\":2,\"Value3\":-2.345E68}"; String string = "Final HTTP: POST '/' HTTP/1.1 Value3: -2.345E+68 Value1: true Value2: 2";
JSONObject example = new JSONObject(string); //We obtain a JSONObject with toJSONOBject()
//We obtain a String with HTTP format with toString() JSONObject output = HTTP.toJSONObject(string);
System.out.println("Final JSONObject: " + output);
String output = HTTP.toString(example); }
System.out.println("Final HTTP: " + output);
}
```
```
private static void HTTPFromExampleConversion() {
//We start with a string with the HTTP format
String string = "Final HTTP: POST '/' HTTP/1.1 Value3: -2.345E+68 Value1: true Value2: 2";
//We obtain a JSONObject with toJSONOBject()
JSONObject output = HTTP.toJSONObject(string);
System.out.println("Final JSONObject: " + output);
}
``` ```
<h3>CDL Conversions</h3> <h3>CDL Conversions</h3>
``` ```java
private static void CDLToExampleConversion() { private static void CDLToExampleConversion() {
//We start with some JSONObjects with the same values in the keys but different values in the "values" //We start with some JSONObjects with the same values in the keys but different values in the "values"
String string = "{\"0\":\"value\",\"1\":5,\"2\":-2.345E68,\"3\":true}"; String string = "{\"0\":\"value\",\"1\":5,\"2\":-2.345E68,\"3\":true}";
JSONObject example = new JSONObject(string); JSONObject example = new JSONObject(string);
String string2 = "{\"0\":\"value2\",\"1\":6,\"2\":-8.345E68,\"3\":false}";
JSONObject example2 = new JSONObject(string2);
//We need now a JSONArray with those JSONObjects
JSONArray array = new JSONArray(); String string2 = "{\"0\":\"value2\",\"1\":6,\"2\":-8.345E68,\"3\":false}";
array.put(example); JSONObject example2 = new JSONObject(string2);
array.put(example2);
//We obtain a String with XML format with toString() //We need now a JSONArray with those JSONObjects
String output = CDL.toString(array); JSONArray array = new JSONArray();
System.out.println("Final CDL: \r\n" + output); array.put(example);
} array.put(example2);
```
//We obtain a String with XML format with toString()
String output = CDL.toString(array);
System.out.println("Final CDL: \r\n" + output);
}
``` ```
```java
private static void CDLFromExampleConversion() { private static void CDLFromExampleConversion() {
//We start wtih a String with the CDL format //We start wtih a String with the CDL format
@ -368,7 +368,7 @@ private static void CDLFromExampleConversion() {
String string = "0,1,2,3\n" String string = "0,1,2,3\n"
+ "value,5,-2.345E+68,true\n" + "value,5,-2.345E+68,true\n"
+ "value2,6,-8.345E+68,false"; + "value2,6,-8.345E+68,false";
//We obtain a JSONArray with toJSONOBject() //We obtain a JSONArray with toJSONOBject()
JSONArray output = CDL.toJSONArray(string); JSONArray output = CDL.toJSONArray(string);
@ -377,8 +377,8 @@ private static void CDLFromExampleConversion() {
``` ```
<h3>Properties Conversions</h3> <h3>Properties Conversions</h3>
``` ```java
private static Properties PropertyToExampleConversion() { private static Properties PropertyToExampleConversion() {
//We start with a JSONObject //We start with a JSONObject
@ -391,43 +391,43 @@ private static void CDLFromExampleConversion() {
System.out.println("Final Properties: " + output); System.out.println("Final Properties: " + output);
return output; return output;
} }
``` ```
``` ```java
private static void PropertyFromExampleConversion() { private static void PropertyFromExampleConversion() {
//We start with a Properties object //We start with a Properties object
Properties input = PropertyToExampleConversion(); Properties input = PropertyToExampleConversion();
//We obtain a JSONObject with toJSONOBject() //We obtain a JSONObject with toJSONOBject()
JSONObject output = Property.toJSONObject(input); JSONObject output = Property.toJSONObject(input);
System.out.println("Final JSONObject: " + output); System.out.println("Final JSONObject: " + output);
} }
``` ```
<h2>List of all examples methods</h2> <h2>List of all examples methods</h2>
``` ```java
public static void main(String[] args) { public static void main(String[] args) {
//JSONObjectToArray(); //JSONObjectToArray();
//JSONExampleArray1(); //JSONExampleArray1();
//JSONExampleArray2(); //JSONExampleArray2();
//JSONExampleStringer(); //JSONExampleStringer();
//JSONExampleObject1(); //JSONExampleObject1();
//JSONExampleObject2(); //JSONExampleObject2();
//JSONExampleObject3(); //JSONExampleObject3();
//JSONExamplWriter(); //JSONExamplWriter();
//XMLToExampleConversion(); //XMLToExampleConversion();
//XMLFromExampleConversion(); //XMLFromExampleConversion();
//CookieToExampleConversion(); //CookieToExampleConversion();
//CookieFromExampleConversion(); //CookieFromExampleConversion();
//HTTPToExampleConversion(); //HTTPToExampleConversion();
//HTTPFromExampleConversion(); //HTTPFromExampleConversion();
//CDLToExampleConversion(); //CDLToExampleConversion();
//CDLFromExampleConversion(); //CDLFromExampleConversion();
//PropertyToExampleConversion(); //PropertyToExampleConversion();
//PropertyFromExampleConversion(); //PropertyFromExampleConversion();
} }
``` ```