dev.jeka.core.tool

Class JkExternalToolApi

java.lang.Object

dev.jeka.core.tool.JkExternalToolApi

public final class JkExternalToolApi
extends java.lang.Object

Exported methods to integrate with external tools.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JkExternalToolApi.InitKBeans

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CMD_APPEND_SUFFIX_PROP
static java.lang.String	CMD_PREFIX_PROP
static java.lang.String	CMD_SUBSTITUTE_SYMBOL

Method Summary

Modifier and Type	Method and Description
static java.lang.String	ansiText(java.lang.String templatedText) Converts the given templated text to ANSI escape sequences.
static java.util.List<java.lang.String[]>	availableOptions() Retrieves a list of available command-line options for the annotated class.
static java.lang.String	getBeanName(java.lang.String fullyQualifiedClassName) Retrieves the bean name for the given fully qualified class name.
static java.util.List<java.lang.String>	getCachedBeanClassNames(java.nio.file.Path baseDir) Returns the cached bean class names for the given base dir.
static java.util.Map<java.lang.String,java.lang.String>	getCmdShorthandsProperties(java.nio.file.Path baseDir) Returns the command shorthand properties defined in properties files, from the specified base dir context.
static JkExternalToolApi.InitKBeans	getDefaultAndInitKBeans(java.nio.file.Path baseDir) Retrieves the default and initialization KBean class names for the specified base directory.
static java.util.List<java.nio.file.Path>	getDefDependenciesClasspath(java.nio.file.Path projectDir) Returns the default dependencies classpath for the specified project directory..
static JkRepoSet	getDownloadRepos(java.nio.file.Path baseDir) Returns download repositories for the specified base directory.
static JkProperties	getGlobalProperties() Returns the global properties.
static java.nio.file.Path	getImlFile(java.nio.file.Path moduleDir) Retrieves the path of the iml file for the given module directory.
static java.nio.file.Path	getKBeanClassnameCacheFile(java.nio.file.Path baseDir) Resolves and retrieves the path to the KBean class name cache file located in the specified base directory.
static java.nio.file.Path	getKBeanClasspathCacheFile(java.nio.file.Path baseDir) Resolves the path to the KBean classpath cache file located in the specified base directory.
static JkProperties	getProperties(java.nio.file.Path baseDir) Returns the properties defined from the specifies base dir..
static boolean	isJekaProject(java.nio.file.Path candidate) Returns true if the specified path is the root directory of a Jeka project.
static boolean	kbeanNameMatches(java.lang.String className, java.lang.String candidate) Checks if the specified className matches the given candidate name.

Methods inherited from class java.lang.Object

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

Field Detail

CMD_PREFIX_PROP

public static final java.lang.String CMD_PREFIX_PROP

See Also:

Constant Field Values

CMD_APPEND_SUFFIX_PROP

public static final java.lang.String CMD_APPEND_SUFFIX_PROP

See Also:

Constant Field Values

CMD_SUBSTITUTE_SYMBOL

public static final java.lang.String CMD_SUBSTITUTE_SYMBOL

See Also:

Constant Field Values

Method Detail

ansiText

public static java.lang.String ansiText(java.lang.String templatedText)

Converts the given templated text to ANSI escape sequences.

Parameters:

templatedText - the input text to be converted to ANSI escape sequences

Returns:

the converted text with ANSI escape sequences

getBeanName

public static java.lang.String getBeanName(java.lang.String fullyQualifiedClassName)

Retrieves the bean name for the given fully qualified class name.

getCachedBeanClassNames

public static java.util.List<java.lang.String> getCachedBeanClassNames(java.nio.file.Path baseDir)

Returns the cached bean class names for the given base dir.

getDownloadRepos

public static JkRepoSet getDownloadRepos(java.nio.file.Path baseDir)

Returns download repositories for the specified base directory.

isJekaProject

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

Returns true if the specified path is the root directory of a Jeka project.

getImlFile

public static java.nio.file.Path getImlFile(java.nio.file.Path moduleDir)

Retrieves the path of the iml file for the given module directory.

getCmdShorthandsProperties

public static java.util.Map<java.lang.String,java.lang.String> getCmdShorthandsProperties(java.nio.file.Path baseDir)

Returns the command shorthand properties defined in properties files, from the specified base dir context.

getProperties

public static JkProperties getProperties(java.nio.file.Path baseDir)

Returns the properties defined from the specifies base dir..

getGlobalProperties

public static JkProperties getGlobalProperties()

Returns the global properties.

getDefDependenciesClasspath

public static java.util.List<java.nio.file.Path> getDefDependenciesClasspath(java.nio.file.Path projectDir)

Returns the default dependencies classpath for the specified project directory..

kbeanNameMatches

public static boolean kbeanNameMatches(java.lang.String className,
                                       java.lang.String candidate)

Checks if the specified className matches the given candidate name.

Parameters:

className - The fully qualified class name to compare.

candidate - The name candidate to match against the class name.

Returns:

True if the candidate matches the class name, false otherwise.

getKBeanClassnameCacheFile

public static java.nio.file.Path getKBeanClassnameCacheFile(java.nio.file.Path baseDir)

Resolves and retrieves the path to the KBean class name cache file located in the specified base directory.

Parameters:

baseDir - the root directory from which the path will be resolved

Returns:

the resolved path to the KBean class name cache file

getKBeanClasspathCacheFile

public static java.nio.file.Path getKBeanClasspathCacheFile(java.nio.file.Path baseDir)

Resolves the path to the KBean classpath cache file located in the specified base directory.

Parameters:

baseDir - the base directory from which the path to the KBean classpath cache file will be resolved

Returns:

the resolved path to the KBean classpath cache file

availableOptions

public static java.util.List<java.lang.String[]> availableOptions()

Retrieves a list of available command-line options for the annotated class. Each option is represented as an array of strings, containing the following information: - The option's longest name. - The option's description. - The type name of the option. - The parameter label of the option.

Returns:

a list of string arrays, each representing an available option's details

getDefaultAndInitKBeans

public static JkExternalToolApi.InitKBeans getDefaultAndInitKBeans(java.nio.file.Path baseDir)

Retrieves the default and initialization KBean class names for the specified base directory.

Parameters:

baseDir - the base directory from which to read and determine the KBean class names

Returns:

an instance of EngineClasspathCache.DefafaulAndInitKBeans containing the default and initialization KBean class names