com.codelanx.codelanxlib.data.types

Class Json

java.lang.Object

com.codelanx.codelanxlib.data.types.Json

All Implemented Interfaces:

DataType, FileDataType

public class Json
extends Object
implements FileDataType

Represents a JSON file that has been parsed and loaded into memory.

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
protected File	location The File location of this FileDataType
protected org.json.simple.JSONObject	root The root JSONObject

Constructor Summary

Constructors

Constructor and Description
Json(File location) Reads and loads a JSON file into memory

Method Summary

Modifier and Type	Method and Description
Object	get(String path) Gets the object at the specified path
Object	get(String path, Object def) Gets the object at the specified path, or returns the passed "default" value if nothing is found
protected org.json.simple.JSONObject	getContainer(String... ladder) Gets the JSONObject above the requested object specified by the supplied ladder parameter.
protected org.json.simple.JSONObject	getContainer(String path) Gets the JSONObject above the requested object specified by the supplied path parameter.
protected String[]	getLadder(String path) Converts a period-delimited string into a String array
boolean	isSet(String path) Returns whether or not there is an object located at the specified path
void	save() Saves any information in memory to the file it was loaded from.
void	save(File target) Saves any information in memory to the file specified.
void	set(String path, Object value) Sets the value at the location specified by the passed path
protected org.json.simple.JSONObject	traverse(boolean makePath, String... ladder) Traverses a JSONObject tree from the internal root node.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.codelanx.codelanxlib.data.FileDataType

newInstance

Field Detail

location

protected final File location

The File location of this FileDataType

root

protected final org.json.simple.JSONObject root

The root JSONObject

Constructor Detail

Json

public Json(File location)
     throws org.json.simple.parser.ParseException

Reads and loads a JSON file into memory

Parameters:

location - The location of the file to parse

Throws:

org.json.simple.parser.ParseException - If the file is not in standard JSON format

Since:

0.1.0

Method Detail

set

public void set(String path,
                Object value)

Sets the value at the location specified by the passed path

Specified by:

set in interface FileDataType

Parameters:

path - The path to set, delimited by '.'

value - The value to set

Since:

0.1.0

isSet

public boolean isSet(String path)

Returns whether or not there is an object located at the specified path

Specified by:

isSet in interface FileDataType

Parameters:

path - The path to set, delimited by '.'

Returns:

true if a value is found, false otherwise

Since:

0.1.0

get

public Object get(String path)

Gets the object at the specified path

Specified by:

get in interface FileDataType

Parameters:

path - The path to set, delimited by '.'

Returns:

The object found in memory at this location, or null if nothing is found

Since:

0.1.0

get

public Object get(String path,
                  Object def)

Gets the object at the specified path, or returns the passed "default" value if nothing is found

Specified by:

get in interface FileDataType

Parameters:

path - The path to set, delimited by '.'

def - The default value to return upon not finding a value

Returns:

The relevant object, or the default if no value is found

Since:

0.1.0

getContainer

protected org.json.simple.JSONObject getContainer(String... ladder)

Gets the JSONObject above the requested object specified by the supplied ladder parameter.

Parameters:

ladder - A string array, already split in order of levels to traverse

Returns:

The JSONObject above the requested object

Since:

0.1.0

getContainer

protected org.json.simple.JSONObject getContainer(String path)

Gets the JSONObject above the requested object specified by the supplied path parameter.

Parameters:

path - The period-delimited path to the object desired

Returns:

The JSONObject above the requested object

Since:

0.1.0

getLadder

protected String[] getLadder(String path)

Converts a period-delimited string into a String array

Parameters:

path - The path to split

Returns:

The split path

Since:

0.1.0

traverse

protected org.json.simple.JSONObject traverse(boolean makePath,
                                              String... ladder)

Traverses a JSONObject tree from the internal root node. Will return a JSONObject container of the relevant element at the end of the search, or just an empty JSONObject if nothing exists.

Parameters:

makePath - Whether to fill empty space with JSONObjects

ladder - A String array depicting the location to search in

Returns:

A JSONObject containing the last node in the ladder

Since:

0.1.0

save

public void save()
          throws IOException

Saves any information in memory to the file it was loaded from.

Specified by:

save in interface FileDataType

Throws:

IOException - Any read/write locks or permission errors on the file

Since:

0.1.0

save

public void save(File target)
          throws IOException

Saves any information in memory to the file specified.

Specified by:

save in interface FileDataType

Parameters:

target - The file to save to

Throws:

IOException - Any read/write locks or permission errors on the file

Since:

0.1.0