dev.jeka.core.api.tooling.eclipse

Class JkEclipseClasspathGenerator

java.lang.Object

dev.jeka.core.api.tooling.eclipse.JkEclipseClasspathGenerator

public final class JkEclipseClasspathGenerator
extends java.lang.Object

Provides method to generate Eclipse .classpath metadata files.

Method Summary

Modifier and Type	Method and Description
JkEclipseClasspathGenerator	addAccessRule(JkDependency dependency, java.lang.String kind, java.lang.String pattern) For the specified dependency, specify a child accessrule tag to add to the mapping classpathentry tag.
JkEclipseClasspathGenerator	addAccessRules(JkDependency dependency, java.util.Properties rules)
JkEclipseClasspathGenerator	addAttribute(JkDependency dependency, java.lang.String name, java.lang.String value) For the specified dependency, specify a child attribute tag to add to the mapping classpathentry tag.
JkEclipseClasspathGenerator	addAttributes(JkDependency dependency, java.util.Properties attributes)
java.lang.String	generate() Generate the .classpath file
static JkEclipseClasspathGenerator	of(JkIdeSupport ideSupport) Constructs a JkEclipseClasspathGenerator.
JkEclipseClasspathGenerator	setDefDependencies(JkDependencyResolver buildDependencyResolver, JkDependencySet buildDependencies) If the build script depends on external libraries, you must set the resolver of these dependencies here.
JkEclipseClasspathGenerator	setImportedProjects(java.util.List<java.nio.file.Path> importedBuildProjects) If the build script depends on build script located in another projects, you must add those projects here.
JkEclipseClasspathGenerator	setIncludeJavadoc(boolean includeJavadoc) Set if generated .classpath file should contain javadoc link for libraries.
JkEclipseClasspathGenerator	setJreContainer(java.lang.String jreContainer) Specifies the exact string to use as jre container.
JkEclipseClasspathGenerator	setUsePathVariables(boolean usePathVariables) If true dependencies path will use JEKA_HOME and JEKA_REPO classpath variable instead of absolute paths.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static JkEclipseClasspathGenerator of(JkIdeSupport ideSupport)

Constructs a JkEclipseClasspathGenerator.

setIncludeJavadoc

public JkEclipseClasspathGenerator setIncludeJavadoc(boolean includeJavadoc)

Set if generated .classpath file should contain javadoc link for libraries.

setJreContainer

public JkEclipseClasspathGenerator setJreContainer(java.lang.String jreContainer)

Specifies the exact string to use as jre container.

setUsePathVariables

public JkEclipseClasspathGenerator setUsePathVariables(boolean usePathVariables)

If true dependencies path will use JEKA_HOME and JEKA_REPO classpath variable instead of absolute paths.

setImportedProjects

public JkEclipseClasspathGenerator setImportedProjects(java.util.List<java.nio.file.Path> importedBuildProjects)

If the build script depends on build script located in another projects, you must add those projects here.

setDefDependencies

public JkEclipseClasspathGenerator setDefDependencies(JkDependencyResolver buildDependencyResolver,
                                                      JkDependencySet buildDependencies)

If the build script depends on external libraries, you must set the resolver of these dependencies here.

addAttribute

public JkEclipseClasspathGenerator addAttribute(JkDependency dependency,
                                                java.lang.String name,
                                                java.lang.String value)

For the specified dependency, specify a child attribute tag to add to the mapping classpathentry tag.

Parameters:

dependency - The dependency paired to the classpathentry we want to generate `` children for. It can be a dev.jeka.core.api.depmanagement.JkModuleDependency or a JkFileSystemDependency. If it is a module dependency, it can be a direct or transitive dependency and only group:name is relevant.

addAttributes

public JkEclipseClasspathGenerator addAttributes(JkDependency dependency,
                                                 java.util.Properties attributes)

addAccessRule

public JkEclipseClasspathGenerator addAccessRule(JkDependency dependency,
                                                 java.lang.String kind,
                                                 java.lang.String pattern)

For the specified dependency, specify a child accessrule tag to add to the mapping classpathentry tag.

Parameters:

dependency - The dependency paired to the classpathentry we want to generate `` children for. It can be a dev.jeka.core.api.depmanagement.JkModuleDependency or a JkFileSystemDependency. If it is a module dependency, it can be a direct or transitive dependency and only group:name is relevant.

addAccessRules

public JkEclipseClasspathGenerator addAccessRules(JkDependency dependency,
                                                  java.util.Properties rules)

See Also:

addAccessRule(JkDependency, String, String)

generate

public java.lang.String generate()

Generate the .classpath file