Свойства класса

protected volatile Properties defaults

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

public Properties()

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

public Properties(int initialCapacity)

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

public Properties(Properties defaults)

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

public Object setProperty(String key, String value)

Вызывает метод Hashtable put. Предоставлено для параллелизма с методом getProperty. Требует использования строк для ключей и значений свойств. Возвращаемое значение — результат вызова Hashtable к put.

public void load(Reader reader) throws IOException

Считывает список свойств (пары ключ-элемент) из входного потока символов в простом построчном формате.

Свойства обрабатываются по строкам. Существует два вида строк: естественные строки и логические строки. Естественная строка определяется как строка символов, которая заканчивается либо набором символов окончания строки (\n или \r или \r\n), либо в конце потока. Естественная строка может быть пустой строкой, строкой комментария или содержать полностью или частично пару ключ-элемент. Логическая строка содержит все данные пары ключ-элемент, которые могут быть распределены по нескольким смежным естественным строкам, избегая последовательности символов окончания строки с помощью символа обратного слэша \. Обратите внимание, что строка комментария не может быть расширена таким образом; каждая естественная строка, являющаяся комментарием, должна иметь собственный индикатор комментария, как описано ниже. Строки считываются из входного потока до достижения конца потока.

Естественная строка, содержащая только пробельные символы, считается пустой и игнорируется. Строка комментария имеет ASCII '#' или '!' в качестве первого символа, не являющегося пробелом; строки комментариев также игнорируются и не кодируют информацию о паре ключ-элемент. Помимо символов окончания строки, этот формат рассматривает символы пробела (' ', '\u0020'), табуляции ('\t', '\u0009') и перевода страницы ('\f', '\u000C') как пробелы.

Если логическая строка распределена по нескольким естественным строкам, обратный слэш, избегающий последовательность символов окончания строки, последовательность символов окончания строки и любые пробелы в начале следующей строки не влияют на значения ключа или элемента. Остальная часть обсуждения анализа ключа и элемента (при загрузке) будет предполагать, что все символы, составляющие ключ и элемент, появляются в одной естественной строке после удаления символов продолжения строки. Обратите внимание, что недостаточно только проверить символ, предшествующий последовательности символов окончания строки, чтобы определить, является ли последовательность символов окончания строки экранированной; должно быть нечётное число последовательных обратных слэшей для экранирования последовательности символов окончания строки. Поскольку входной поток обрабатывается слева направо, нечётное количество 2n последовательных обратных слэшей перед символом окончания строки (или в другом месте) кодирует n обратных слэшей после обработки экранирования.

Ключ содержит все символы в строке, начиная с первого символа, не являющегося пробелом, и до, но не включая, первый неэкранированный '=', ':' или пробельный символ, отличный от символа окончания строки. Все эти символы завершения ключа могут быть включены в ключ путём экранирования их предшествующим символом обратного слэша; например,

\:\=

будет ключом из двух символов ":=". Символы окончания строки могут быть включены с помощью \r и \n последовательностей экранирования. Любые пробелы после ключа пропускаются; если первый символ, не являющийся пробелом, после ключа — '=' или ':', то он игнорируется, и любые пробельные символы после него также пропускаются. Все оставшиеся символы в строке становятся частью связанной строки элемента; если оставшихся символов нет, элемент — пустая строка "". После определения исходных последовательностей символов, составляющих ключ и элемент, выполняется обработка экранирования, как описано выше.

В качестве примера, каждая из следующих трёх строк задаёт ключ "Truth" и связанное значение элемента "Beauty":

 Truth = Beauty
  Truth:Beauty
 Truth                    :Beauty
 

В качестве другого примера, следующие три строки задают одно свойство:

 fruits                           apple, banana, pear, \
                                  cantaloupe, watermelon, \
                                  kiwi, mango
 

Ключ — "fruits", а связанный элемент:

"apple, banana, pear, cantaloupe, watermelon, kiwi, mango"

