A PreferencesFactory which creates FilePreferences instances. More...

Inheritance diagram for net.sf.gridarta.preferences.FilePreferencesFactory:

Collaboration diagram for net.sf.gridarta.preferences.FilePreferencesFactory:

Public Member Functions
Preferences	systemRoot ()

Preferences	userRoot ()

Static Public Member Functions
static void	initialize (@NotNull final String defaultName, @Nullable final File file)
	Initialize the module. More...

Static Private Attributes
static Preferences	systemRoot
	The system preferences as returned by userRoot(). More...

static Preferences	userRoot
	The user preferences as returned by userRoot(). More...

Detailed Description

A PreferencesFactory which creates FilePreferences instances.

Author: Andreas Kirschbaum

Definition at line 33 of file FilePreferencesFactory.java.

Member Function Documentation

◆ initialize()

static void net.sf.gridarta.preferences.FilePreferencesFactory.initialize	(	@NotNull final String	defaultName,
		@Nullable final File	file
	)

static

Initialize the module.

This function must be called before an instance is used.

Parameters

defaultName	the default key name for loading/saving values
file	the file for loading/saving values or null to not use a backing file

Definition at line 54 of file FilePreferencesFactory.java.

References net.sf.gridarta.preferences.NodeType.SYSTEM, and net.sf.gridarta.preferences.NodeType.USER.

Referenced by net.sf.gridarta.maincontrol.GridartaEditor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.run(), net.sf.gridarta.gui.mapmenu.MapMenuUtilsTest.setUp(), net.sf.gridarta.gui.mapmenu.MapMenuTest.setUp(), and net.sf.gridarta.gui.mapmenu.MapMenuPreferencesTest.setUp().

Here is the caller graph for this function:

◆ systemRoot()

Preferences net.sf.gridarta.preferences.FilePreferencesFactory.systemRoot ( )

Definition at line 71 of file FilePreferencesFactory.java.

◆ userRoot()

Preferences net.sf.gridarta.preferences.FilePreferencesFactory.userRoot ( )

Definition at line 62 of file FilePreferencesFactory.java.

Member Data Documentation

◆ systemRoot

Preferences net.sf.gridarta.preferences.FilePreferencesFactory.systemRoot

staticprivate

The system preferences as returned by userRoot().

Definition at line 45 of file FilePreferencesFactory.java.

◆ userRoot

Preferences net.sf.gridarta.preferences.FilePreferencesFactory.userRoot

staticprivate

The user preferences as returned by userRoot().

Definition at line 39 of file FilePreferencesFactory.java.

The documentation for this class was generated from the following file:

gridarta-gridarta/src/preferences/src/main/java/net/sf/gridarta/preferences/FilePreferencesFactory.java

Public Member Functions

Static Public Member Functions

Static Private Attributes