dev.jeka.core.api.depmanagement.artifact

Class JkArtifactLocator

java.lang.Object

dev.jeka.core.api.depmanagement.artifact.JkArtifactLocator

public class JkArtifactLocator
extends java.lang.Object

Defines methods for enumerating and locating artifacts files likely to be produced.

Field Summary

Fields

Modifier and Type	Field and Description
static JkArtifactLocator	VOID Null-Case instance for JkArtifactLocator

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	getArtifactPath(JkArtifactId artifactId) Returns file system path where is supposed to be produced the specified artifact file id.
java.nio.file.Path	getArtifactPath(java.lang.String qualifier, java.lang.String extension) Returns the path where the specified artifact file is supposed to be produced.
java.lang.String	getMainArtifactExt() Returns the extension used by the main artifact.
JkArtifactId	getMainArtifactId() Returns the main artifact file id for this producer.
java.nio.file.Path	getMainArtifactPath() Returns the main artifact path.
static JkArtifactLocator	of(java.nio.file.Path outputDir, java.lang.String artifactBaseName) Creates a new JkArtifactLocator with the provided output directory and artifact base name.
static JkArtifactLocator	of(java.util.function.Supplier<java.nio.file.Path> outputDirSupplier, java.util.function.Supplier<java.lang.String> baseNameSupplier) Creates a new JkArtifactLocator with the provided output directory supplier and base name supplier.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

VOID

public static final JkArtifactLocator VOID

Null-Case instance for JkArtifactLocator

Method Detail

of

public static JkArtifactLocator of(java.util.function.Supplier<java.nio.file.Path> outputDirSupplier,
                                   java.util.function.Supplier<java.lang.String> baseNameSupplier)

Creates a new JkArtifactLocator with the provided output directory supplier and base name supplier.

Parameters:

outputDirSupplier - A supplier that provides the output directory path.

baseNameSupplier - A supplier that provides the base name.

of

public static JkArtifactLocator of(java.nio.file.Path outputDir,
                                   java.lang.String artifactBaseName)

Creates a new JkArtifactLocator with the provided output directory and artifact base name.

Parameters:

outputDir - The output directory path.

artifactBaseName - The base name of the artifact.

getArtifactPath

public java.nio.file.Path getArtifactPath(JkArtifactId artifactId)

Returns file system path where is supposed to be produced the specified artifact file id. This method is supposed to only returns the file reference and not generate it.

getArtifactPath

public java.nio.file.Path getArtifactPath(java.lang.String qualifier,
                                          java.lang.String extension)

Returns the path where the specified artifact file is supposed to be produced. This method is intended to only return the file reference and not generate it.

getMainArtifactId

public JkArtifactId getMainArtifactId()

Returns the main artifact file id for this producer. By default, it returns an artifact file id with no classifier and 'jar' getExtension.

getMainArtifactExt

public java.lang.String getMainArtifactExt()

Returns the extension used by the main artifact.

getMainArtifactPath

public java.nio.file.Path getMainArtifactPath()

Returns the main artifact path.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object