Module org.autogui

Package org.autogui.base.mapping

Class GuiPreferences

java.lang.Object

org.autogui.base.mapping.GuiPreferences

Direct Known Subclasses:

GuiPreferences.GuiPreferencesWithPaths

public class GuiPreferences
extends Object

the Preferences holder associated to a GuiMappingContext. Each child is also held by GuiMappingContext. The class has a GuiPreferences.GuiValueStore. It also has a list of history values.

        pack/Type/  //root-context, in a case of GuiReprObjectPane(pack.Type)
                    //otherwise, "org/autogui/base/mapping/pack_Type"
            "$default"/
               propName = value... //regular preferences entries
               ...
               "$value" = ... //current value, which will precede to history values
               "$history"/
                  "0"/    //key-index
                     "index" = ...
                     "value" = ...
                     "time"  = ... //Instant.toString()
                  ...
               propertyName/   //the name of a sub-context
                  ...
            "$launchPrefs" = "..." //value of "$uuid", "" or "empty"
            "$saved"/
               "$0"/
                 "$name" = ...
                 "$uuid" = "..." //a value from UUID.randomUUID()
                 ... //same structure as "$default"
               ...
   

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiPreferences.GuiPreferencesWithPaths	a subclass of prefs for custom usage with supplying specific sub-paths.
static class	GuiPreferences.GuiValueStore	the abstract definition of key-value store.
static class	GuiPreferences.GuiValueStoreDefault	the concrete implementation of the store by Preferences
static class	GuiPreferences.GuiValueStoreOnMemory	an on-memory impl.
static class	GuiPreferences.HistoryValueEntry	an entry of the value history, consisting of a value, an index and a time-stamp, associated with a key-index.
static class	GuiPreferences.HistoryValueEntryJsonSupported	JSON entry for JSON support object
static class	GuiPreferences.HistoryValueEntryOnMemory	an on-memory impl.
static interface	GuiPreferences.PreferencesJsonSupport	the interface for supporting user-defined prefs: a context-object that implements the interface always saves/loads prefs via the interface.
static class	GuiPreferences.PreferencesLock	the entire lock object for the preferences

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<GuiMappingContext,GuiPreferences>	children
protected GuiMappingContext	context
protected int	historyValueLimit
protected List<GuiPreferences.HistoryValueEntry>	historyValues
protected GuiPreferences.PreferencesLock	lock
protected GuiPreferences	parent
protected GuiPreferences.GuiValueStore	valueStore

Constructor Summary

Constructors

Constructor	Description
GuiPreferences(GuiMappingContext context)
GuiPreferences(GuiPreferences.GuiValueStore valueStore, GuiMappingContext context)
GuiPreferences(GuiPreferences parent, GuiMappingContext context)

Method Summary

