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

See also

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@get:Nullable
@get:Optional
@get:Input
open var comment: String
Link copied to clipboard
open var description: String
Link copied to clipboard
open var enabled: Boolean
Link copied to clipboard
@get:Input
open var encoding: String
Link copied to clipboard
val ExtensionAware.extra: ExtraPropertiesExtension

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

Link copied to clipboard
open var group: String
Link copied to clipboard
open var impliesSubProjects: Boolean
Link copied to clipboard
@get:Input
open var lineSeparator: String
Link copied to clipboard
@get:Input
val properties: Map<String, String>
Link copied to clipboard
val state: TaskStateInternal
Link copied to clipboard
val TASK_ACTION: String = "action"
Link copied to clipboard
val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"
Link copied to clipboard
val TASK_DEPENDS_ON: String = "dependsOn"
Link copied to clipboard
val TASK_DESCRIPTION: String = "description"
Link copied to clipboard
val TASK_GROUP: String = "group"
Link copied to clipboard
val TASK_NAME: String = "name"
Link copied to clipboard
val TASK_OVERWRITE: String = "overwrite"
Link copied to clipboard
val TASK_TYPE: String = "type"
Link copied to clipboard

Functions

Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun compareTo(otherTask: Task): Int
Link copied to clipboard
open fun configure(closure: Closure): Task
abstract fun configure(cl: Closure): T
Link copied to clipboard
inline fun <T : Any> ExtensionAware.configure(noinline configuration: T.() -> Unit)

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

Link copied to clipboard
open fun dependsOn(paths: Array<Any>): Task
Link copied to clipboard
open fun doFirst(action: Action<in Task>): Task
Link copied to clipboard
open fun doLast(action: Action<in Task>): Task
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String)
Link copied to clipboard
open fun finalizedBy(paths: Array<Any>): Task
Link copied to clipboard
open fun getActions(): List<Action<in Task>>
Link copied to clipboard
open fun getAnt(): AntBuilder
Link copied to clipboard
open fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
open fun getConvention(): Convention
Link copied to clipboard
open fun getDependsOn(): Set<Any>
Link copied to clipboard
@OutputFile
abstract fun getDestinationFile(): RegularFileProperty
The output properties file.
Link copied to clipboard
Link copied to clipboard
open fun getDidWork(): Boolean
Link copied to clipboard
Link copied to clipboard
open fun getFinalizedBy(): TaskDependency
Link copied to clipboard
open fun getIdentityPath(): Path
Link copied to clipboard
open fun getInputs(): TaskInputsInternal
abstract fun getInputs(): TaskInputs
Link copied to clipboard
open fun getLifecycleDependencies(): TaskDependencyInternal
abstract fun getLifecycleDependencies(): TaskDependency
Link copied to clipboard
open fun getLocalState(): TaskLocalState
Link copied to clipboard
open fun getLogger(): Logger
Link copied to clipboard
open fun getLogging(): LoggingManager
Link copied to clipboard
Link copied to clipboard
open fun getName(): String
Link copied to clipboard
open fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
@Internal
open fun getOutputFile(): File
Returns the output file to write the properties to.
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal
abstract fun getOutputs(): TaskOutputs
Link copied to clipboard
open fun getPath(): String
Link copied to clipboard
open fun getProject(): Project
Link copied to clipboard
Link copied to clipboard
open fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open fun getSharedResources(): List<ResourceLock>
abstract fun getSharedResources(): List<out ResourceLock>
Link copied to clipboard
Link copied to clipboard
open fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
abstract fun getState(): TaskState
Link copied to clipboard
open fun getTaskActions(): List<InputChangesAwareTaskAction>
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal
abstract fun getTaskDependencies(): TaskDependency
Link copied to clipboard
open fun getTaskIdentity(): TaskIdentity<out Any>
Link copied to clipboard
open fun getTemporaryDir(): File
Link copied to clipboard
open fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
open fun hasProperty(propertyName: String): Boolean
Link copied to clipboard
open fun hasTaskActions(): Boolean
Link copied to clipboard
open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T
Link copied to clipboard
Link copied to clipboard
open fun isEnabled(): Boolean
Link copied to clipboard
open fun isHasCustomActions(): Boolean
Link copied to clipboard
open fun mustRunAfter(paths: Array<Any>): Task
Link copied to clipboard
Link copied to clipboard
open fun onlyIf(spec: Spec<in Task>)
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun properties(properties: Map<String, Any>)
Adds multiple properties to be written to the properties file.
Link copied to clipboard
inline fun WriteProperties.properties(vararg properties: Pair<String, Any?>)

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

Link copied to clipboard
open fun property(propertyName: String): Any

open fun property(name: String, value: Any)
Adds a property to be written to the properties file.
Link copied to clipboard
open fun setActions(replacements: List<Action<in Task>>)
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<out Any>)
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
Link copied to clipboard
open fun setOnlyIf(spec: Spec<in Task>)
Link copied to clipboard
open fun setOutputFile(outputFile: File)
open fun setOutputFile(outputFile: Any)
Sets the output file to write the properties to.
Link copied to clipboard
open fun setProperties(properties: Map<String, Any>)
Sets all properties to be written to the properties file replacing any existing properties.
Link copied to clipboard
inline fun WriteProperties.setProperties(vararg properties: Pair<String, Any?>)

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

Link copied to clipboard
open fun setProperty(name: String, value: Any)
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
Link copied to clipboard
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
Link copied to clipboard
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.

Link copied to clipboard
open fun usesService(service: Provider<out BuildService<out Any>>)
Link copied to clipboard
open fun writeProperties()