WriteProperties

目录

属性
方法
脚本块
属性详情
方法详情
API 文档WriteProperties

以可预期可重现的方式写入 Properties。

与属性的存储方式相比，存在一些差异

  • 文件开头不生成时间戳注释
  • 结果文件中的行由预设分隔符（默认为 '\n'）而不是系统默认行分隔符分隔
  • 属性按字母顺序排序

与 Properties 类似，当使用默认的 Latin-1 (ISO-8559-1) 编码时，Unicode 字符会被转义。

属性

属性描述
comment

要添加到属性文件开头的可选注释。

destinationFile

输出属性文件。

encoding

用于写入属性文件的编码。默认为 ISO_8859_1。如果设置为其他任何值，则禁用 Unicode 转义。

lineSeparator

创建属性文件时要使用的行分隔符。默认为 `\n`。

outputFile
已弃用

要将属性写入的输出文件。

properties

返回要写入属性文件的属性的不可变视图。

方法

方法描述
properties(properties)

添加要写入属性文件的多个属性。

property(name, value)

添加要写入属性文件的属性。

脚本块

无脚本块

属性详情

String comment

要添加到属性文件开头的可选注释。

默认
null

RegularFileProperty destinationFile

输出属性文件。

默认
null

String encoding

用于写入属性文件的编码。默认为 ISO_8859_1。如果设置为其他任何值，则禁用 Unicode 转义。

默认
ISO-8859-1

String lineSeparator

创建属性文件时要使用的行分隔符。默认为 `\n`。

默认
'\n'

File outputFile

注意：此属性已弃用，将在 Gradle 的下一个主要版本中移除。

要将属性写入的输出文件。

默认
null

Map<String, String> properties

返回要写入属性文件的属性的不可变视图。

默认
[:]

方法详情

void properties(Map<String, Object> properties)

添加要写入属性文件的多个属性。

这是调用 WriteProperties.property(java.lang.String, java.lang.Object) 多次的便捷方法。

void property(String name, Object value)

添加要写入属性文件的属性。

属性值将被强制转换为 String，使用 String#valueOf(Object) 或 Callable 返回要强制转换为 String 的值。

不允许值为空。