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

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). Различия от последовательностей экранирования символов и Unicode-экранирования для символов и строк следующие:

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

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

public void load(InputStream inStream) throws IOException

Читает список свойств (пары ключ-элемент) из входного потока байтов. Входной поток находится в простом ориентированном на строки формате, как указано в load(Reader) , и предполагается, что он использует кодировку символов ISO 8859-1; то есть каждый байт — один символ Latin1. Символы, отсутствующие в Latin1, и определённые специальные символы представлены в ключах и элементах с использованием Unicode-экранирования, как определено в разделе 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') или возврата каретки, за которым непосредственно следует перевод строки в комментариях, заменяется разделителем строк, генерируемым методом Writer, а если следующий символ в комментариях не символ # или символ !, то после этого разделителя записывается символ ASCII #.

Далее всегда записывается строка комментария, содержащая символ ASCII #, текущую дату и время (как если бы они были получены методом toString метода Date для текущего времени) и разделитель строк, сгенерированный методом Writer.

Затем каждая запись в этой 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)

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