IOSPlayerData (mini2Dx)

java.lang.Object
- org.mini2Dx.ios.playerdata.IOSPlayerData

All Implemented Interfaces:: PlayerData

public class IOSPlayerData
extends java.lang.Object
implements PlayerData

iOS implementation of PlayerData

Constructor Summary

Constructors
Constructor and Description

IOSPlayerData()

Constructors
Constructor and Description
`IOSPlayerData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createDirectory(java.lang.String... path)` Creates a directory within in the player data location
`boolean`	`delete(java.lang.String... path)` Deletes a file or directory within in the player data location
`com.badlogic.gdx.files.FileHandle`	`getFileHandle(java.lang.String... filepath)` Returns a `FileHandle` of a file in the player data location
`boolean`	`hasDirectory(java.lang.String... path)` Checks if the directory exists in the player data location
`boolean`	`hasFile(java.lang.String... filepath)` Checks if the file exists in the player data location
`<T extends GameDataSerializable> void`	`readBytes(T result, java.lang.String... filepath)` Reads a file from the player data location as a `GameDataSerializable` instance
`<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 player data location
`<T extends GameDataSerializable> void`	`writeBytes(T obj, java.lang.String... filepath)` Writes a `GameDataSerializable` object 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
  - IOSPlayerData
```
public IOSPlayerData()
```
- 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 player data location.
    
    Returns:
    
    The resulting object
    
    Throws:
    
    PlayerDataException - Thrown if the XML is invalid, the file does not exist or the player 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 player data location.
    
    Throws:
    
    PlayerDataException - Thrown if the player 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 player data location.
    
    Returns:
    
    The resulting object
    
    Throws:
    
    PlayerDataException - Thrown if the XML is invalid, the file does not exist or the player 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 player data location.
    
    Throws:
    
    PlayerDataException - Thrown if the player 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 player 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 player data location.
    
    Throws:
    
    PlayerDataException - Thrown if the player data location cannot be accessed or the data cannot be written to the file.
  - readBytes
```
public <T extends GameDataSerializable> void readBytes(T result,
                                                       java.lang.String... filepath)
                                                throws PlayerDataException
```
    Description copied from interface: PlayerData
    
    Reads a file from the player data location as a GameDataSerializable instance
    
    Specified by:
    
    readBytes in interface PlayerData
    
    Type Parameters:
    
    T - The type of the object
    
    Parameters:
    
    result - The instance to read to
    
    filepath - The path to the file. This will be resolved as a path within the player data location.
    
    Throws:
    
    PlayerDataException - Thrown if the player data location cannot be accessed or the * data cannot be written to the file.
  - writeBytes
```
public <T extends GameDataSerializable> void writeBytes(T obj,
                                                        java.lang.String... filepath)
                                                 throws PlayerDataException
```
    Description copied from interface: PlayerData
    
    Writes a GameDataSerializable object to a file in the player data location
    
    Specified by:
    
    writeBytes in interface PlayerData
    
    Type Parameters:
    
    T - The type of the object
    
    Parameters:
    
    obj - The object to write to the file
    
    filepath - The path to the file. This will be resolved as a path within the player data location.
    
    Throws:
    
    PlayerDataException - Thrown if the player 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 player data location
    
    Specified by:
    
    delete in interface PlayerData
    
    Parameters:
    
    path - The path to the file or directory within the player data location
    
    Returns:
    
    True if the file or directory was deleted successfully
    
    Throws:
    
    PlayerDataException - Thrown if the player 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 player data location
    
    Specified by:
    
    hasFile in interface PlayerData
    
    Parameters:
    
    filepath - The path to the file within the player data location
    
    Returns:
    
    True if the file exists
    
    Throws:
    
    PlayerDataException - Thrown if the player 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 player data location
    
    Specified by:
    
    hasDirectory in interface PlayerData
    
    Parameters:
    
    path - The path to the directory within the player data location
    
    Returns:
    
    True if the file exists
    
    Throws:
    
    PlayerDataException - Thrown if the player 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 player data location
    
    Specified by:
    
    createDirectory in interface PlayerData
    
    Parameters:
    
    path - The path to the directory within the player data location
    
    Throws:
    
    PlayerDataException - Thrown if the player 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 player data location
    
    Specified by:
    
    wipe in interface PlayerData
    
    Throws:
    
    PlayerDataException - Thrown if the player data location cannot be accessed or the data could not be wiped
  - getFileHandle
```
public com.badlogic.gdx.files.FileHandle getFileHandle(java.lang.String... filepath)
```
    Description copied from interface: PlayerData
    
    Returns a FileHandle of a file in the player data location
    
    Specified by:
    
    getFileHandle in interface PlayerData
    
    Parameters:
    
    filepath - The path to the file. This will be resolved as a path within the player data location.
    
    Returns:

Class IOSPlayerData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IOSPlayerData

Method Detail

readXml

writeXml

readJson

writeJson

readString

writeString

readBytes

writeBytes

delete

hasFile

hasDirectory

createDirectory

wipe

getFileHandle