Modifier and Type	Method	Description
void	addHistoryValue(Object value)	add a value to the history.
void	addHistoryValue(Object value, Instant optionalTime)
GuiPreferences	addNewSavedStoreAsRoot()
void	clearAll()	after calling the method, the preferences will be invalidated
void	clearHistories()
void	clearHistoriesTree()
GuiPreferences	copyOnMemory(GuiPreferences parent)
GuiPreferences	copyOnMemoryAsRoot()
static GuiPreferences.GuiValueStore	copyOnMemoryStore(GuiPreferences src, GuiPreferences prefs, GuiPreferences.GuiValueStore store, boolean putToParent)
GuiPreferences.HistoryValueEntry	createHistoryValueEntry(Object value)
void	fromJson(Map<String,Object> json)
protected void	fromJsonChildNodes(GuiPreferences.GuiValueStore store, Map<String,Object> json)
GuiPreferences	getChild(GuiMappingContext context)
GuiMappingContext	getContext()
Object	getCurrentValue()
Object	getCurrentValueAsJsonSupported()	loads prefs JSON object for GuiPreferences.PreferencesJsonSupport.setPrefsJson(Map)
GuiPreferences	getDescendant(GuiMappingContext descendantContext)
GuiPreferences.HistoryValueEntry	getHistoryValue(Object value)
List<GuiPreferences.HistoryValueEntry>	getHistoryValues()
int	getHistoryValueUnusedKeyIndex()
String	getLaunchPrefsAsRoot()
String	getName()
GuiPreferences	getParent()
GuiPreferences.GuiValueStore	getPreferencesNodeAsRoot()
List<GuiPreferences>	getSavedStoreListAsRoot()	"$default/" ...
static int	getStoreValueMaxLength()
GuiPreferences.GuiValueStore	getValueStore()
GuiPreferences.GuiValueStore	getValueStoreRootFromRepresentation()
boolean	isContextTypeIsJsonSupport()
void	loadHistoryValues()	load or create historyValues: it's size becomes up to historyValueLimit and sorted by index.
GuiPreferences.PreferencesLock	lock()
GuiPreferences.HistoryValueEntry	replaceMin(Object v, GuiPreferences.HistoryValueEntry optionalDefault)
void	resetAsRoot()
protected void	setChild(GuiMappingContext context, GuiPreferences child)
void	setCurrentValue(Object value)
void	setCurrentValueAsJsonSupported(Object json)	obtains toJson() and saves the returned JSON as a prefs entry
void	setLaunchPrefsAsRoot(String uuid)
Map<String,Object>	toJson()
static String	toStoreKey(String key)

Methods inherited from class java.lang.Object

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

Field Details

context

protected GuiMappingContext context

parent

protected GuiPreferences parent

children

protected Map<GuiMappingContext,GuiPreferences> children

valueStore

protected GuiPreferences.GuiValueStore valueStore

historyValues

protected List<GuiPreferences.HistoryValueEntry> historyValues

historyValueLimit

protected int historyValueLimit

lock

protected GuiPreferences.PreferencesLock lock

Since:

1.6

Constructor Details

GuiPreferences

public GuiPreferences(GuiMappingContext context)

GuiPreferences

public GuiPreferences(GuiPreferences parent,
 GuiMappingContext context)

GuiPreferences

public GuiPreferences(GuiPreferences.GuiValueStore valueStore,
 GuiMappingContext context)

Method Details

isContextTypeIsJsonSupport

public boolean isContextTypeIsJsonSupport()

Returns:

the type of the context of the prefs is GuiPreferences.PreferencesJsonSupport

Since:

1.5

getStoreValueMaxLength

public static int getStoreValueMaxLength()

toStoreKey

public static String toStoreKey(String key)

getChild

public GuiPreferences getChild(GuiMappingContext context)

Parameters:

context - the parent

Returns:

a child preference for context

setChild

protected void setChild(GuiMappingContext context,
 GuiPreferences child)

getName

public String getName()

getContext

public GuiMappingContext getContext()

getParent

public GuiPreferences getParent()

getDescendant

public GuiPreferences getDescendant(GuiMappingContext descendantContext)

Parameters:

descendantContext - a descendant context of the context returned by getContext(), can be getContext() itself

Returns:

a descendant preference associated with the descendantContext

getValueStore

public GuiPreferences.GuiValueStore getValueStore()

Returns:

