org.licas_text.json

Class ReadWriteJSON

java.lang.Object

org.licas_text.json.ReadWriteJSON

public class ReadWriteJSON
extends java.lang.Object

This class reads or writes entire json data files, or get or adds new values to an existing JSONObject.

Author:

Kieran

Constructor Summary

Constructors

Constructor and Description
ReadWriteJSON() Create a new instance of ReadWriteJSON

Method Summary

Modifier and Type	Method and Description
void	changeValue(java.lang.String tknName, java.lang.Object tknValue, JSONObject jsonObj) Change or set the json script value with the specified name.
java.lang.Object	getValue(java.lang.String tknName, JSONObject jsonObj) Get the json script value with the specified name.
JSONObject	readData(java.io.FileReader fileReader) Read an entire json script from a data file.
JSONObject	readData(java.lang.String jsonStr) Read an entire json script from a data string.
void	setValue(java.lang.String tknName, java.lang.Object tknValue, JSONObject jsonObj) Set the json script value with the specified name.
void	writeData(JSONObject jsonObj, java.io.FileWriter file) Write an entire json script to a file.
void	writeData(JSONObject jsonObj, java.lang.String filePath) Write an entire json script to a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadWriteJSON

public ReadWriteJSON()

Create a new instance of ReadWriteJSON

Method Detail

readData

public JSONObject readData(java.io.FileReader fileReader)
                    throws java.lang.Exception

Read an entire json script from a data file.

Parameters:

fileReader - the file reader.

Returns:

the parsed json object.

Throws:

java.lang.Exception - any error.

readData

public JSONObject readData(java.lang.String jsonStr)
                    throws java.lang.Exception

Read an entire json script from a data string.

Parameters:

jsonStr - the data string.

Returns:

the parsed json object.

Throws:

java.lang.Exception - any error.

writeData

public void writeData(JSONObject jsonObj,
                      java.lang.String filePath)
               throws java.lang.Exception

Write an entire json script to a file.

Parameters:

jsonObj - the json object.

filePath - the full file path.

Throws:

java.lang.Exception - any error.

writeData

public void writeData(JSONObject jsonObj,
                      java.io.FileWriter file)
               throws java.lang.Exception

Write an entire json script to a file.

Parameters:

jsonObj - the json object.

file - the file to write to.

Throws:

java.lang.Exception - any error.

changeValue

public void changeValue(java.lang.String tknName,
                        java.lang.Object tknValue,
                        JSONObject jsonObj)
                 throws java.lang.Exception

Change or set the json script value with the specified name.

Parameters:

tknName - the variable name.

tknValue - the object value. This overwrites any existing value.

jsonObj - the variable value.

Throws:

java.lang.Exception - any error.

setValue

public void setValue(java.lang.String tknName,
                     java.lang.Object tknValue,
                     JSONObject jsonObj)
              throws java.lang.Exception

Set the json script value with the specified name.

Parameters:

tknName - the variable name.

tknValue - the object value. If the variable already exists, it gets converted into a JSONArray first and then the new value is added to that.

jsonObj - the variable value.

Throws:

java.lang.Exception - any error.

getValue

public java.lang.Object getValue(java.lang.String tknName,
                                 JSONObject jsonObj)
                          throws java.lang.Exception

Get the json script value with the specified name.

Parameters:

tknName - the variable name.

jsonObj - the script object with that name. Can be a list of type JSONArray.

Returns:

the json object value.

Throws:

java.lang.Exception - any error.