Класс Properties

protected Properties defaults

public Properties()

public Properties(Properties defaults)

public Object setProperty(String key,
                          String value)

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-экранирования, используемых для символов и строк, заключаются в следующем:

• Восьмеричные escapes не распознаются.
• Последовательность символов \b не представляет символ backspace.
• Метод не обрабатывает символ обратного слэша, \, перед недопустимым символом экранирования, как ошибку; обратный слэш молча пропускается. Например, в 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)

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

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

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

Если аргумент комментариев не равен 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 для соответствующего шестнадцатеричного значения 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". Реализация может поддерживать дополнительные кодировки.

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

public String getProperty(String key)

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)