Обратите внимание, что пробел появляется перед каждым \, чтобы пробел появлялся после каждой запятой в конечном результате; \, символ окончания строки и ведущие пробелы в строке продолжения просто отбрасываются и не заменяются одним или несколькими другими символами.

В качестве третьего примера, строка:

cheeses
 

задаёт ключ "cheeses" и связанное значение элемента — пустую строку "".

Символы в ключах и элементах могут быть представлены в последовательностях экранирования, аналогичных тем, которые используются для символов и строковых литералов (см. разделы 3.3 и 3.10.6 спецификации языка Java). Различия от последовательностей экранирования символов и Юникод-экранирования, используемых для символов и строк, следующие:

• Восьмеричные экранирования не распознаются.
• Последовательность символов \b не представляет собой символ возврата.
• Метод не рассматривает символ обратного слэша, \, перед недействительным символом экранирования как ошибку; обратный слэш молча отбрасывается. Например, в строке Java последовательность "\z" вызовет ошибку компиляции. В отличие от этого, этот метод молча отбрасывает обратный слэш. Следовательно, этот метод обрабатывает двухсимвольную последовательность "\b" как эквивалентную одиночному символу 'b'.
• Экранирования не нужны для одиночных и двойных кавычек; однако, по приведенному выше правилу, одиночные и двойные кавычки, предшествующие обратному слэшу, по-прежнему генерируют одиночные и двойные кавычки соответственно.
• В последовательности Юникод-экранирования допускается только один символ 'u'.

Указанный поток остаётся открытым после возвращения этого метода.

public void load(InputStream inStream) throws IOException

Считывает список свойств (пары ключ-элемент) из входного байтового потока. Входной поток имеет простой построчный формат, как указано в load(Reader), и предполагается, что он использует кодировку символов ISO 8859-1; то есть каждый байт представляет один символ Latin1. Символы, не относящиеся к Latin1, и определённые специальные символы, представлены в ключах и элементах с помощью Юникод-экранирования, как определено в разделе 3.3 спецификации языка Java.

Указанный поток остаётся открытым после возвращения этого метода.

@Deprecated public void save(OutputStream out, String comments)

Вызывает метод store(OutputStream out, String comments) и подавляет исключения IOException, которые были выброшены.

public void store(Writer writer, String comments) throws IOException

Записывает этот список свойств (пары ключ-элемент) в этой таблице Properties в выходной поток символов в формате, подходящем для использования метода load(Reader).

Свойства из таблицы по умолчанию этой таблицы Properties (если таковые имеются) не записываются этим методом.

Если аргумент comments не равен null, то в выходной поток сначала записывается ASCII-символ #, строка комментариев и разделитель строк. Таким образом, comments может служить идентифицирующим комментарием. Любой из символов перевода строки (\n), возврата каретки (\r) или возврата каретки, за которым сразу следует перевод строки (\r\n) в комментариях заменяется на line separator, и если следующий символ в комментариях не является символом # или символом !, то после этого разделителя строк записывается ASCII-символ #.

Если свойство java.properties.date задано в командной строке и не пустое (определяется по String.isEmpty), строка комментария записывается следующим образом. Сначала записывается символ #, затем содержимое свойства, затем разделитель строк. Любые символы завершения строки в значении системного свойства обрабатываются так же, как указано выше для аргумента комментариев. Если системное свойство не задано или пустое, строка комментария записывается следующим образом. Сначала записывается символ #, затем текущая дата и время, отформатированные так же, как методом Date.toString, затем разделитель строк.

Затем каждый элемент в этой таблице Properties записывается по одной строке. Для каждого элемента записывается строка ключа, затем ASCII-символ =, затем соответствующая строка элемента. Для ключа все пробельные символы записываются с предшествующим символом \. Для элемента ведущие пробельные символы, но не вложенные или заключительные пробельные символы, записываются с предшествующим символом \. Символы ключа и элемента #, !, = и : записываются с предшествующим обратным слэшем, чтобы гарантировать их правильную загрузку.

После записи элементов выходной поток сбрасывается. Выходной поток остается открытым после возврата из этого метода.

public void store(OutputStream out, String comments) throws IOException

