org.mini2Dx.android.playerdata

Class AndroidPlayerData

java.lang.Object

org.mini2Dx.android.playerdata.AndroidPlayerData

All Implemented Interfaces:

PlayerData

public class AndroidPlayerData
extends java.lang.Object
implements PlayerData

Android implementation of PlayerData

Constructor Summary

Constructors

Constructor and Description
AndroidPlayerData()

Method Summary

Modifier and Type	Method and Description
void	createDirectory(java.lang.String... path) Creates a directory within in the game data location
boolean	delete(java.lang.String... path) Deletes a file or 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.
java.lang.String	readString(java.lang.String... filepath) Reads the contents of a file in the player data location into a String
<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.
void	writeString(java.lang.String content, java.lang.String... filepath) Writes a String to a file in the player data location
<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

AndroidPlayerData

public AndroidPlayerData()

Method Detail

readXml

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

Description copied from interface: PlayerData

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

Specified by:

readXml in interface PlayerData

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:

PlayerDataException - 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 PlayerDataException

Description copied from interface: PlayerData

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

Specified by:

writeXml in interface PlayerData

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:

PlayerDataException - 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 PlayerDataException

Description copied from interface: PlayerData

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

Specified by:

readJson in interface PlayerData

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:

PlayerDataException - 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 PlayerDataException

Description copied from interface: PlayerData

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

Specified by:

writeJson in interface PlayerData

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:

PlayerDataException - Thrown if the game data location cannot be accessed or the data cannot be written to the file.

readString

public java.lang.String readString(java.lang.String... filepath)
                            throws PlayerDataException

Description copied from interface: PlayerData

Reads the contents of a file in the player data location into a String

Specified by:

readString in interface PlayerData

Parameters:

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

Returns:

A string containing the contents of the file

Throws:

PlayerDataException - Thrown if the file does not exist

writeString

public void writeString(java.lang.String content,
                        java.lang.String... filepath)
                 throws PlayerDataException

Description copied from interface: PlayerData

Writes a String to a file in the player data location

Specified by:

writeString in interface PlayerData

Parameters:

content - The String to be written to the file

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

Throws:

PlayerDataException - Thrown if the game data location cannot be accessed or the data cannot be written to the file.

delete

public boolean delete(java.lang.String... path)
               throws PlayerDataException

Description copied from interface: PlayerData

Deletes a file or directory within in the game data location

Specified by:

delete in interface PlayerData

Parameters:

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

Returns:

True if the file or directory was deleted successfully

Throws:

PlayerDataException - Thrown if the game data location cannot be accessed or the file/directory could not be deleted

hasFile

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

Description copied from interface: PlayerData

Checks if the file exists in the game data location

Specified by:

hasFile in interface PlayerData

Parameters:

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

Returns:

True if the file exists

Throws:

PlayerDataException - Thrown if the game data location cannot be accessed

hasDirectory

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

Description copied from interface: PlayerData

Checks if the directory exists in the game data location

Specified by:

hasDirectory in interface PlayerData

Parameters:

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

Returns:

True if the file exists

Throws:

PlayerDataException - Thrown if the game data location cannot be accessed

createDirectory

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

Description copied from interface: PlayerData

Creates a directory within in the game data location

Specified by:

createDirectory in interface PlayerData

Parameters:

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

Throws:

PlayerDataException - Thrown if the game data location cannot be accessed or the directory could not be created

wipe

public void wipe()
          throws PlayerDataException

Description copied from interface: PlayerData

Wipes all data within the game data location

Specified by:

wipe in interface PlayerData

Throws:

PlayerDataException - Thrown if the game data location cannot be accessed or the data could not be wiped