PackageAvailArtifact

class PackageAvailArtifact

An object that contains the configuration state for building an Avail artifact.

Author

Richard Arriaga

Functions

Link copied to clipboard
fun addDirectory(file: File)

Add the directory to be included in the artifact jar. This must be a directory: File.isDirectory.

Link copied to clipboard
fun addFile(file: File, targetDirectory: String)

Add a singular File to be written in the specified target directory path inside the jar.

Link copied to clipboard
fun addJar(jar: JarFile)

Add the JarFile to be included in the artifact jar.

Link copied to clipboard
fun addJarPath(jarPath: String)

Add the string path to the JarFile to be included in the artifact jar.

Link copied to clipboard
fun addManifestAttributeEntry(key: String, value: String)

Add a custom field to the manifest file of an Avail artifact.

Link copied to clipboard
fun addZipFile(zipFile: ZipFile)

Add the ZipFile to be included in the artifact jar.

Link copied to clipboard
fun create()

This is the core action that is performed.

Link copied to clipboard
fun dependency(dependency: String)
fun dependency(dependency: Dependency)

Add a dependency to be included in the jar.

Link copied to clipboard
fun excludeRoot(rootName: String)

Exclude the provided AvailRoot.name from the artifact.

Properties

Link copied to clipboard
var artifactDigestAlgorithm: String

The MessageDigest algorithm to use to create the digests for all the Avail roots' contents. This must be a valid algorithm accessible from java.security.MessageDigest.getInstance.

Link copied to clipboard
var artifactName: String

The base name to give to the created artifact.

Link copied to clipboard
var artifactType: AvailArtifactType

The AvailArtifactType of the AvailArtifact to create.

Link copied to clipboard
var implementationTitle: String

The title of the artifact being created that will be added to the jar manifest (Attributes.Name.IMPLEMENTATION_TITLE).

Link copied to clipboard
var includeVersionInArtifactName: Boolean = true

true includes the version #, -.jar, in the jar name; false, .jar

Link copied to clipboard
var jarManifestMainClass: String

The Attributes.Name.MAIN_CLASS for the manifest or an empty string if no main class set. This should be the primary main class for starting the application.

Link copied to clipboard
var jvmComponent: JvmComponent

The JvmComponent that describes the JVM contents of the artifact of JvmComponent.NONE if no JVM components.

Link copied to clipboard
var outputDirectory: String

The absolute path to the directory location where the jar file is to be written.

Link copied to clipboard
var packageType: PackageType

The PackageType of the target artifact build.

Link copied to clipboard
val targetOutputJar: String

The absolute path to the jar file that will be created.

Link copied to clipboard
var version: String

The version to give to the created artifact (Attributes.Name.IMPLEMENTATION_VERSION).