org.mini2Dx.core

Class PlayerData

java.lang.Object

org.mini2Dx.core.PlayerData

Direct Known Subclasses:

AndroidPlayerData, DesktopPlayerData, IOSPlayerData

public abstract class PlayerData
extends java.lang.Object

Common interface for reading/writing player data, e.g. game saves, preferences, etc. The location to save data in is automatically determined by the game identifier and the current platform. All files/directories specified by the developer will be automatically placed inside the pre-determined data location. Note: Objects must use Field annotations to be serialized/deserialized properly

Constructor Summary

Constructors

Constructor and Description
PlayerData()

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 abstract void	ensureDataDirectoryExists() Internal method for setting up the save data directory (if required)
protected 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
java.io.DataInputStream	readBytes(java.lang.String... filepath) Reads the contents of a file in the player data location via a DataInputStream.
<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.
protected abstract FileHandle	resolve(java.lang.String[] filepath) Returns a FileHandle for a file or directory within the save data directory
protected abstract FileHandle	resolveTmp(java.lang.String[] filepath) Returns a FileHandle for a temporary file or directory within the save data directory
abstract void	wipe() Wipes all data within the game data location
java.io.DataOutputStream	writeBytes(java.lang.String... filepath) Writes contents to a file in the player 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

PlayerData

public PlayerData()

Method Detail

resolve

protected abstract FileHandle resolve(java.lang.String[] filepath)

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

Parameters:

filepath - The path broken up by directory/file

Returns:

A FileHandle instance

resolveTmp

protected abstract FileHandle resolveTmp(java.lang.String[] filepath)

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

Parameters:

filepath - The path broken up by directory/file

Returns:

A FileHandle instance

ensureDataDirectoryExists

protected abstract void ensureDataDirectoryExists()
                                           throws java.io.IOException

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

Throws:

java.io.IOException

wipe

public abstract void wipe()
                   throws PlayerDataException,
                          java.io.IOException

Wipes all data within the game data location

Throws:

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

java.io.IOException

getFileHandle

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

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

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

readXml

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

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

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

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

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

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

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

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

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.

readBytes

public java.io.DataInputStream readBytes(java.lang.String... filepath)
                                  throws PlayerDataException

Reads the contents of a file in the player data location via a DataInputStream. Note: Ensure that FilterInputStream.close() is called when finished reading.

Parameters:

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

Returns:

A DataInputStream to read from

Throws:

PlayerDataException - Thrown if the file does not exist

writeBytes

public java.io.DataOutputStream writeBytes(java.lang.String... filepath)
                                    throws PlayerDataException

Writes contents to a file in the player data location. Note: Ensure that FilterOutputStream.close() is called when finished writing.

Parameters:

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

Returns:

A DataOutputStream to write to

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

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

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

Writes a String to a file in the player data location

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

Deletes a file or directory within in the game data location

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

Checks if the file exists in the game data location

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

Checks if the directory exists in the game data location

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

Creates a directory within in the game data location

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

ensureDirectoryExistsForFile

protected void ensureDirectoryExistsForFile(java.lang.String... filepath)
                                     throws java.io.IOException,
                                            PlayerDataException

Throws:

java.io.IOException

PlayerDataException