Класс Properties

public class Properties
extends Hashtable<Object,Object>

Класс Properties представляет собой постоянный набор свойств. Список свойств можно сохранить в поток или загрузить из потока. Каждый ключ и соответствующее ему значение в списке свойств — строка.

Список свойств может содержать другой список свойств в качестве «значений по умолчанию»; этот второй список свойств проверяется, если ключ свойства не найден в исходном списке свойств.

Поскольку Properties наследуется от Hashtable, методы put и putAll могут быть применены к объекту Properties. Их использование крайне не рекомендуется, так как они позволяют вызывающей стороне вставлять записи, ключи или значения которых не являются Strings. Вместо этого следует использовать метод setProperty. Если метод store или save вызывается на объекте Properties, содержащем ключ или значение, не являющийся String, вызов завершится с ошибкой. Аналогично, вызов метода propertyNames или list завершится с ошибкой, если он вызывается на объекте Properties, содержащем ключ, не являющийся String.

Итераторы, возвращаемые методом iterator для «коллекций представлений» этого класса (т. е., entrySet(), keySet(), и values()) могут не быть быстрыми при отказе (в отличие от реализации Hashtable). Эти итераторы гарантированно перебирают элементы, существовавшие при создании ровно один раз, и могут (но не гарантируют) отражать любые изменения после создания.

Методы load(Reader) / store(Writer, String) загружают и сохраняют свойства из потока символов и в поток символов в простом ориентированном на строки формате, описанном ниже. Методы load(InputStream) / store(OutputStream, String) работают аналогичным образом, за исключением того, что входной/выходной поток закодирован в кодировке символов ISO 8859-1. Символы, которые нельзя напрямую представить в этой кодировке, можно записать с помощью управляющих последовательностей Unicode, как определено в разделе 3.3 спецификации языка Java™; в последовательности с escape-символом разрешено только один символ 'u'.

Методы loadFromXML(InputStream) и storeToXML(OutputStream, String, String) загружают и сохраняют свойства в простом формате XML. По умолчанию используется кодировка символов UTF-8, но, если необходимо, может быть указана определённая кодировка. Реализации должны поддерживать UTF-8 и UTF-16 и могут поддерживать другие кодировки. Документ XML-свойств имеет следующее объявление DOCTYPE:

<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">

Обратите внимание, что системный URI (http://java.sun.com/dtd/properties.dtd) не обращается при экспорте или импорте свойств; он служит просто строкой для уникальной идентификации DTD, который выглядит так:

<?xml version="1.0" encoding="UTF-8"?>

    <!-- DTD for properties -->

    <!ELEMENT properties ( comment?, entry* ) >

    <!ATTLIST properties version CDATA #FIXED "1.0">

    <!ELEMENT comment (#PCDATA) >

    <!ELEMENT entry (#PCDATA) >

    <!ATTLIST entry key CDATA #REQUIRED>

Этот класс потокобезопасен: несколько потоков могут совместно использовать один объект Properties без необходимости внешней синхронизации.

Подробное описание полей

defaults

protected volatile Properties defaults

Список свойств, содержащий значения по умолчанию для ключей, отсутствующих в этом списке свойств.

Подробное описание конструкторов

Properties

public Properties()

Создаёт пустой список свойств без значений по умолчанию.

Примечание к реализации:

Начальный размер объекта Properties, созданного с этим конструктором, не определён.

Properties

public Properties(int initialCapacity)

Создаёт пустой список свойств без значений по умолчанию, с начальным размером, достаточным для указанного количества элементов без необходимости динамического изменения размера.

Параметры:

initialCapacity - размер, на который будет изменён размер Properties.

Исключения:

IllegalArgumentException - если начальный размер меньше нуля.

Properties

public Properties(Properties defaults)

Создаёт пустой список свойств со значениями по умолчанию.

Примечание к реализации:

Начальный размер объекта Properties, созданного с этим конструктором, не определён.

Параметры:

defaults - значения по умолчанию.