Package org.gradle.api.tasks

Class WriteProperties

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.tasks.WriteProperties

All Implemented Interfaces:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, Named, ExtensionAware, Task, Configurable<Task>

@CacheableTask
public abstract class WriteProperties
extends DefaultTask

Writes a 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 Properties, Unicode characters are escaped when using the default Latin-1 (ISO-8559-1) encoding.

Since:

3.3

See Also:

• Properties.store(OutputStream, String)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	WriteProperties.PropertiesAdapter

Nested classes/interfaces inherited from interface org.gradle.api.Named

Named.Namer

Field Summary

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor	Description
WriteProperties()

Method Summary

Modifier and Type	Method	Description
abstract Property<String>	getComment()	The optional comment to add at the beginning of the properties file.
abstract RegularFileProperty	getDestinationFile()	The output properties file.
abstract Property<String>	getEncoding()	The encoding used to write the properties file.
abstract Property<String>	getLineSeparator()	The line separator to be used when creating the properties file.
abstract MapProperty<String,Object>	getProperties()	Returns an immutable view of properties to be written to the properties file.
abstract ProviderFactory	getProviderFactory()
void	properties(Map<String,Object> properties)	Deprecated.
void	property(String name, Object value)	Adds a property to be written to the properties file.
void	writeProperties()

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, notCompatibleWithConfigurationCache

Constructor Details

WriteProperties

public WriteProperties()

Method Details

getProperties

@Input
public abstract MapProperty<String,Object> getProperties()

Returns an immutable view of properties to be written to the properties file.

property

public void property(String name,
 Object value)

Adds a property to be written to the properties file.

A property's value will be coerced to a String with String#valueOf(Object) or a Callable returning a value to be coerced into a String.

Values are not allowed to be null.

Parameters:

name - Name of the property

value - Value of the property or provider for value

Since:

3.4

properties

@Deprecated
public void properties(Map<String,Object> properties)

Deprecated.

Adds multiple properties to be written to the properties file.

This is a convenience method for calling property(String, Object) multiple times.

Parameters:

properties - Properties to be added

Since:

3.4

See Also:

• property(String, Object)

getLineSeparator

@Input
public abstract Property<String> getLineSeparator()

The line separator to be used when creating the properties file. Defaults to `\n`.

getComment

@Input
@Optional
public abstract Property<String> getComment()

The optional comment to add at the beginning of the properties file.

getEncoding

@Input
public abstract Property<String> getEncoding()

The encoding used to write the properties file. Defaults to ISO_8859_1. If set to anything different, unicode escaping is turned off.

getDestinationFile

@OutputFile
public abstract RegularFileProperty getDestinationFile()

The output properties file.

Since:

8.1

writeProperties

public void writeProperties()
                     throws IOException

Throws:

IOException

getProviderFactory

@Inject
public abstract ProviderFactory getProviderFactory()