org.mini2Dx.android.data

Class AndroidData

java.lang.Object

org.mini2Dx.android.data.AndroidData

All Implemented Interfaces:

Data

public class AndroidData
extends java.lang.Object
implements Data

Android implementation of Data

Constructor Summary

Constructors

Constructor and Description
AndroidData()

Method Summary

Modifier and Type	Method and Description
void	createDirectory(java.lang.String... path) Creates a directory within in the game data location
boolean	hasDirectory(java.lang.String... path) Checks if the directory exists in the game data location
boolean	hasFile(java.lang.String... filepath) Checks if the file exists in the game data location
<T> T	readJson(java.lang.Class<T> clazz, java.lang.String... filepath) Converts JSON from a file into an object.
<T> T	readXml(java.lang.Class<T> clazz, java.lang.String... filepath) Converts XML from a file into an object.
void	wipe() Wipes all data within the game data location
<T> void	writeJson(T object, java.lang.String... filepath) Writes an object as JSON to a file.
<T> void	writeXml(T object, java.lang.String... filepath) Writes an object as XML to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidData

public AndroidData()

Method Detail

readXml

public <T> T readXml(java.lang.Class<T> clazz,
                     java.lang.String... filepath)
              throws java.lang.Exception

Description copied from interface: Data

Converts XML from a file into an object. Note the object must use the mini2Dx data annotations.

Specified by:

readXml in interface Data

Parameters:

clazz - The object type to convert the XML into

filepath - The path to the XML file. This will be resolved as a path within the game data location.

Returns:

The resulting object

Throws:

java.lang.Exception - Thrown if the XML is invalid, the file does not exist or the game data location cannot be accessed.

writeXml

public <T> void writeXml(T object,
                         java.lang.String... filepath)
                  throws java.lang.Exception

Description copied from interface: Data

Writes an object as XML to a file. Note the object must use the mini2Dx data annotations.

Specified by:

writeXml in interface Data

Parameters:

object - The object to be written to the file

filepath - The path to the XML file. This will be resolved as a path within the game data location.

Throws:

java.lang.Exception - Thrown if the game data location cannot be accessed or the data cannot be written to the file.

readJson

public <T> T readJson(java.lang.Class<T> clazz,
                      java.lang.String... filepath)
               throws java.lang.Exception

Description copied from interface: Data

Converts JSON from a file into an object. Note the object must use the mini2Dx data annotations.

Specified by:

readJson in interface Data

Parameters:

clazz - The object type to convert the JSON into

filepath - The path to the JSON file. This will be resolved as a path within the game data location.

Returns:

The resulting object

Throws:

java.lang.Exception - Thrown if the XML is invalid, the file does not exist or the game data location cannot be accessed.

writeJson

public <T> void writeJson(T object,
                          java.lang.String... filepath)
                   throws java.lang.Exception

Description copied from interface: Data

Writes an object as JSON to a file. Note the object must use the mini2Dx data annotations.

Specified by:

writeJson in interface Data

Parameters:

object - The object to be written to the file

filepath - The path to the JSON file. This will be resolved as a path within the game data location.

Throws:

java.lang.Exception - Thrown if the game data location cannot be accessed or the data cannot be written to the file.

hasFile

public boolean hasFile(java.lang.String... filepath)
                throws java.lang.Exception

Description copied from interface: Data

Checks if the file exists in the game data location

Specified by:

hasFile in interface Data

Parameters:

filepath - The path to the file within the game data location

Returns:

True if the file exists

Throws:

java.lang.Exception - Thrown if the game data location cannot be accessed

hasDirectory

public boolean hasDirectory(java.lang.String... path)
                     throws java.lang.Exception

Description copied from interface: Data

Checks if the directory exists in the game data location

Specified by:

hasDirectory in interface Data

Parameters:

path - The path to the directory within the game data location

Returns:

True if the file exists

Throws:

java.lang.Exception - Thrown if the game data location cannot be accessed

createDirectory

public void createDirectory(java.lang.String... path)
                     throws java.lang.Exception

Description copied from interface: Data

Creates a directory within in the game data location

Specified by:

createDirectory in interface Data

Parameters:

path - The path to the directory within the game data location

Throws:

java.lang.Exception - Thrown if the game data location cannot be accessed or the directory could not be created

wipe

public void wipe()
          throws java.lang.Exception

Description copied from interface: Data

Wipes all data within the game data location

Specified by:

wipe in interface Data

Throws:

java.lang.Exception - Thrown if the game data location cannot be accessed or the data could not be wiped