Записывает этот список свойств (пары ключ-элемент) в этой таблице Properties в выходной поток в формате, подходящем для загрузки в таблицу Properties с использованием метода load(InputStream).

Свойства из таблицы по умолчанию этой таблицы Properties (если таковые имеются) не записываются этим методом.

Этот метод выводит комментарии, ключи и значения свойств в том же формате, что и в store(Writer), с последующими различиями:

• Поток записывается с использованием кодировки символов ISO 8859-1.
• Символы, отсутствующие в Latin-1 в комментариях, записываются как \uxxxx для соответствующего шестнадцатеричного значения xxxx.
• Символы меньше \u0020 и символы больше \u007E в ключах или значениях свойств записываются как \uxxxx для соответствующего шестнадцатеричного значения xxxx.

После записи элементов выходной поток сбрасывается. Выходной поток остается открытым после возврата из этого метода.

public void loadFromXML(InputStream in) throws IOException, InvalidPropertiesFormatException

Загружает все свойства, представленные XML-документом в указанном потоке ввода, в эту таблицу свойств.

XML-документ должен иметь следующее объявление DOCTYPE:

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

Кроме того, документ должен соответствовать описанному выше DTD свойств.

Реализация должна читать XML-документы, использующие кодировку "UTF-8" или "UTF-16". Реализация может поддерживать дополнительные кодировки.

Указанный поток закрывается после возврата из этого метода.

public void storeToXML(OutputStream os, String comment) throws IOException

Выводит XML-документ, представляющий все свойства, содержащиеся в этой таблице.

Вызов этого метода в форме props.storeToXML(os, comment) ведет себя точно так же, как вызов props.storeToXML(os, comment, "UTF-8");.

public void storeToXML(OutputStream os, String comment, String encoding) throws IOException

Выводит XML-документ, представляющий все свойства, содержащиеся в этой таблице, используя указанное кодирование.

XML-документ будет иметь следующее объявление DOCTYPE:

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

Если указанный комментарий равен null, то комментарий не будет сохранен в документе.

Реализация должна поддерживать запись XML-документов, использующих кодировку "UTF-8" или "UTF-16". Реализация может поддерживать дополнительные кодировки.

Указанный поток остается открытым после возвращения этого метода.

Этот метод ведет себя так же, как storeToXML(OutputStream os, String comment, Charset charset), за исключением того, что он будет искать кодировку по заданному имени кодировки.

public void storeToXML(OutputStream os, String comment, Charset charset) throws IOException

Выводит XML-документ, представляющий все свойства, содержащиеся в этой таблице, используя указанное кодирование.

XML-документ будет иметь следующее объявление DOCTYPE:

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

Если указанный комментарий равен null, то комментарий не будет сохранен в документе.

Реализация должна поддерживать запись XML-документов, использующих кодировку "UTF-8" или "UTF-16". Реализация может поддерживать дополнительные кодировки.

Непреобразуемые символы для указанной кодировки будут закодированы как числовые ссылки на символы.

Указанный поток остается открытым после возвращения этого метода.

public String getProperty(String key)

Ищет свойство с указанным ключом в этом списке свойств. Если ключ не найден в этом списке свойств, затем проверяется список свойств по умолчанию и его значения рекурсивно. Метод возвращает null, если свойство не найдено.

public String getProperty(String key, String defaultValue)

Ищет свойство с указанным ключом в этом списке свойств. Если ключ не найден в этом списке свойств, затем проверяется список свойств по умолчанию и его значения рекурсивно. Метод возвращает значение по умолчанию, если свойство не найдено.

public Enumeration<?> propertyNames()

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

public Set<String> stringPropertyNames()

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

Возвращаемый набор не поддерживает этот объект Properties. Изменения в этом объекте Properties не отражаются в возвращаемом наборе.

public void list(PrintStream out)

Выводит этот список свойств в указанный поток вывода. Этот метод полезен для отладки.

public void list(PrintWriter out)

Выводит этот список свойств в указанный поток вывода. Этот метод полезен для отладки.