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#valueOf(Object) 強制轉換為 String,或是使用 Callable 傳回要強制轉換為 String 的值。

值不能為 null。