gradle-plugin/io.spine.embedcode.gradle/EmbedCodeTask

EmbedCodeTask

@DisableCachingByDefault(because = "Embed Code checks or updates documentation files in place")

abstract class EmbedCodeTask : DefaultTask

Runs Embed Code in either check or embed mode.

Constructors

EmbedCodeTask

constructor()

Properties

actions

open var actions: List<Action<in Task?>?>?

ant

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

codePath

@get:InputDirectory

@get:Optional

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val codePath: DirectoryProperty

The source root passed to -code-path.

dependsOn

open val dependsOn: Set<Any?>?

description

open var description: @Nullable String?

destroyables

open val destroyables: TaskDestroyables?

didWork

open var didWork: Boolean

docExcludes

@get:Input

abstract val docExcludes: ListProperty<String>

Documentation exclude patterns passed to -doc-excludes.

docIncludes

@get:Input

abstract val docIncludes: ListProperty<String>

Documentation include patterns passed to -doc-includes.

docsPath

@get:InputDirectory

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val docsPath: DirectoryProperty

The documentation root passed to -docs-path.

enabled

open var enabled: Boolean

executableFile

@get:InputFile

@get:PathSensitive(value = PathSensitivity.NONE)

abstract val executableFile: RegularFileProperty

The installed platform executable.

extensions

open val extensions: ExtensionContainer?

finalizedBy

open val finalizedBy: TaskDependency?

group

open var group: @Nullable String?

identityPath

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

info

@get:Input

abstract val info: Property<Boolean>

Whether informational logging is enabled.

inputs

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

isEnabled

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

localState

open val localState: TaskLocalState?

logger

open val logger: Logger?

logging

open val logging: LoggingManager?

mode

@get:Input

abstract val mode: Property<String>

The execution mode assigned by the plugin.

mustRunAfter

open val mustRunAfter: TaskDependency?

name

open val name: String?

namedSourceDirectories

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val namedSourceDirectories: ConfigurableFileCollection

Named source directories with their producing task dependencies.

namedSources

@get:Input

abstract val namedSources: MapProperty<String, String>

Named source roots included in an internally generated configuration.

onlyIf

open val onlyIf: Spec<in TaskInternal?>?

outputs

open val outputs: TaskOutputsInternal?

path

open val path: String?

project

open val project: Project?

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonsNotToTrackState

open val reasonsNotToTrackState: Set<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

separator

@get:Input

abstract val separator: Property<String>

The fragment separator passed to -separator.

sharedResources

open val sharedResources: List<ResourceLock?>?

shouldRunAfter

open val shouldRunAfter: TaskDependency?

stacktrace

@get:Input

abstract val stacktrace: Property<Boolean>

Whether panic stack traces are enabled.

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

state

open val state: TaskStateInternal?

taskActions

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

taskIdentity

open val taskIdentity: TaskIdentity<*>?

temporaryDir

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

timeout

open val timeout: Property<Duration?>?

workingDirectory

@get:Internal

abstract val workingDirectory: DirectoryProperty

The process working directory.

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

compareTo

open operator fun compareTo(otherTask: Task?): Int

configure

open fun configure(closure: Closure<*>?): Task?

dependsOn

open fun dependsOn(vararg paths: Any?): Task?

doFirst

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

doLast

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

doNotTrackStateIf

open fun doNotTrackStateIf(reason: String?, spec: Spec<in TaskInternal?>?)

finalizedBy

open fun finalizedBy(vararg paths: Any?): Task?

hasProperty

open fun hasProperty(propertyName: String?): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

mustRunAfter

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

onlyIf

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

property

open fun property(propertyName: String?): Any?

restoreOnlyIf

open fun restoreOnlyIf(onlyIf: Spec<in TaskInternal?>?)

restoreTaskActions

open fun restoreTaskActions(taskActions: List<InputChangesAwareTaskAction?>?)

runEmbedCode

fun runEmbedCode()

Executes Embed Code with arguments derived from the Gradle extension.

setDependsOn

open fun setDependsOn(dependsOn: Iterable<*>?)

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

setOnlyIf

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

setProperty

open fun setProperty(name: String?, value: Any?)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

shouldRunAfter

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

usesService

open fun usesService(service: Provider<out BuildService<*>?>?)