Module org.autogui

Package org.autogui.base.mapping

Class GuiPreferencesLoader

java.lang.Object

org.autogui.base.mapping.GuiPreferencesLoader

public class GuiPreferencesLoader
extends Object

the class for manually setting preferences to target objects

     GuiPreferencesLoader.get().apply(obj);
       //setting properties from default saved prefs ("/pack/to/Cls/$default")
 

     GuiPreferencesLoader.get().withPrefsGetterByNameEquals("p").apply(obj);
       //setting properties from saved prefs as "p"
        //("/pack/to/Cls/$saved/$N" and "$name" is "p")
 

     var restArgs = GuiPreferencesLoader.get().parseArgs(obj, Arrays.asList(args));
       //e.g. args={"-l", "p"} then, load and apply prefs "p" to obj
 

Since:

1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GuiPreferencesLoader.PrefsLoaderCommandArg
static class	GuiPreferencesLoader.PrefsLoadException

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<GuiPreferencesLoader.PrefsLoaderCommandArg,List<String>>	argNames
protected GuiMappingContext	context
protected Function<GuiPreferences,GuiPreferences>	prefsGetter
protected GuiTypeBuilder	typeBuilder

Constructor Summary

Constructors

Constructor	Description
GuiPreferencesLoader()

Method Summary

Modifier and Type	Method	Description
Object	apply()	applies the current context to applyForContext(GuiMappingContext)
Object	apply(Object obj)	loading specified saved prefs to the obj The prefs can be selected by withPrefsGetterDefault() (default) or withPrefsGetterByNameEquals(String)
Object	applyForContext(GuiMappingContext context)	takes prefs from the context and selects a prefs by the getter set by withPrefsGetter(Function), and calls load(GuiPreferences) with the prefs
static GuiPreferences	findSavedPrefsByName(GuiPreferences rootPrefs, Predicate<String> name)
static GuiPreferences	findSavedPrefsDefault(GuiPreferences rootPrefs)
static GuiPreferencesLoader	get()
static String	getPrefsName(GuiPreferences savedPrefs)
List<GuiPreferences>	getSavedPrefs()
static List<GuiPreferences>	getSavedPrefs(GuiMappingContext context)
List<String>	getSavedPrefsNames()
List<GuiPreferences>	getSavedPrefsWithDefault()
static List<GuiPreferences>	getSavedPrefsWithDefault(GuiMappingContext context)
void	handleError(Throwable error, GuiPreferences prefs)
Object	load(GuiPreferences prefs)	load(GuiPreferences, GuiReprValue.ObjectSpecifier) with GuiReprValue.NONE
Object	load(GuiPreferences prefs, GuiReprValue.ObjectSpecifier specifier)	sets current saved value taken from the prefs to the properties of the source object of the context.
List<String>	parseArgs(Object obj, String... args)
List<String>	parseArgs(Object obj, List<String> args)
List<String>	parseArgs(List<String> args)	consume head args for GuiPreferencesLoader.PrefsLoaderCommandArg and do the option.
void	println(Object o)
void	runHelp()	println(Object) help messages of GuiPreferencesLoader.PrefsLoaderCommandArg
void	runJson(String arg)	get the prefs and println(Object) JSON source of the prefs
void	runLoad(String arg)	set prefs getter with arg and apply()
void	runShowNames()	println(Object) names of saved prefs for current context
GuiPreferences	takeSavedPrefs()
GuiPreferences	takeSavedPrefs(GuiMappingContext context)
GuiPreferencesLoader	withArgNames(Map<GuiPreferencesLoader.PrefsLoaderCommandArg,List<String>> argNames)	sets command line args for parseArgs(List).
GuiPreferencesLoader	withContext(GuiMappingContext context)
GuiPreferencesLoader	withContextForObject(Object obj)	creates a GuiMappingContext for the given object, with GuiTypeBuilder previously set by withTypeBuilder(GuiTypeBuilder)
GuiPreferencesLoader	withPrefsGetter(Function<GuiPreferences,GuiPreferences> prefsGetter)	sets the prefs selector that takes the root prefs and returns a saved preferences; typically, it takes an element of GuiPreferences.getSavedStoreListAsRoot()
GuiPreferencesLoader	withPrefsGetterByNameEquals(String name)	withPrefsGetter(Function) with findSavedPrefsByName(GuiPreferences, Predicate) for selecting named prefs
GuiPreferencesLoader	withPrefsGetterDefault()	withPrefsGetter(Function) with findSavedPrefsDefault(GuiPreferences) for selecting default prefs
GuiPreferencesLoader	withTypeBuilder(GuiTypeBuilder typeBuilder)
GuiPreferencesLoader	withTypeBuilderRelaxed()	set the type-builder to GuiTypeBuilder.GuiTypeBuilderRelaxed.