Preferences based value-store. if it has parent, node for context's name of the parent, otherwise, node for context's object-type (user-node "/pack/ObjType") or node for (pack of this type)+"/"+(context's name).

getValueStoreRootFromRepresentation

public GuiPreferences.GuiValueStore getValueStoreRootFromRepresentation()

getPreferencesNodeAsRoot

public GuiPreferences.GuiValueStore getPreferencesNodeAsRoot()

resetAsRoot

public void resetAsRoot()

lock

public GuiPreferences.PreferencesLock lock()

Returns:

lock object with holding the lock

Since:

1.6

getSavedStoreListAsRoot

public List<GuiPreferences> getSavedStoreListAsRoot()

            "$default/"
               ...
            "$launchPrefs" = "..."
            "$saved/"
               "$0/"
                  "$name" = "prefs yyyy/mm/dd hh:mm"
                  "$uuid" = "..." //checked
                  ...
               "$1/"
               ...
 

Returns:

saved preferences

getLaunchPrefsAsRoot

public String getLaunchPrefsAsRoot()

Returns:

"": value of "$uuid", "" (default) or "empty" (empty)

setLaunchPrefsAsRoot

public void setLaunchPrefsAsRoot(String uuid)

addNewSavedStoreAsRoot

public GuiPreferences addNewSavedStoreAsRoot()

setCurrentValue

public void setCurrentValue(Object value)

setCurrentValueAsJsonSupported

public void setCurrentValueAsJsonSupported(Object json)

obtains toJson() and saves the returned JSON as a prefs entry

Parameters:

json - the saved object

Since:

1.5

getCurrentValue

public Object getCurrentValue()

getCurrentValueAsJsonSupported

public Object getCurrentValueAsJsonSupported()

loads prefs JSON object for GuiPreferences.PreferencesJsonSupport.setPrefsJson(Map)

Returns:

loaded JSON object

Since:

1.5

addHistoryValue

public void addHistoryValue(Object value)

add a value to the history.

1. it first loads the existing history if not yet loaded, by loadHistoryValues().
2. it finds an existing entry or a create new entry by getHistoryValue(Object).
3. if the entry is a new one (keyIndex==-1), call replaceMin(Object, HistoryValueEntry) and obtain the oldest entry with replacing the value.
4. The entry moves to the end of the history as the latest value, by setting the max index + 1 as it's index, which is a temporarly index. The entire history is sorted by the indices.
5. remove overflowed entries with calling GuiPreferences.HistoryValueEntry.remove(). (regularly, this step never happens.)
6. set index and keyIndex (if keyIndex==-1) for all entries, and flush the store.

Parameters:

value - the new entry value

addHistoryValue

public void addHistoryValue(Object value,
 Instant optionalTime)

getHistoryValueUnusedKeyIndex

public int getHistoryValueUnusedKeyIndex()

getHistoryValues

public List<GuiPreferences.HistoryValueEntry> getHistoryValues()

getHistoryValue

public GuiPreferences.HistoryValueEntry getHistoryValue(Object value)

Parameters:

value - the entry value

Returns:

a new entry (keyIndex == -1) or an existing entry

replaceMin

public GuiPreferences.HistoryValueEntry replaceMin(Object v,
 GuiPreferences.HistoryValueEntry optionalDefault)

loadHistoryValues

public void loadHistoryValues()

load or create historyValues: it's size becomes up to historyValueLimit and sorted by index. The new entries have -1 indices.

createHistoryValueEntry

public GuiPreferences.HistoryValueEntry createHistoryValueEntry(Object value)

clearAll

public void clearAll()

after calling the method, the preferences will be invalidated

clearHistoriesTree

public void clearHistoriesTree()

clearHistories

public void clearHistories()

toJson

public Map<String,Object> toJson()

copyOnMemoryAsRoot

public GuiPreferences copyOnMemoryAsRoot()

copyOnMemory

public GuiPreferences copyOnMemory(GuiPreferences parent)

Parameters:

parent - the parent which is already an on-memory instance or null

Returns:

the copied preferences whose value-store is a GuiPreferences.GuiValueStoreOnMemory

copyOnMemoryStore

public static GuiPreferences.GuiValueStore copyOnMemoryStore(GuiPreferences src,
 GuiPreferences prefs,
 GuiPreferences.GuiValueStore store,
 boolean putToParent)

fromJson

public void fromJson(Map<String,Object> json)

fromJsonChildNodes

protected void fromJsonChildNodes(GuiPreferences.GuiValueStore store,
 Map<String,Object> json)