com.googlecode.fascinator.common

Class FascinatorHome

java.lang.Object

com.googlecode.fascinator.common.FascinatorHome

public class FascinatorHome
extends java.lang.Object

Manages the Fascinator home directory. Default Fascinator home directory: ${user.home}/.fascinator NOTE: ${user.home} in:

• Window: %USERPROFILE%
• Linux/Mac OS X: ~ or $HOME

To change Fascinator home directory add FASCINATOR_HOME environment variable

Author:

Oliver Lucido

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PATH Default Fascinator home directory
static org.slf4j.Logger	log Logging
static java.lang.String	SYSTEM_KEY System property key

Constructor Summary

Constructors

Constructor and Description
FascinatorHome()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getPath() Gets the Fascinator home directory, which is used for configuration, storage, etc.
static java.lang.String	getPath(java.lang.String subDir) Gets a relative directory inside the Fascinator home directory.
static java.io.File	getPathFile() Gets the Fascinator home directory as a File object.
static java.io.File	getPathFile(java.lang.String subDir) Gets a relative directory inside the Fascinator home directory.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.slf4j.Logger log

Logging

SYSTEM_KEY

public static final java.lang.String SYSTEM_KEY

System property key

See Also:

Constant Field Values

DEFAULT_PATH

public static final java.lang.String DEFAULT_PATH

Default Fascinator home directory

Constructor Detail

FascinatorHome

public FascinatorHome()

Method Detail

getPath

public static java.lang.String getPath()

Gets the Fascinator home directory, which is used for configuration, storage, etc. The directory can be set through the following:

• Environment variable: FASCINATOR_HOME
• System property: fascinator.home

Returns:

a directory path

getPath

public static java.lang.String getPath(java.lang.String subDir)

Gets a relative directory inside the Fascinator home directory.

Parameters:

subDir - the directory name

Returns:

a directory path

getPathFile

public static java.io.File getPathFile()

Gets the Fascinator home directory as a File object.

Returns:

a File representing the Fascinator home directory

getPathFile

public static java.io.File getPathFile(java.lang.String subDir)

Gets a relative directory inside the Fascinator home directory.

Parameters:

subDir - the directory name

Returns:

a File representing the directory