com.xatkit.util

Class FileUtils

java.lang.Object

com.xatkit.util.FileUtils

public class FileUtils
extends Object

Utility methods to load Xatkit-related files.

Constructor Summary

Constructors

Constructor and Description
FileUtils()

Method Summary

Modifier and Type	Method and Description
static File	getFile(String path, Configuration configuration) Retrieves the File corresponding to the provided path.
static File	getXatkitDirectory() Returns the Xatkit installation directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtils

public FileUtils()

Method Detail

getFile

public static File getFile(String path,
                           Configuration configuration)

Retrieves the File corresponding to the provided path.

This method supports absolute and relative paths. Relative path are resolved against the configuration directory (see XatkitCore.CONFIGURATION_FOLDER_PATH_KEY). If this directory is not specified then the execution directory is used to resolve relative paths.

Parameters:

path - the path of the File to retrieve

configuration - the Xatkit Configuration

Returns:

the retrieved File

getXatkitDirectory

public static File getXatkitDirectory()
                               throws FileNotFoundException

Returns the Xatkit installation directory.

This method looks for the directory location stored in the XATKIT environment variable. If the directory does not exist a FileNotFoundException is thrown.

XATKIT environment variable can be set following this tutorial: https://github .com/xatkit-bot-platform/xatkit-releases/wiki/Installation.

Returns:

the Xatkit installation directory

Throws:

FileNotFoundException - if the Xatkit installation directory does not exist