WriteProperties

目录

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

以可重现的方式写入一个 Properties 对象。

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

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

与 Properties 类似，使用默认的 Latin-1 (ISO-8859-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)）或强制转换为返回将被强制转换为 String 的值的 Callable 类型。

值不允许为 null。