SudokuFX
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Private Member Functions | Private Attributes | List of all members
fr.softsf.sudokufx.common.enums.AppPaths Enum Reference

Centralized registry of application-specific paths, both internal (classpath) and system-level. More...

+ Collaboration diagram for fr.softsf.sudokufx.common.enums.AppPaths:

Public Member Functions

 AppPaths (final String path)
 
final String getPath ()
 

Public Attributes

 CONFIG_LOGBACK_INVALID_PATH_FOR_TESTS =("/invalid/path")
 
 CONFIG_LOGBACK_PATH =("/fr/softsf/sudokufx/config/logback.xml")
 
 DATA_FOLDER =("data-sudokufx")
 
 DATABASE_MIGRATION_PATH =("/fr/softsf/sudokufx/flyway/scripts/hsqldb/migration")
 
 DATABASE_NAME =("sudokufxdb")
 
 I18N_PATH =("fr/softsf/sudokufx/i18n/resource")
 
 LINUX_BASE_PATH =(resolveXdgDataHome())
 
 LINUX_SUDO_FX_BASE_PATH =(LINUX_BASE_PATH.getPath() + "/Soft64.fr/SudokuFX/")
 
 LINUX_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX
 
 LINUX_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX
 
 LOGO_SUDO_PNG_PATH =("/fr/softsf/sudokufx/images/stage-icon.png")
 
 LOGS_FILE_NAME_PATH =("/SudokuFX.log")
 
 LOGS_FOLDER =("logs-sudokufx")
 
 MACOS_BASE_PATH =("/Library/Application Support/Soft64.fr/SudokuFX/")
 
 MACOS_SUDO_FX_BASE_PATH =(USER_HOME.getPath() + MACOS_BASE_PATH.getPath())
 
 MACOS_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX
 
 MACOS_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX
 
 RESOURCES_CSS_ALERT_PATH =("/fr/softsf/sudokufx/style/alert.css")
 
 RESOURCES_CSS_PATH =("/fr/softsf/sudokufx/style/style.css")
 
 RESOURCES_FXML_PATH =("/fr/softsf/sudokufx/fxml/")
 
 USER_HOME =(resolveUserHome())
 
 WINDOWS_BASE_PATH =("/AppData/Local/Soft64.fr/SudokuFX/")
 
 WINDOWS_SUDO_FX_BASE_PATH =(USER_HOME.getPath() + WINDOWS_BASE_PATH.getPath())
 
 WINDOWS_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX
 
 WINDOWS_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX
 

Static Private Member Functions

static String resolveUserHome ()
 Returns the user's home directory with forward slashes, for consistent path concatenation.
 
static String resolveXdgDataHome ()
 Resolves the user-specific data directory according to the XDG Base Directory Specification.
 

Private Attributes

final String path
 

Detailed Description

Centralized registry of application-specific paths, both internal (classpath) and system-level.

All paths are expressed as POSIX-style strings for consistency across platforms. System paths are dynamically resolved at runtime, including XDG-compliant locations on Linux.

Constructor & Destructor Documentation

◆ AppPaths()

fr.softsf.sudokufx.common.enums.AppPaths.AppPaths ( final String path)

Member Function Documentation

◆ getPath()

final String fr.softsf.sudokufx.common.enums.AppPaths.getPath ( )

◆ resolveUserHome()

static String fr.softsf.sudokufx.common.enums.AppPaths.resolveUserHome ( )
staticprivate

Returns the user's home directory with forward slashes, for consistent path concatenation.

◆ resolveXdgDataHome()

static String fr.softsf.sudokufx.common.enums.AppPaths.resolveXdgDataHome ( )
staticprivate

Resolves the user-specific data directory according to the XDG Base Directory Specification.

If the environment variable XDG_DATA_HOME is defined and non-empty, its value is used as the base directory for application data. Otherwise, the fallback
$HOME/.local/share is returned, ensuring compatibility with Linux systems that follow the XDG standard.

Backslashes are replaced with forward slashes to ensure consistent path formatting across operating systems, especially for string-based path composition.

Returns
a String representing the resolved data directory path in POSIX format
+ Here is the call graph for this function:

Member Data Documentation

◆ CONFIG_LOGBACK_INVALID_PATH_FOR_TESTS

fr.softsf.sudokufx.common.enums.AppPaths.CONFIG_LOGBACK_INVALID_PATH_FOR_TESTS =("/invalid/path")

◆ CONFIG_LOGBACK_PATH

fr.softsf.sudokufx.common.enums.AppPaths.CONFIG_LOGBACK_PATH =("/fr/softsf/sudokufx/config/logback.xml")

◆ DATA_FOLDER

fr.softsf.sudokufx.common.enums.AppPaths.DATA_FOLDER =("data-sudokufx")

◆ DATABASE_MIGRATION_PATH

fr.softsf.sudokufx.common.enums.AppPaths.DATABASE_MIGRATION_PATH =("/fr/softsf/sudokufx/flyway/scripts/hsqldb/migration")

◆ DATABASE_NAME

fr.softsf.sudokufx.common.enums.AppPaths.DATABASE_NAME =("sudokufxdb")

◆ I18N_PATH

fr.softsf.sudokufx.common.enums.AppPaths.I18N_PATH =("fr/softsf/sudokufx/i18n/resource")

