velox.api.layer1.common

Class DirectoryResolver

java.lang.Object

velox.api.layer1.common.DirectoryResolver

public class DirectoryResolver
extends java.lang.Object

This class contains access methods to Bookmap folder structure

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	BOOKMAP_USER_HOME
private static java.lang.String	WORK_DIR

Constructor Summary

Constructors

Constructor and Description
DirectoryResolver()

Method Summary

Modifier and Type	Method and Description
private static java.lang.String	bookmapUserHome()
static java.nio.file.Path	getBookmapDirectoryByName(java.lang.String folderName) Allows to get subfloder in Bookmap directory.
static java.nio.file.Path	getBookmapRootDirectory() Allows to access Bookmap root directory On windows: C:\Bookmap by default, may be changed during installation On mac: ~/Library/Application Support/Bookmap On linux: ~/.bookmap
static java.nio.file.Path	getCacheDirectory()
static java.nio.file.Path	getConfigDirectory() Config directory is where all configuration files for Bookmap are stored.
static java.nio.file.Path	getDataLibraryDirectory()
static java.nio.file.Path	getDiagnosticLogsDirectory()
static java.nio.file.Path	getErrorReportsDirectory()
static java.nio.file.Path	getFeedsDirectory()
static java.nio.file.Path	getLayer0ApiModulesDirectory()
static java.nio.file.Path	getLogsDirectory()
static java.nio.file.Path	getScreenshotsDirectory()
static java.nio.file.Path	getSoundsDirectory()
private static java.lang.String	workDir()

Methods inherited from class java.lang.Object

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

Field Detail

WORK_DIR

private static final java.lang.String WORK_DIR

BOOKMAP_USER_HOME

private static final java.lang.String BOOKMAP_USER_HOME

Constructor Detail

DirectoryResolver

public DirectoryResolver()

Method Detail

getBookmapRootDirectory

public static java.nio.file.Path getBookmapRootDirectory()

Allows to access Bookmap root directory On windows: C:\Bookmap by default, may be changed during installation On mac: ~/Library/Application Support/Bookmap On linux: ~/.bookmap

Returns:

Bookmap root directory

getBookmapDirectoryByName

public static java.nio.file.Path getBookmapDirectoryByName(java.lang.String folderName)

Allows to get subfloder in Bookmap directory. Can be used to create custom folders or files. Example: { Path myFolder = DirectoryResolver.getBookmapDirectoryByName("MyFolder"); Files.createDirectories(myFolder); myFolder.resolve("myFile").toFile().createNewFile(); }

Parameters:

folderName - Name of subfolder under Bookmap root directory

Returns:

Path representing subfolder with name folderName under Bookmap root directory

getConfigDirectory

public static java.nio.file.Path getConfigDirectory()

Config directory is where all configuration files for Bookmap are stored. Also this is working directory for Bookmap java process.

Returns:

Path representing Config directory under Bookmap root directory

getLogsDirectory

public static java.nio.file.Path getLogsDirectory()

getFeedsDirectory

public static java.nio.file.Path getFeedsDirectory()

getErrorReportsDirectory

public static java.nio.file.Path getErrorReportsDirectory()

getScreenshotsDirectory

public static java.nio.file.Path getScreenshotsDirectory()

getDiagnosticLogsDirectory

public static java.nio.file.Path getDiagnosticLogsDirectory()

getSoundsDirectory

public static java.nio.file.Path getSoundsDirectory()

getLayer0ApiModulesDirectory

public static java.nio.file.Path getLayer0ApiModulesDirectory()

getCacheDirectory

public static java.nio.file.Path getCacheDirectory()

getDataLibraryDirectory

public static java.nio.file.Path getDataLibraryDirectory()

workDir

private static java.lang.String workDir()

bookmapUserHome

private static java.lang.String bookmapUserHome()