gradle/org.gradle.api.tasks/WriteProperties

WriteProperties

@CacheableTask

abstract class WriteProperties : DefaultTask(source)

Writes a java.util.Properties in a way that the results can be expected to be reproducible.

There are a number of differences compared to how properties are stored:

no timestamp comment is generated at the beginning of the file
the lines in the resulting files are separated by a pre-set separator (defaults to '\n') instead of the system default line separator
the properties are sorted alphabetically

Like with java.util.Properties, Unicode characters are escaped when using the default Latin-1 (ISO-8559-1) encoding.

Since

3.3

Constructors

WriteProperties

constructor()

Properties

comment

@get:Nullable

@get:Optional

@get:Input

open var comment: String

description

open var description: String

enabled

open var enabled: Boolean

encoding

@get:Input

open var encoding: String

extra

val ExtensionAware.extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

group

open var group: String

impliesSubProjects

open var impliesSubProjects: Boolean

lineSeparator

@get:Input

open var lineSeparator: String

properties

@get:Input

val properties: Map<String, String>

state

val state: TaskStateInternal

TASK_ACTION

val TASK_ACTION: String = "action"

TASK_CONSTRUCTOR_ARGS

val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"

TASK_DEPENDS_ON

val TASK_DEPENDS_ON: String = "dependsOn"

TASK_DESCRIPTION

val TASK_DESCRIPTION: String = "description"

TASK_GROUP

val TASK_GROUP: String = "group"

TASK_NAME

val TASK_NAME: String = "name"

TASK_OVERWRITE

val TASK_OVERWRITE: String = "overwrite"

TASK_TYPE

val TASK_TYPE: String = "type"

timeout

val timeout: Property<Duration>

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

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

compareTo

open fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure): Task

abstract fun configure(cl: Closure): T

configure

inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

dependsOn

open fun dependsOn(paths: Array<Any>): Task

doFirst

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

doLast

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

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

finalizedBy

open fun finalizedBy(paths: Array<Any>): Task

getActions

open fun getActions(): List<Action<in Task>>

getAnt

open fun getAnt(): AntBuilder

getAsDynamicObject

open fun getAsDynamicObject(): DynamicObject

getConvention

open fun getConvention(): Convention

getDependsOn

open fun getDependsOn(): Set<Any>

getDestinationFile

@OutputFile

abstract fun getDestinationFile(): RegularFileProperty

The output properties file.

getDestroyables

open fun getDestroyables(): TaskDestroyables

getDidWork

open fun getDidWork(): Boolean

getExtensions

open fun getExtensions(): ExtensionContainer

getFinalizedBy

open fun getFinalizedBy(): TaskDependency

getIdentityPath

open fun getIdentityPath(): Path

getInputs

open fun getInputs(): TaskInputsInternal

abstract fun getInputs(): TaskInputs

getLifecycleDependencies

open fun getLifecycleDependencies(): TaskDependencyInternal

abstract fun getLifecycleDependencies(): TaskDependency

getLocalState

open fun getLocalState(): TaskLocalState

getLogger

open fun getLogger(): Logger

getLogging

open fun getLogging(): LoggingManager

getMustRunAfter

open fun getMustRunAfter(): TaskDependency

getName

open fun getName(): String

getOnlyIf

open fun getOnlyIf(): Spec<in TaskInternal>

getOutputFile

@Internal

open fun ~~getOutputFile~~(): File

Returns the output file to write the properties to.

getOutputs

open fun getOutputs(): TaskOutputsInternal

abstract fun getOutputs(): TaskOutputs

getPath

open fun getPath(): String

getProject

open fun getProject(): Project

getReasonNotToTrackState

open fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open fun getRequiredServices(): TaskRequiredServices

getSharedResources

open fun getSharedResources(): List<ResourceLock>

abstract fun getSharedResources(): List<out ResourceLock>

getShouldRunAfter

open fun getShouldRunAfter(): TaskDependency

getStandardOutputCapture

open fun getStandardOutputCapture(): StandardOutputCapture

getState

abstract fun getState(): TaskState

getTaskActions

open fun getTaskActions(): List<InputChangesAwareTaskAction>

getTaskDependencies

open fun getTaskDependencies(): TaskDependencyInternal

abstract fun getTaskDependencies(): TaskDependency

getTaskIdentity

open fun getTaskIdentity(): TaskIdentity<out Any>

getTemporaryDir

open fun getTemporaryDir(): File

getTemporaryDirFactory

open fun getTemporaryDirFactory(): Factory<File>

hasProperty

open fun hasProperty(propertyName: String): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

injectIntoNewInstance

open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T

isCompatibleWithConfigurationCache

open fun isCompatibleWithConfigurationCache(): Boolean

isEnabled

open fun isEnabled(): Boolean

isHasCustomActions

open fun isHasCustomActions(): Boolean

mustRunAfter

open fun mustRunAfter(paths: Array<Any>): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

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

prependParallelSafeAction

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

properties

open fun properties(properties: Map<String, Any>)

Adds multiple properties to be written to the properties file.

properties

inline fun WriteProperties.properties(vararg properties: Pair<String, Any?>)

Kotlin extension function for org.gradle.api.tasks.WriteProperties.properties.

property

open fun property(propertyName: String): Any

open fun property(name: String, value: Any)

Adds a property to be written to the properties file.

setActions

open fun setActions(replacements: List<Action<in Task>>)

setDependsOn

open fun setDependsOn(dependsOn: Iterable<out Any>)

setDidWork

open fun setDidWork(didWork: Boolean)

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)

setOnlyIf

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

setOutputFile

open fun ~~setOutputFile~~(outputFile: File)

open fun ~~setOutputFile~~(outputFile: Any)

Sets the output file to write the properties to.

setProperties

open fun setProperties(properties: Map<String, Any>)

Sets all properties to be written to the properties file replacing any existing properties.

setProperties

inline fun WriteProperties.setProperties(vararg properties: Pair<String, Any?>)

Kotlin extension function for org.gradle.api.tasks.WriteProperties.setProperties.

setProperty

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

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)

shouldRunAfter

open fun shouldRunAfter(paths: Array<Any>): TaskDependency

the

inline fun <T : Any> ExtensionAware.the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware.the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

usesService

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

writeProperties

open fun writeProperties()

WriteProperties

Since

See also

Constructors

Properties

Functions