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

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) или возврата каретки, непосредственно за которым следует новая строка (\r\n) в комментариях заменяется на line separator, и если следующий символ в комментариях не является символом # или символом !, то после этого разделителя строк записывается ASCII-символ #.

Если java.properties.date установлено в командной строке и не пусто (определяется с помощью String.isEmpty), строка комментариев записывается следующим образом. Сначала записывается символ #, затем содержимое свойства, а затем разделитель строк. Любые символы завершения строки в значении системной переменной обрабатываются аналогичным образом, как указано выше для аргумента comments. Если системная переменная не задана или пуста, строка комментариев записывается следующим образом. Сначала записывается символ #, затем текущая дата и время, отформатированные так же, как и методом 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 для соответствующего шестнадцатеричного значения Unicode 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)

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