net.samuelcmace.utk.logic.AppStoragePaths Class Reference

Utility class associated with creating and retrieving the default file structure for the project. More...

Collaboration diagram for net.samuelcmace.utk.logic.AppStoragePaths:

Static Public Member Functions
static String	GetAppStorageDir ()
	Utility function to fetch the app storage directory.
static void	FirstTimeSetup () throws Exception
	Utility function to set up the initial file structure for the program if it doesn't already exist.
static String	GetLogFilePath ()
	Utility function to fetch the path for the application-level logging file.
static String	GetDBConfigFilePath ()
	Utility function to fetch the configuration file containing the database path.
static String	GetDBFilePath () throws Exception
	Utility function to fetch the path for the application-level database file.
static String	GetDBConnectionString () throws Exception
	Utility function to fetch the JDBC connection string for the application-level database.

Detailed Description

Utility class associated with creating and retrieving the default file structure for the project.

Member Function Documentation

FirstTimeSetup()

static void net.samuelcmace.utk.logic.AppStoragePaths.FirstTimeSetup ( ) throws Exception

static

Utility function to set up the initial file structure for the program if it doesn't already exist.

Exceptions

IOException

Thrown if either the default directory failed to create or the template database file failed to copy.

GetAppStorageDir()

static String net.samuelcmace.utk.logic.AppStoragePaths.GetAppStorageDir ( )

static

Utility function to fetch the app storage directory.

Returns

The application storage directory.

GetDBConfigFilePath()

static String net.samuelcmace.utk.logic.AppStoragePaths.GetDBConfigFilePath ( )

static

Utility function to fetch the configuration file containing the database path.

Returns

The configuration file path containing the database path.

GetDBConnectionString()

static String net.samuelcmace.utk.logic.AppStoragePaths.GetDBConnectionString ( ) throws Exception

static

Utility function to fetch the JDBC connection string for the application-level database.

Returns

The JDBC connection string associated with the database file.

GetDBFilePath()

static String net.samuelcmace.utk.logic.AppStoragePaths.GetDBFilePath ( ) throws Exception

static

Utility function to fetch the path for the application-level database file.

Returns

The application logging database path.

GetLogFilePath()

static String net.samuelcmace.utk.logic.AppStoragePaths.GetLogFilePath ( )

static

Utility function to fetch the path for the application-level logging file.

Returns

The application logging file path.

---

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

• /github/workspace/src/main/java/net/samuelcmace/utk/logic/AppStoragePaths.java