PlayerData (mini2Dx-uats 1.2.1 API)

All Known Implementing Classes:

AndroidPlayerData, DesktopPlayerData, IOSPlayerData
```
public interface PlayerData
```
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

Method Summary

Methods
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.

- Method Detail
  - readString
```
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
```
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.
  - readXml
```
<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.
    
    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
```
<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.
    
    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
```
<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.
    
    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
```
<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.
    
    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.
  - hasFile
```
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
```
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
```
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
  - delete
```
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
  - wipe
```
void wipe()
          throws PlayerDataException
```
    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

Interface PlayerData

Method Summary

Method Detail

readString

writeString

readXml

writeXml

readJson

writeJson

hasFile

hasDirectory

createDirectory

delete

wipe