dev.jeka.core.api.system

Class JkLocator

java.lang.Object

dev.jeka.core.api.system.JkLocator

public final class JkLocator
extends java.lang.Object

Provides location related to the running Jeka instance.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GLOBAL_PROPERTIES_FILENAME

Constructor Summary

Constructors

Constructor and Description
JkLocator()

Method Summary

Modifier and Type	Method and Description
static java.nio.file.Path	getCacheDir()
static java.nio.file.Path	getCachedUrlContentDir()
static java.nio.file.Path	getGlobalPropertiesFile()
static java.nio.file.Path	getJekaHomeDir() Returns the directory where is installed the running Jeka instance.
static java.nio.file.Path	getJekaJarPath() Returns the Jeka jar file currently used in the running process.
static java.nio.file.Path	getJekaRepositoryCache() Returns the location of the artifact repository cache.
static java.nio.file.Path	getJekaUserHomeDir() Returns the Jeka user directory.
static boolean	isJekaProject(java.nio.file.Path baseDir) Determines whether the specified directory is a Jeka project.

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_PROPERTIES_FILENAME

public static final java.lang.String GLOBAL_PROPERTIES_FILENAME

See Also:

Constant Field Values

Constructor Detail

JkLocator

public JkLocator()

Method Detail

getJekaJarPath

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

Returns the Jeka jar file currently used in the running process. Returns a folder if the classes are not packaged in jar.

getJekaHomeDir

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

Returns the directory where is installed the running Jeka instance.

getJekaUserHomeDir

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

Returns the Jeka user directory.

getGlobalPropertiesFile

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

getJekaRepositoryCache

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

Returns the location of the artifact repository cache.

getCacheDir

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

getCachedUrlContentDir

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

isJekaProject

public static boolean isJekaProject(java.nio.file.Path baseDir)

Determines whether the specified directory is a Jeka project. A directory is considered a Jeka project if it contains a file named "jeka.properties" or a subdirectory named "jeka-src".

Parameters:

baseDir - the base directory to check, which must not be null

Returns:

true if the directory is identified as a Jeka project, false otherwise