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>
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:
- 
Nested Class SummaryNested classes/interfaces inherited from interface org.gradle.api.TaskTask.Namer
- 
Field SummaryFields inherited from interface org.gradle.api.TaskTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionReturns the optional comment to add at the beginning of the properties file.abstract RegularFilePropertyThe output properties file.Returns the encoding used to write the properties file.Returns the line separator to be used when creating the properties file.Deprecated.Returns an immutable view of properties to be written to the properties file.voidproperties(Map<String, Object> properties) Adds multiple properties to be written to the properties file.voidAdds a property to be written to the properties file.voidsetComment(String comment) Sets the optional comment to add at the beginning of the properties file.voidsetEncoding(String encoding) Sets the encoding used to write the properties file.voidsetLineSeparator(String lineSeparator) Sets the line separator to be used when creating the properties file.voidsetOutputFile(File outputFile) Deprecated.voidsetOutputFile(Object outputFile) Deprecated.UsegetDestinationFile()instead.voidsetProperties(Map<String, Object> properties) Sets all properties to be written to the properties file replacing any existing properties.voidMethods inherited from class org.gradle.api.DefaultTaskcompareTo, 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, usesServiceMethods inherited from class org.gradle.api.internal.AbstractTaskacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsMethods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.gradle.api.TaskdoNotTrackState, getConvention, notCompatibleWithConfigurationCache
- 
Constructor Details- 
WritePropertiespublic WriteProperties()
 
- 
- 
Method Details- 
getPropertiesReturns an immutable view of properties to be written to the properties file.- Since:
- 3.3
 
- 
setPropertiesSets all properties to be written to the properties file replacing any existing properties.- See Also:
 
- 
propertyAdds a property to be written to the properties file.A property's value will be coerced to a StringwithString#valueOf(Object)or aCallablereturning a value to be coerced into aString.Values are not allowed to be null. - Parameters:
- name- Name of the property
- value- Value of the property
- Since:
- 3.4
 
- 
propertiesAdds 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:
 
- 
getLineSeparatorReturns the line separator to be used when creating the properties file. Defaults to `\n`.
- 
setLineSeparatorSets the line separator to be used when creating the properties file.
- 
getCommentReturns the optional comment to add at the beginning of the properties file.
- 
setCommentSets the optional comment to add at the beginning of the properties file.
- 
getEncodingReturns the encoding used to write the properties file. Defaults to ISO_8859_1. If set to anything different, unicode escaping is turned off.
- 
setEncodingSets the encoding used to write the properties file. Defaults to ISO_8859_1. If set to anything different, unicode escaping is turned off.
- 
getOutputFileDeprecated.Returns the output file to write the properties to.
- 
setOutputFileDeprecated.UsegetDestinationFile()instead.Sets the output file to write the properties to.- Since:
- 4.0
 
- 
setOutputFileDeprecated.UsegetDestinationFile()instead.Sets the output file to write the properties to.
- 
getDestinationFileThe output properties file.- Since:
- 8.1
 
- 
writeProperties- Throws:
- IOException
 
 
- 
getDestinationFile()instead.