com.fs.starfarer.api.impl

Class BaseSharedJSONFile

java.lang.Object

com.fs.starfarer.api.impl.BaseSharedJSONFile

Direct Known Subclasses:

SharedUnlockData

public abstract class BaseSharedJSONFile
extends java.lang.Object

Base class. Extending classes are for relatively small amounts of data meant to be shared across different saves. The amount of data stored here should be small and bounded (i.e. not growing indefinitely). Code using this should assume the data stored here may be lost (e.g. due to the common folder being deleted) and handle this/recover gracefully.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.json.JSONObject	json
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	setCache

Constructor Summary

Constructors

Constructor and Description
BaseSharedJSONFile()

Method Summary

Modifier and Type	Method and Description
boolean	addToSet(java.lang.String key, java.lang.String value)
boolean	doesSetContain(java.lang.String key, java.lang.String value)
protected abstract java.lang.String	getFilename()
java.util.Set<java.lang.String>	getSet(java.lang.String key)
void	loadIfNeeded()
boolean	optBoolean(java.lang.String key, boolean defaultValue)
float	optFloat(java.lang.String key, float defaultValue)
int	optInt(java.lang.String key, int defaultValue)
java.lang.String	optString(java.lang.String key, java.lang.String defaultValue)
void	saveIfNeeded()
void	setBoolean(java.lang.String key, boolean value)
void	setFloat(java.lang.String key, float value)
void	setInt(java.lang.String key, int value)
void	setString(java.lang.String key, java.lang.String value)
void	unset(java.lang.String key)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

json

protected org.json.JSONObject json

setCache

protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>> setCache

Constructor Detail

BaseSharedJSONFile

public BaseSharedJSONFile()

Method Detail

getFilename

protected abstract java.lang.String getFilename()

loadIfNeeded

public void loadIfNeeded()

saveIfNeeded

public void saveIfNeeded()

getSet

public java.util.Set<java.lang.String> getSet(java.lang.String key)

doesSetContain

public boolean doesSetContain(java.lang.String key,
                              java.lang.String value)

addToSet

public boolean addToSet(java.lang.String key,
                        java.lang.String value)

optBoolean

public boolean optBoolean(java.lang.String key,
                          boolean defaultValue)

setBoolean

public void setBoolean(java.lang.String key,
                       boolean value)

optFloat

public float optFloat(java.lang.String key,
                      float defaultValue)

setFloat

public void setFloat(java.lang.String key,
                     float value)

optInt

public int optInt(java.lang.String key,
                  int defaultValue)

setInt

public void setInt(java.lang.String key,
                   int value)

optString

public java.lang.String optString(java.lang.String key,
                                  java.lang.String defaultValue)

setString

public void setString(java.lang.String key,
                      java.lang.String value)

unset

public void unset(java.lang.String key)