Module org.autogui

Package org.autogui.base.mapping

Class GuiPreferences.GuiValueStore

java.lang.Object

org.autogui.base.mapping.GuiPreferences.GuiValueStore

Direct Known Subclasses:

GuiPreferences.GuiValueStoreDefault, GuiPreferences.GuiValueStoreOnMemory

Enclosing class:

GuiPreferences

public abstract static class GuiPreferences.GuiValueStore
extends Object

the abstract definition of key-value store.

• a key may be associated with a child node or an entry, and it shares the name space.
• an entry can be obtained as a String or a Integer
• an Integer entry can be obtained as a String entry
• a node is associated with a GuiPreferences, which might be the preferences of the store or a sub-preferences. if a sub-preferences, the name of the prefs (GuiPreferences.getName() becomes the node key.

Field Summary

Fields

Modifier and Type	Field	Description
protected GuiPreferences	preferences

Constructor Summary

Constructors

Constructor	Description
GuiValueStore(GuiPreferences preferences)

Method Summary

Modifier and Type	Method	Description
abstract GuiPreferences.GuiValueStore	copyInitAsRoot()
void	flush()
GuiPreferences.GuiValueStore	getChild(String key)
GuiPreferences.GuiValueStore	getChild(GuiPreferences preferences)
abstract GuiPreferences.GuiValueStore	getChild(GuiPreferences preferences, String key)
abstract int	getInt(String key, int def)
abstract List<String>	getKeys()
GuiPreferences	getPreferences()
abstract String	getString(String key, String def)
abstract boolean	hasEntryKey(String key)
abstract boolean	hasNodeKey(String key)
abstract void	putInt(String key, int val)
abstract void	putString(String key, String val)
abstract void	remove(String key)
abstract void	removeThisNode()	erase the node, but it might not remove the node from the parent
void	setPreferences(GuiPreferences preferences)

Methods inherited from class java.lang.Object

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

Field Details

preferences

protected GuiPreferences preferences

Constructor Details

GuiValueStore

public GuiValueStore(GuiPreferences preferences)

Method Details

getPreferences

public GuiPreferences getPreferences()

setPreferences

public void setPreferences(GuiPreferences preferences)

putString

public abstract void putString(String key,
 String val)

getString

public abstract String getString(String key,
 String def)

putInt

public abstract void putInt(String key,
 int val)

getInt

public abstract int getInt(String key,
 int def)

getChild

public GuiPreferences.GuiValueStore getChild(GuiPreferences preferences)

getChild

public GuiPreferences.GuiValueStore getChild(String key)

getChild

public abstract GuiPreferences.GuiValueStore getChild(GuiPreferences preferences,
 String key)

hasEntryKey

public abstract boolean hasEntryKey(String key)

hasNodeKey

public abstract boolean hasNodeKey(String key)

getKeys

public abstract List<String> getKeys()

Returns:

list of a key which might be different from a given key for put(k,...) because of the max key length, converted by GuiPreferences.toStoreKey(String). such key will be acceptable as an argument for other methods.

remove

public abstract void remove(String key)

removeThisNode

public abstract void removeThisNode()

erase the node, but it might not remove the node from the parent

flush

public void flush()

copyInitAsRoot

public abstract GuiPreferences.GuiValueStore copyInitAsRoot()