WriteProperties

目录

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

以可重现的方式写入 Properties 文件。

与属性存储方式相比，有以下几点不同：

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

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

属性

属性描述
注释

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

目标文件

输出的属性文件。

编码

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

行分隔符

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

属性

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

方法

方法描述
properties(properties)

添加多个属性以写入属性文件。

property(name, value)

添加一个属性以写入属性文件。

脚本块

无脚本块

属性详情

String comment

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

默认值
空

RegularFileProperty destinationFile

输出的属性文件。

默认值
空

String encoding

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

默认值
ISO-8859-1

String lineSeparator

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

默认值
'\n'

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#valueOf(Object) 强制转换为 String，或者强制转换为返回将被强制转换为 String 的值的 Callable。

值不允许为空。