org.mini2Dx.android.playerdata

Class AndroidPlayerData

java.lang.Object

org.mini2Dx.core.PlayerData

org.mini2Dx.android.playerdata.AndroidPlayerData

public class AndroidPlayerData
extends 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
protected void	ensureDataDirectoryExists() Internal method for setting up the save data directory (if required)
void	ensureDirectoryExistsForFile(java.lang.String... filepath)
FileHandle	getFileHandle(java.lang.String... filepath) Returns a FileHandle of a file or directory in the player 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.
FileHandle	resolve(java.lang.String[] filepath) Returns a FileHandle for a file or directory within the save data directory
FileHandle	resolveTmp(java.lang.String[] filepath) Returns a FileHandle for a temporary file or directory within the save data directory
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 org.mini2Dx.core.PlayerData

readBytes, writeBytes

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 class: PlayerData

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

Overrides:

readXml in class PlayerData

Type Parameters:

T - The type of Class to read

Parameters:

clazz - The object Class 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 class: PlayerData

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

Overrides:

writeXml in class PlayerData

Type Parameters:

T - The type of Class to write

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 class: PlayerData

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

Overrides:

readJson in class PlayerData

Type Parameters:

T - The type of Class to read

Parameters:

clazz - The object Class 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 class: PlayerData

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

Overrides:

writeJson in class PlayerData

Type Parameters:

T - The type of Class to write

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 class: PlayerData

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

Overrides:

readString in class 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 class: PlayerData

Writes a String to a file in the player data location

Overrides:

writeString in class 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 class: PlayerData

Deletes a file or directory within in the game data location

Overrides:

delete in class 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 class: PlayerData

Checks if the file exists in the game data location

Overrides:

hasFile in class 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 class: PlayerData

Checks if the directory exists in the game data location

Overrides:

hasDirectory in class 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 class: PlayerData

Creates a directory within in the game data location

Overrides:

createDirectory in class 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,
                 java.io.IOException

Description copied from class: PlayerData

Wipes all data within the game data location

Specified by:

wipe in class PlayerData

Throws:

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

java.io.IOException

ensureDirectoryExistsForFile

public void ensureDirectoryExistsForFile(java.lang.String... filepath)
                                  throws PlayerDataException

Overrides:

ensureDirectoryExistsForFile in class PlayerData

Throws:

PlayerDataException

getFileHandle

public FileHandle getFileHandle(java.lang.String... filepath)

Description copied from class: PlayerData

Returns a FileHandle of a file or directory in the player data location

Overrides:

getFileHandle in class PlayerData

Parameters:

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

Returns:

A FileHandle instance for file or directory

resolve

public FileHandle resolve(java.lang.String[] filepath)

Description copied from class: PlayerData

Returns a FileHandle for a file or directory within the save data directory

Specified by:

resolve in class PlayerData

Parameters:

filepath - The path broken up by directory/file

Returns:

A FileHandle instance

resolveTmp

public FileHandle resolveTmp(java.lang.String[] filepath)

Description copied from class: PlayerData

Returns a FileHandle for a temporary file or directory within the save data directory

Specified by:

resolveTmp in class PlayerData

Parameters:

filepath - The path broken up by directory/file

Returns:

A FileHandle instance

ensureDataDirectoryExists

protected void ensureDataDirectoryExists()
                                  throws java.io.IOException

Description copied from class: PlayerData

Internal method for setting up the save data directory (if required)

Specified by:

ensureDataDirectoryExists in class PlayerData

Throws:

java.io.IOException