ome.smuggler.config

Class BaseDir

java.lang.Object

util.object.AbstractWrapper<T>

util.object.Wrapper<java.nio.file.Path>

ome.smuggler.config.BaseDir

All Implemented Interfaces:

java.util.function.Supplier<java.nio.file.Path>

Direct Known Subclasses:

BaseConfigDir, BaseDataDir

public class BaseDir
extends util.object.Wrapper<java.nio.file.Path>

Path to a directory used as a base for resolving paths in configuration files. The base directory path will be set to:

1. the value of a specified system property, if the property exists and its value is a string of length greater than 0; otherwise
2. the value of a specified environment variable, if such variable exists and its value is a string of length greater than 0; otherwise
3. the current working directory, i.e. the value of "user.dir".

Note that if the property or environment variable value is set to a relative path, then that path will be resolved against the current working directory.

Field Summary

Fields inherited from class util.object.Wrapper

wrappedValue

Constructor Summary

Constructors

Constructor and Description
BaseDir(java.lang.String sysPropKey, java.lang.String envVarName) Creates a new instance using the path returned by the lookup method.

Method Summary

Modifier and Type	Method and Description
static java.nio.file.Path	lookup(java.lang.String key, java.lang.String varName) Looks up the path associated to the specified key in the system properties.
java.nio.file.Path	resolve(java.lang.String configuredPath) Resolves the given path as follows.
java.nio.file.Path	resolveRequiredPath(java.lang.String configuredPath) Resolves the given path as follows.
static void	store(java.lang.String key, java.nio.file.Path dir) Sets a system property with the specified key and value.
static java.nio.file.Path	storeTempDir(java.lang.String key, java.lang.String dirNamePrefix) Creates a temporary directory and sets its path in the system properties using the given key.

Methods inherited from class util.object.Wrapper

get

Methods inherited from class util.object.AbstractWrapper

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseDir

public BaseDir(java.lang.String sysPropKey,
               java.lang.String envVarName)

Creates a new instance using the path returned by the lookup method.

Parameters:

sysPropKey - the system property key to pass to the lookup method.

envVarName - the name of the environment variable to pass to the lookup method.

Throws:

java.lang.IllegalArgumentException - if any argument is null or empty.

Method Detail

lookup

public static java.nio.file.Path lookup(java.lang.String key,
                                        java.lang.String varName)

Looks up the path associated to the specified key in the system properties. If no value is found for the key, the specified environment variable is used instead. If no value is found for this variable either, the current working directory is returned.

Parameters:

key - the system property key.

varName - the name of the environment variable.

Returns:

the path.

Throws:

java.lang.IllegalArgumentException - if any argument is null or empty.

store

public static void store(java.lang.String key,
                         java.nio.file.Path dir)

Sets a system property with the specified key and value.

Parameters:

key - the key.

dir - the value.

Throws:

java.lang.IllegalArgumentException - if the key is null or empty.

java.lang.NullPointerException - if dir is null.

storeTempDir

public static java.nio.file.Path storeTempDir(java.lang.String key,
                                              java.lang.String dirNamePrefix)
                                       throws java.io.IOException

Creates a temporary directory and sets its path in the system properties using the given key.

Parameters:

key - the system property key.

dirNamePrefix - name prefix of the temporary directory to create.

Returns:

the path to the newly created temporary directory.

Throws:

java.io.IOException - if the directory could not be created.

java.lang.IllegalArgumentException - if any argument is null or empty.

resolve

public java.nio.file.Path resolve(java.lang.String configuredPath)

Resolves the given path as follows. If the argument is already an absolute path, then it is returned as is; otherwise it is resolved against this base directory. In particular if the path argument is null or empty, this base directory is returned.

Parameters:

configuredPath - a path in a configuration file.

Returns:

the resolved path.

resolveRequiredPath

public java.nio.file.Path resolveRequiredPath(java.lang.String configuredPath)

Resolves the given path as follows. If the argument is already an absolute path, then it is returned as is; otherwise it is resolved against this base directory.

Parameters:

configuredPath - a path in a configuration file.

Returns:

the resolved path.

Throws:

java.lang.IllegalArgumentException - if the argument is null or empty.