dev.jeka.core.api.depmanagement

Class JkComputedDependency

java.lang.Object

dev.jeka.core.api.depmanagement.JkComputedDependency

All Implemented Interfaces:

JkDependency, JkFileDependency

Direct Known Subclasses:

JkLocalProjectDependency

public class JkComputedDependency
extends java.lang.Object
implements JkFileDependency

Dependency on computed resource. More concretely, this is a JkFileDependencyon files that might not be present at the time of the build and that has to be generated. Instances of this class are responsible to generate the missing files.

Computed dependencies are instantiated by providing expected files and a Runnable that generates these files in case one of them is missing.

This is yet simple but quite powerful mechanism, cause the runnable can be anything as a Maven or an ANT build of another project, a Jeka build of another project, ...

This is the way to create multi-projects (and multi-techno) builds.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Iterable<java.nio.file.Path>	files
protected java.lang.Runnable	runnable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JkComputedDependency(java.lang.Runnable runnable, java.nio.file.Path ideProjectBaseDir, java.lang.Iterable<java.nio.file.Path> files) Constructs a computed dependency to the specified files and the specified Runnable to run for generating them.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.util.List<java.nio.file.Path>	getFiles()
java.nio.file.Path	getIdeProjectDir() If this dependency can be represented as a project dependency in an IDE, this field mentions the baseTree dir of the project.
java.util.Set<java.nio.file.Path>	getMissingFilesOrEmptyDirs() Returns the missing files or empty directory for this dependency.
int	hashCode()
boolean	hasMissingFilesOrEmptyDirs() Returns true if at least one of these files is missing or one of these directory is empty.
static JkComputedDependency	of(java.lang.Iterable<java.nio.file.Path> files, JkJavaProcess process) Same as of(Path, JkJavaProcess) but you must specify a set of files instead of a single one.
static JkComputedDependency	of(JkProcess process, java.nio.file.Path... files) Creates a computed dependency to the specified files and JkProcess to run for generating them.
static JkComputedDependency	of(java.nio.file.Path file, JkJavaProcess process) Creates a computed dependency to the specified file and the specified java program to run for generating them.
static JkComputedDependency	of(java.lang.Runnable runnable, java.nio.file.Path... files) Creates a computed dependency to the specified files and the specified Runnable to run for generating them.
java.lang.String	toString()
JkComputedDependency	withIdeProjectDir(java.nio.file.Path path) Returns a dependency identical to this one but with the specified project base dir.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.jeka.core.api.depmanagement.JkDependency

isCoordinate, matches, of, of

Field Detail

runnable

protected final java.lang.Runnable runnable

files

protected final java.lang.Iterable<java.nio.file.Path> files

Constructor Detail

JkComputedDependency

protected JkComputedDependency(java.lang.Runnable runnable,
                               java.nio.file.Path ideProjectBaseDir,
                               java.lang.Iterable<java.nio.file.Path> files)

Constructs a computed dependency to the specified files and the specified Runnable to run for generating them.

Method Detail

of

public static JkComputedDependency of(JkProcess process,
                                      java.nio.file.Path... files)

Creates a computed dependency to the specified files and JkProcess to run for generating them.

of

public static JkComputedDependency of(java.lang.Runnable runnable,
                                      java.nio.file.Path... files)

Creates a computed dependency to the specified files and the specified Runnable to run for generating them.

of

public static JkComputedDependency of(java.lang.Iterable<java.nio.file.Path> files,
                                      JkJavaProcess process)

Same as of(Path, JkJavaProcess) but you must specify a set of files instead of a single one.

of

public static JkComputedDependency of(java.nio.file.Path file,
                                      JkJavaProcess process)

Creates a computed dependency to the specified file and the specified java program to run for generating them.

hasMissingFilesOrEmptyDirs

public final boolean hasMissingFilesOrEmptyDirs()

Returns true if at least one of these files is missing or one of these directory is empty.

getMissingFilesOrEmptyDirs

public final java.util.Set<java.nio.file.Path> getMissingFilesOrEmptyDirs()

Returns the missing files or empty directory for this dependency.

getFiles

public java.util.List<java.nio.file.Path> getFiles()

Specified by:

getFiles in interface JkFileDependency

getIdeProjectDir

public java.nio.file.Path getIdeProjectDir()

If this dependency can be represented as a project dependency in an IDE, this field mentions the baseTree dir of the project.

Specified by:

getIdeProjectDir in interface JkDependency

withIdeProjectDir

public JkComputedDependency withIdeProjectDir(java.nio.file.Path path)

Description copied from interface: JkDependency

Returns a dependency identical to this one but with the specified project base dir.

Specified by:

withIdeProjectDir in interface JkDependency

See Also:

JkDependency.getIdeProjectDir()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object