avail-plugin/avail.plugin/CreateAvailArtifactJar

CreateAvailArtifactJar

abstract class CreateAvailArtifactJar : DefaultTask

Perform all tasks necessary to package the Avail Standard Library as an AvailArtifact.

This performs the following tasks:

Creates the ArtifactDescriptor file.
Creates the AvailArtifactManifest file.
Creates source digests file.

Author

Richard Arriaga

Constructors

CreateAvailArtifactJar

fun CreateAvailArtifactJar()

Types

object Companion

Functions

fun addDirectory(file: File)

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

fun addFile(file: File, targetDirectory: String)

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

fun addJar(jar: JarFile)

Add the JarFile to be included in the artifact jar.

addManifestAttributeEntry

fun addManifestAttributeEntry(key: String, value: String)

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

fun addRoot(root: String)

Add the Avail root to be included in the artifact jar.

fun addZipFile(zipFile: ZipFile)

Add the ZipFile to be included in the artifact jar.

appendParallelSafeAction

open override fun appendParallelSafeAction(p0: Action<in Task>)

open operator override fun compareTo(other: Task): Int

open override fun configure(p0: Closure<Any>): Task

createAvailArtifactJar

fun createAvailArtifactJar()

Construct the AvailArtifactJar.

fun dependency(dependency: String)

fun dependency(dependency: Dependency)

Add a dependency to be included in the jar.

open override fun dependsOn(vararg p0: Any): Task

open override fun doFirst(p0: Closure<Any>): Task

open override fun doFirst(p0: Action<in Task>): Task

open override fun doFirst(p0: String, p1: Action<in Task>): Task

open override fun doLast(p0: Closure<Any>): Task

open override fun doLast(p0: Action<in Task>): Task

open override fun doLast(p0: String, p1: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(p0: String)

open override fun finalizedBy(vararg p0: Any): Task

open override fun getActions(): MutableList<Action<in Task>>

open override fun getAnt(): AntBuilder

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

@Internal

~~open~~ ~~override~~ ~~fun~~ ~~getConvention~~(): Convention

open override fun getDependsOn(): MutableSet<Any>

open override fun getDescription(): String?

getDestroyables

open override fun getDestroyables(): TaskDestroyables

open override fun getDidWork(): Boolean

open override fun getEnabled(): Boolean

open override fun getExtensions(): ExtensionContainer

open override fun getFinalizedBy(): TaskDependency

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

getImpliesSubProjects

open override fun getImpliesSubProjects(): Boolean

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

open override fun getLocalState(): TaskLocalState

open override fun getLogger(): Logger

open override fun getLogging(): LoggingManager

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

open override fun getName(): String

open override fun getOnlyIf(): Spec<in TaskInternal>

open override fun getOutputs(): TaskOutputsInternal

open override fun getPath(): String

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): MutableSet<Provider<out BuildService<*>>>

@Internal

open fun getServices(): ServiceRegistry

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

open override fun getState(): TaskStateInternal

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

open override fun getTimeout(): Property<Duration>

open override fun hasProperty(p0: String): Boolean

open override fun hasTaskActions(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

@Internal

open fun isEnabled(): Boolean

isHasCustomActions

open override fun isHasCustomActions(): Boolean

open override fun mustRunAfter(vararg p0: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(p0: String)

open override fun onlyIf(p0: Closure<Any>)

open override fun onlyIf(p0: Spec<in Task>)

prependParallelSafeAction

open override fun prependParallelSafeAction(p0: Action<in Task>)

open override fun property(p0: String): Any?

open override fun setActions(p0: MutableList<Action<in Task>>)

open override fun setDependsOn(p0: MutableIterable<*>)

open override fun setDescription(p0: String?)

open override fun setDidWork(p0: Boolean)

open override fun setEnabled(p0: Boolean)

open override fun setFinalizedBy(p0: MutableIterable<*>)

open override fun setGroup(p0: String?)

setImpliesSubProjects

open override fun setImpliesSubProjects(p0: Boolean)

setMustRunAfter

open override fun setMustRunAfter(p0: MutableIterable<*>)

open override fun setOnlyIf(p0: Closure<Any>)

open override fun setOnlyIf(p0: Spec<in Task>)

open override fun setProperty(p0: String, p1: Any)

setShouldRunAfter

open override fun setShouldRunAfter(p0: MutableIterable<*>)

open override fun shouldRunAfter(vararg p0: Any): TaskDependency

open override fun usesService(p0: Provider<out BuildService<*>>)

Properties

artifactDescription

@Input

var artifactDescription: String

The description of the AvailArtifact used in the AvailArtifactManifest.

artifactDigestAlgorithm

@Input

var artifactDigestAlgorithm: String

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

@get:Input

abstract val artifactName: Property<String>

The base name of the artifact.

@Input

var artifactType: AvailArtifactType

The AvailArtifactType of the AvailArtifact to create.

implementationTitle

@Input

var implementationTitle: String

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

jarManifestMainClass

@Input

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.

@Input

var jvmComponent: JvmComponent

The JvmComponent that describes any JVM components being packaged in the artifact or JvmComponent.NONE if none.

outputDirectory

@Input

var outputDirectory: String

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

@get:Input

abstract val version: Property<String>

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