debugbackend

Class PluginPaths

java.lang.Object

debugbackend.PluginPaths

public class PluginPaths
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PluginPaths()

Method Summary

Modifier and Type	Method and Description
static java.nio.file.Path	getConfigPath() Returns an absolute path to the configuration file, where the configuration to be loaded for the plugin is located.
static java.nio.file.Path	getDebugFolder() Returns an absolute path to the debug folder, where debug files are stored.
static java.nio.file.Path	getEditorFolder() Returns an absolute path to the editor folder, where any files concerning BrowserEditor instances are stored.
static java.nio.file.Path	getLanguageFolder() Returns an absolute path to the language folder, where all language files are stored.
static java.nio.file.Path	getLanguagePath(java.lang.String fileName) Returns an absolute path to the language file stored under the given file name.
static java.nio.file.Path	getManualFolder() Returns an absolute path to the manual folder, where all manual files are stored.
static java.lang.String	getPathForHtml(java.nio.file.Path path) Returns the given path in a form which is suitable to use in HTML, e.g.
static java.nio.file.Path	getPluginFolder() Returns an absolute path to the folder where the plugin files are located.
static java.nio.file.Path	getSchemaPath() Returns an absolute path to the schema file, where the schema to be loaded for the plugin's configuration is located.
static java.nio.file.Path	getTelemetryFolder() Returns an absolute path to the telemetry folder, where telemetry files are stored.
static java.nio.file.Path	getUserFolder() Returns an absolute path to the folder where the user-defined files are located.
static boolean	resetConfigPath() Resets the configuration path to its default value.
static void	resetFolder(java.nio.file.Path folder) Resets the given folder.
static boolean	setConfigPath(java.nio.file.Path path) Set the configuration path to the given path.
static java.util.concurrent.Future<java.lang.Boolean>	storeConfiguration() Store the current configuration on file.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginPaths

public PluginPaths()

Method Detail

getPluginFolder

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

Returns an absolute path to the folder where the plugin files are located. This location should, for example, contain the CSS/Javascript files needed for the browser.

Returns:

An absolute path to the folder where the plugin files are located.

getUserFolder

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

Returns an absolute path to the folder where the user-defined files are located. The user-defined files includes the configuration file and possibly a "configFile.txt" file pointing to another configuration location.

Returns:

The path to the user folder, where the configuration file is located.

storeConfiguration

public static java.util.concurrent.Future<java.lang.Boolean> storeConfiguration()

Store the current configuration on file. The configuration is stored asynchronously in a background process. The return value contains a future indicating whether the configuration was stored.

Returns:

A Future indicating whether the configuration was stored.

getConfigPath

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

Returns an absolute path to the configuration file, where the configuration to be loaded for the plugin is located.

Returns:

An absolute path to the configuration file.

setConfigPath

public static boolean setConfigPath(java.nio.file.Path path)

Set the configuration path to the given path. The path will be set for the current execution, but also persisted for future executions of the system.

Parameters:

path - The path to set the configuration path to.

Returns:

Whether the configuration path was persisted successfully. The current configuration path will always be set, but the return value indicates whether it was persisted for future executions.

resetConfigPath

public static boolean resetConfigPath()

Resets the configuration path to its default value. The configuration path will be reset for the current execution, but also persisted for future executions of the system.

Returns:

Whether the reset was persisted successfully. The current configuration path will always be reset but the return value indicates whether it was persisted for future executions.

getSchemaPath

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

Returns an absolute path to the schema file, where the schema to be loaded for the plugin's configuration is located.

Returns:

An absolute path to the schema file.

getEditorFolder

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

Returns an absolute path to the editor folder, where any files concerning BrowserEditor instances are stored.

Returns:

An absolute path to the editor folder.

getLanguageFolder

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

Returns an absolute path to the language folder, where all language files are stored.

Returns:

An absolute path to the language folder.

getLanguagePath

public static java.nio.file.Path getLanguagePath(java.lang.String fileName)

Returns an absolute path to the language file stored under the given file name.

Parameters:

fileName - The fileName for which to get the language. This must be only the name, not a path.

Returns:

An absolute path to the language file.

getManualFolder

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

Returns an absolute path to the manual folder, where all manual files are stored.

Returns:

An absolute path to the manual folder.

getPathForHtml

public static java.lang.String getPathForHtml(java.nio.file.Path path)

Returns the given path in a form which is suitable to use in HTML, e.g. as an href target.

Parameters:

path - The path to make suitable.

Returns:

A representation of the path suitable to use in HTML.

getDebugFolder

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

Returns an absolute path to the debug folder, where debug files are stored.

Returns:

An absolute path to the debug folder.

getTelemetryFolder

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

Returns an absolute path to the telemetry folder, where telemetry files are stored.

Returns:

An absolute path to the telemetry folder.

resetFolder

public static void resetFolder(java.nio.file.Path folder)
                        throws java.io.IOException

Resets the given folder. This ensures the folder exists, and empties its contents.

Throws:

java.io.IOException - If any of the operations during resetting throw an IOException, it is sent further.