dev.jeka.core.tool.builtins.tooling.ide

Class IntellijKBean

java.lang.Object

dev.jeka.core.tool.KBean

dev.jeka.core.tool.builtins.tooling.ide.IntellijKBean

public final class IntellijKBean
extends KBean

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IML_SKIP_MODULE_XML_PROP
java.nio.file.Path	imlFile

Constructor Summary

Constructors

Constructor and Description
IntellijKBean()

Method Summary

Modifier and Type	Method and Description
IntellijKBean	addModule(java.lang.String moduleName, JkIml.Scope scope) Adds a module dependency to the IntelliJ project configuration with the specified scope.
IntellijKBean	addProjectLibrary(java.lang.String xml)
void	allIml() Deprecated. Use syncAll() instead.
IntellijKBean	configureIml(java.util.function.Consumer<JkIml> imlConfigurator) Configures IML file that will be generated.
IntellijKBean	excludeJekaLib() In a multi-module project, a module that this one depends on might already include the Jeka dependency.
void	iml() Deprecated. Use sync() instead.
void	initProject()
void	modulesXml() Generate modules.xml files
IntellijKBean	replaceLibByModule(java.lang.String libName, java.lang.String moduleName) Replaces the specified library with the specified module.
IntellijKBean	setModuleAttributes(java.lang.String moduleName, JkIml.Scope scope, java.lang.Boolean exported) Sets the scope and exported attribute to the specified module.
IntellijKBean	setSuggestedJdk(java.lang.String sdkName) Sets the Jdk to be referenced in the generated iml file, if none is specified by jdkName.
void	sync()
void	syncAll()

Methods inherited from class dev.jeka.core.tool.KBean

cleanOutput, find, getBaseDir, getBaseDirName, getBasePath, getOutputDir, getRunbase, init, load, toString

Methods inherited from class java.lang.Object

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

Field Detail

IML_SKIP_MODULE_XML_PROP

public static final java.lang.String IML_SKIP_MODULE_XML_PROP

See Also:

Constant Field Values

imlFile

public java.nio.file.Path imlFile

Constructor Detail

IntellijKBean

public IntellijKBean()

Method Detail

iml

@Deprecated
public void iml()

Deprecated. Use sync() instead.

sync

public void sync()

modulesXml

public void modulesXml()

Generate modules.xml files

allIml

@Deprecated
public void allIml()

Deprecated. Use syncAll() instead.

syncAll

public void syncAll()

initProject

public void initProject()

configureIml

public IntellijKBean configureIml(java.util.function.Consumer<JkIml> imlConfigurator)

Configures IML file that will be generated.

excludeJekaLib

public IntellijKBean excludeJekaLib()

In a multi-module project, a module that this one depends on might already include the Jeka dependency. This method prevents adding the Jeka dependency directly to this module.

replaceLibByModule

public IntellijKBean replaceLibByModule(java.lang.String libName,
                                        java.lang.String moduleName)

Replaces the specified library with the specified module. The library is specified by the end of its path. For example, '-foo.bar' will replace 'mylibs/core-foo.jar' by the specified module. Only the first matching lib is replaced.

See Also:

JkIml.Component#replaceLibByModule(String, String)

addModule

public IntellijKBean addModule(java.lang.String moduleName,
                               JkIml.Scope scope)

Adds a module dependency to the IntelliJ project configuration with the specified scope.

Parameters:

moduleName - The name of the module to be added as a dependency.

scope - The scope of the module dependency, defined by JkIml.Scope.

Returns:

The current instance of IntellijKBean for method chaining.

setModuleAttributes

public IntellijKBean setModuleAttributes(java.lang.String moduleName,
                                         JkIml.Scope scope,
                                         java.lang.Boolean exported)

Sets the scope and exported attribute to the specified module.

See Also:

JkIml.Component#setModuleAttributes(String, JkIml.Scope, Boolean)

setSuggestedJdk

public IntellijKBean setSuggestedJdk(java.lang.String sdkName)

Sets the Jdk to be referenced in the generated iml file, if none is specified by jdkName.

Parameters:

sdkName - The JDK name as exists in Intellij SDKs.

addProjectLibrary

public IntellijKBean addProjectLibrary(java.lang.String xml)