◆ LINUX_BASE_PATH

fr.softsf.sudokufx.common.enums.AppPaths.LINUX_BASE_PATH =(resolveXdgDataHome())

◆ LINUX_SUDO_FX_BASE_PATH

fr.softsf.sudokufx.common.enums.AppPaths.LINUX_SUDO_FX_BASE_PATH =(LINUX_BASE_PATH.getPath() + "/Soft64.fr/SudokuFX/")

◆ LINUX_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX

fr.softsf.sudokufx.common.enums.AppPaths.LINUX_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX
Initial value:
=(
LINUX_SUDO_FX_BASE_PATH.getPath() + DATA_FOLDER.getPath())
fr.softsf.sudokufx.common.enums.AppPaths.LINUX_SUDO_FX_BASE_PATH
LINUX_SUDO_FX_BASE_PATH
Definition AppPaths.java:35
fr.softsf.sudokufx.common.enums.AppPaths.DATA_FOLDER
DATA_FOLDER
Definition AppPaths.java:27

◆ LINUX_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX

fr.softsf.sudokufx.common.enums.AppPaths.LINUX_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX
Initial value:
=(
LINUX_SUDO_FX_BASE_PATH.getPath() + LOGS_FOLDER.getPath())
fr.softsf.sudokufx.common.enums.AppPaths.LOGS_FOLDER
LOGS_FOLDER
Definition AppPaths.java:28

◆ LOGO_SUDO_PNG_PATH

fr.softsf.sudokufx.common.enums.AppPaths.LOGO_SUDO_PNG_PATH =("/fr/softsf/sudokufx/images/stage-icon.png")

◆ LOGS_FILE_NAME_PATH

fr.softsf.sudokufx.common.enums.AppPaths.LOGS_FILE_NAME_PATH =("/SudokuFX.log")

◆ LOGS_FOLDER

fr.softsf.sudokufx.common.enums.AppPaths.LOGS_FOLDER =("logs-sudokufx")

◆ MACOS_BASE_PATH

fr.softsf.sudokufx.common.enums.AppPaths.MACOS_BASE_PATH =("/Library/Application Support/Soft64.fr/SudokuFX/")

◆ MACOS_SUDO_FX_BASE_PATH

fr.softsf.sudokufx.common.enums.AppPaths.MACOS_SUDO_FX_BASE_PATH =(USER_HOME.getPath() + MACOS_BASE_PATH.getPath())

◆ MACOS_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX

fr.softsf.sudokufx.common.enums.AppPaths.MACOS_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX
Initial value:
=(
MACOS_SUDO_FX_BASE_PATH.getPath() + DATA_FOLDER.getPath())
fr.softsf.sudokufx.common.enums.AppPaths.MACOS_SUDO_FX_BASE_PATH
MACOS_SUDO_FX_BASE_PATH
Definition AppPaths.java:34

◆ MACOS_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX

fr.softsf.sudokufx.common.enums.AppPaths.MACOS_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX
Initial value:
=(
MACOS_SUDO_FX_BASE_PATH.getPath() + LOGS_FOLDER.getPath())

◆ path

final String fr.softsf.sudokufx.common.enums.AppPaths.path
private

◆ RESOURCES_CSS_ALERT_PATH

fr.softsf.sudokufx.common.enums.AppPaths.RESOURCES_CSS_ALERT_PATH =("/fr/softsf/sudokufx/style/alert.css")

◆ RESOURCES_CSS_PATH

fr.softsf.sudokufx.common.enums.AppPaths.RESOURCES_CSS_PATH =("/fr/softsf/sudokufx/style/style.css")

◆ RESOURCES_FXML_PATH

fr.softsf.sudokufx.common.enums.AppPaths.RESOURCES_FXML_PATH =("/fr/softsf/sudokufx/fxml/")

◆ USER_HOME

fr.softsf.sudokufx.common.enums.AppPaths.USER_HOME =(resolveUserHome())

◆ WINDOWS_BASE_PATH

fr.softsf.sudokufx.common.enums.AppPaths.WINDOWS_BASE_PATH =("/AppData/Local/Soft64.fr/SudokuFX/")

◆ WINDOWS_SUDO_FX_BASE_PATH

fr.softsf.sudokufx.common.enums.AppPaths.WINDOWS_SUDO_FX_BASE_PATH =(USER_HOME.getPath() + WINDOWS_BASE_PATH.getPath())

◆ WINDOWS_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX

fr.softsf.sudokufx.common.enums.AppPaths.WINDOWS_SUPPOSED_DATA_FOLDER_FOR_SUDO_FX
Initial value:
=(
WINDOWS_SUDO_FX_BASE_PATH.getPath() + DATA_FOLDER.getPath())
fr.softsf.sudokufx.common.enums.AppPaths.WINDOWS_SUDO_FX_BASE_PATH
WINDOWS_SUDO_FX_BASE_PATH
Definition AppPaths.java:33

◆ WINDOWS_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX

fr.softsf.sudokufx.common.enums.AppPaths.WINDOWS_SUPPOSED_LOGS_FOLDER_FOR_SUDO_FX
Initial value:
=(
WINDOWS_SUDO_FX_BASE_PATH.getPath() + LOGS_FOLDER.getPath())
The documentation for this enum was generated from the following file: