public final class Storage
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static java.nio.file.Path |
createRecordingFilePath(java.time.Instant startTime)
Generates the path to a recording file based on when a recording started.
|
static java.nio.file.Path |
getPluginPath()
The directory that plugins are loaded from.
|
static java.io.File |
getRecordingDir()
The directory that contains the nested recording files and sub-directories.
|
static java.io.File |
getStorageDir()
The main storage directory that all Shuffleboard files should exist in.
|
static java.nio.file.Path |
getThemesDir()
Gets the directory for custom external themes, creating it if it does not exist.
|
public static java.io.File getStorageDir() throws java.io.IOException
java.io.IOException
- if creating the directory failspublic static java.io.File getRecordingDir() throws java.io.IOException
java.io.IOException
- if creating the directory failspublic static java.nio.file.Path getPluginPath() throws java.io.IOException
java.io.IOException
- if creating the directory failspublic static java.nio.file.Path getThemesDir() throws java.io.IOException
java.io.IOException
- if the directory cannot be createdpublic static java.nio.file.Path createRecordingFilePath(java.time.Instant startTime) throws java.io.IOException
/Shuffleboard/recordings/<date>/recording-<time>.sbr
, where date
is the date formatted by the
ISO-8601 format, and time
is a modified version that uses periods ("."
) instead of colons because
Windows does not allow colon characters in file names.startTime
- the time the recording startedjava.io.IOException