Methods inherited from class java.lang.Object

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

Field Details

typeBuilder

protected GuiTypeBuilder typeBuilder

prefsGetter

protected Function<GuiPreferences,GuiPreferences> prefsGetter

context

protected GuiMappingContext context

argNames

protected Map<GuiPreferencesLoader.PrefsLoaderCommandArg,List<String>> argNames

Constructor Details

GuiPreferencesLoader

public GuiPreferencesLoader()

Method Details

get

public static GuiPreferencesLoader get()

withTypeBuilder

public GuiPreferencesLoader withTypeBuilder(GuiTypeBuilder typeBuilder)

withTypeBuilderRelaxed

public GuiPreferencesLoader withTypeBuilderRelaxed()

set the type-builder to GuiTypeBuilder.GuiTypeBuilderRelaxed. This is required for taking prefs of the app launched by AutoGuiShell.showLive(...).

Returns:

this

withPrefsGetter

public GuiPreferencesLoader withPrefsGetter(Function<GuiPreferences,GuiPreferences> prefsGetter)

sets the prefs selector that takes the root prefs and returns a saved preferences; typically, it takes an element of GuiPreferences.getSavedStoreListAsRoot()

Parameters:

prefsGetter - the selector function

Returns:

this

withPrefsGetterByNameEquals

public GuiPreferencesLoader withPrefsGetterByNameEquals(String name)

withPrefsGetter(Function) with findSavedPrefsByName(GuiPreferences, Predicate) for selecting named prefs

Parameters:

name - the name compared to the "$name" value

Returns:

this

withPrefsGetterDefault

public GuiPreferencesLoader withPrefsGetterDefault()

withPrefsGetter(Function) with findSavedPrefsDefault(GuiPreferences) for selecting default prefs

Returns:

this

withContextForObject

public GuiPreferencesLoader withContextForObject(Object obj)

creates a GuiMappingContext for the given object, with GuiTypeBuilder previously set by withTypeBuilder(GuiTypeBuilder)

Parameters:

obj - the target object of the creating context

Returns:

this

withContext

public GuiPreferencesLoader withContext(GuiMappingContext context)

getSavedPrefs

public List<GuiPreferences> getSavedPrefs()

getSavedPrefsWithDefault

public List<GuiPreferences> getSavedPrefsWithDefault()

getSavedPrefsNames

public List<String> getSavedPrefsNames()

getSavedPrefs

public static List<GuiPreferences> getSavedPrefs(GuiMappingContext context)

getSavedPrefsWithDefault

public static List<GuiPreferences> getSavedPrefsWithDefault(GuiMappingContext context)

apply

public Object apply(Object obj)

loading specified saved prefs to the obj The prefs can be selected by withPrefsGetterDefault() (default) or withPrefsGetterByNameEquals(String)

Parameters:

obj - the context target supplied by withContext(GuiMappingContext)

Returns:

apply()

apply

public Object apply()

applies the current context to applyForContext(GuiMappingContext)

Returns:

the returned object by applyForContext(GuiMappingContext)

applyForContext

public Object applyForContext(GuiMappingContext context)

takes prefs from the context and selects a prefs by the getter set by withPrefsGetter(Function), and calls load(GuiPreferences) with the prefs

Parameters:

context - the context for prefs

Returns:

the returned object by load

takeSavedPrefs

public GuiPreferences takeSavedPrefs()

takeSavedPrefs

public GuiPreferences takeSavedPrefs(GuiMappingContext context)

findSavedPrefsByName

public static GuiPreferences findSavedPrefsByName(GuiPreferences rootPrefs,
 Predicate<String> name)

getPrefsName

public static String getPrefsName(GuiPreferences savedPrefs)

findSavedPrefsDefault

public static GuiPreferences findSavedPrefsDefault(GuiPreferences rootPrefs)

load

public Object load(GuiPreferences prefs)

load(GuiPreferences, GuiReprValue.ObjectSpecifier) with GuiReprValue.NONE

Parameters:

prefs - the source prefs

Returns:

the current source value of the context

load

public Object load(GuiPreferences prefs,
 GuiReprValue.ObjectSpecifier specifier)

sets current saved value taken from the prefs to the properties of the source object of the context. It takes the context from prefs GuiPreferences.getContext()

Parameters:

prefs - the source prefs

specifier - the specifier

Returns:

context's GuiMappingContext.getSource() value or null

handleError

public void handleError(Throwable error,
 GuiPreferences prefs)

withArgNames

public GuiPreferencesLoader withArgNames(Map<GuiPreferencesLoader.PrefsLoaderCommandArg,List<String>> argNames)

sets command line args for parseArgs(List). e.g.

 .withArgNames(Map.of(
     LoadByName, List.of("-L", "--load"), //replace existing command options
     Help, List.of())) //no values: disable the option
   //for unspecified keys, default args are used.
  

Parameters:

argNames - the maps for customizing args

Returns:

this

parseArgs

public List<String> parseArgs(Object obj,
 String... args)

Parameters:

obj - the target obj

args - command args

Returns:

rest of consumed args

See Also:

• parseArgs(Object, List)

parseArgs

public List<String> parseArgs(Object obj,
 List<String> args)

Parameters:

obj - the target obj for calling withContext(GuiMappingContext)

args - command args

Returns:

rest of consumed args

See Also:

• parseArgs(List)

parseArgs

public List<String> parseArgs(List<String> args)

consume head args for GuiPreferencesLoader.PrefsLoaderCommandArg and do the option.

• GuiPreferencesLoader.PrefsLoaderCommandArg.LoadByName : -l <name>. consume 2 elements and runLoad(String)
• GuiPreferencesLoader.PrefsLoaderCommandArg.ShowNames : -s. consume 1 element and runShowNames()
• GuiPreferencesLoader.PrefsLoaderCommandArg.ShowJsonByName : -j <name>. consume 2 elements and runJson(String)
• GuiPreferencesLoader.PrefsLoaderCommandArg.Help : -h. checks the top element but not consume the -h, and runHelp()

If the top args do not match with those commands, nothing will happen. The method supposes the context is already set by withContext(GuiMappingContext)

Parameters:

args - the consumed args

Returns:

the rest of consumed args

runLoad

public void runLoad(String arg)

set prefs getter with arg and apply()

Parameters:

arg - the name for withPrefsGetterByNameEquals(String) or "." for withPrefsGetterDefault()

runShowNames

public void runShowNames()

println(Object) names of saved prefs for current context

runJson

public void runJson(String arg)

get the prefs and println(Object) JSON source of the prefs

Parameters:

arg - the name for withPrefsGetterByNameEquals(String) or "." for withPrefsGetterDefault()

runHelp

public void runHelp()

println(Object) help messages of GuiPreferencesLoader.PrefsLoaderCommandArg

println

public void println(Object o)