java.beans

Класс XMLEncoder

java.lang. Объект

java.beans. Кодер

java.beans. XMLEncoder

Все Реализованные Интерфейсы:

AutoCloseable

public class XMLEncoder
extends Encoder
implements AutoCloseable

XMLEncoder class является дополнительной альтернативой ObjectOutputStream и может используемый, чтобы генерировать текстовое представление JavaBean таким же образом что ObjectOutputStream может использоваться, чтобы создать двоичное представление Serializable объекты. Например, следующий фрагмент может использоваться, чтобы создать текстовое представление предоставленный JavaBean и все его свойства:

       XMLEncoder e = new XMLEncoder(
                          new BufferedOutputStream(
                              new FileOutputStream("Test.xml")));
       e.writeObject(new JButton("Hello, world"));
       e.close();
 

Несмотря на подобие их API, XMLEncoder class исключительно разрабатывается с целью архивирования графиков JavaBeans как текстовые представления их общедоступных свойств. Как исходные файлы Java, документы, записанные этот путь, имеют врожденный иммунитет к изменениям в реализациях включенных классов. ObjectOutputStream продолжает рекомендоваться для межпроцессного взаимодействия и сериализации общего назначения.

XMLEncoder class предоставляет обозначение значения по умолчанию JavaBeans, в котором они представляются как XML-документы, выполняющие версию 1.0 спецификации XML и кодировку символов UTF-8 Unicode/ISO 10646 наборов символов. XML-документы, произведенные XMLEncoder class:

• Переносимый и эластичная версия: у них нет никаких зависимостей от частной реализации любого class и так, как исходные файлы Java, ими можно обменяться между средами, у которых могут быть различные версии некоторых из классов и между VMs от различных поставщиков.
• Структурно компактный: XMLEncoder class использует алгоритм устранения избыточности внутренне так, чтобы значения по умолчанию свойств Боба не были записаны потоку.
• Отказоустойчивый: неструктурные ошибки в файле, вызванном или повреждением файла или изменениями API, произведенными в классах в архиве, остаются локализованными так, чтобы читатель мог сообщить об ошибке и продолжать загружать части документа, на которые не влияла ошибка.

Ниже пример архива XML, содержащего некоторые компоненты пользовательского интерфейса от инструментария колебания:

 <?xml version="1.0" encoding="UTF-8"?>
 <java version="1.0" class="java.beans.XMLDecoder">
 <object class="javax.swing.JFrame">
   <void property="name">
     <string>frame1</string>
   </void>
   <void property="bounds">
     <object class="java.awt.Rectangle">
       <int>0</int>
       <int>0</int>
       <int>200</int>
       <int>200</int>
     </object>
   </void>
   <void property="contentPane">
     <void method="add">
       <object class="javax.swing.JButton">
         <void property="label">
           <string>Hello</string>
         </void>
       </object>
     </void>
   </void>
   <void property="visible">
     <boolean>true</boolean>
   </void>
 </object>
 </java>
 

Синтаксис XML использует следующие соглашения:

• Каждый элемент представляет вызов метода.
• "Объектный" тег обозначает выражение, значение которого должно использоваться в качестве параметра элементу включения.
• "Пустой" тег обозначает оператор, который будет выполняться, но чей результат не будет использоваться в качестве параметра методу включения.
• Элементы, которые содержат элементы, используют те элементы в качестве параметров, если у них нет тега: "пусто".
• Имя метода обозначается атрибутом "метода".
• Стандартные атрибуты "идентификатора" и "idref" XML используются, чтобы сделать ссылки на предыдущие выражения - чтобы иметь дело с зацикливаниями в графе объектов.
• Атрибут "class" используется, чтобы определить цель статического метода или конструктора явно; его значение, являющееся полностью определенным именем class.
• Элементы с "пустым" тегом выполняются, используя внешний контекст в качестве цели, если никакая цель не определяется атрибутом "class".
• Строка Java class обрабатывается особенно и пишется <представляют в виде строки> Привет, мир </строка>, где символы строки преобразовываются в байты, используя кодировку символов UTF-8.

Хотя все графы объектов могут быть записаны, используя только эти три тега, следующие определения включаются так, чтобы структуры общих данных могли быть выражены более кратко:

• Имя метода значения по умолчанию "ново".
• Ссылка на java class пишется в форме <class> javax.swing. JButton </class>.
• Экземпляры классов обертки для типов примитивов Java пишутся, используя имя типа примитива как тег. Например, экземпляр Integer class мог быть записан: <интервал> 123 </интервал>. Отметьте что XMLEncoder class использует отражательный пакет Java, в котором преобразование между типами примитивов Java и их связанными "классами обертки" обрабатывается внутренне. API для XMLEncoder САМ class имеет дело только с Objects.
• В элементе, представляющем nullary метод, имя которого запускается с, "добираются", атрибут "метода" заменяется атрибутом "свойства", значение которого дается, удаляя "получить" префикс и decapitalizing результат.
• В элементе, представляющем одноместный метод, имя которого запускается с "набора", атрибут "метода" заменяется атрибутом "свойства", значение которого дается, удаляя префикс "набора" и decapitalizing результат.
• В элементе, представляющем названный метод, "получают" взятие одного целочисленного параметра, атрибут "метода" заменяется "индексировать" атрибутом чье значение значение первого параметра.
• В элементе, представляющем метод, названный "набором", берущим два параметра, первым из которых является целое число, атрибут "метода" заменяется "индексировать" атрибутом чье значение значение первого параметра.
• Ссылка на массив пишется, используя тег "массива". Атрибуты "class" и "длины" определяют подтип массива и его длины соответственно.

Для получения дополнительной информации Вы могли бы также хотеть проверить Используя XMLEncoder, статью в Соединении Swing.

С тех пор:

1.4

См. Также:

XMLDecoder, ObjectOutputStream

Сводка конструктора

Конструкторы

Конструктор и Описание
XMLEncoder(OutputStream out) Создает новый кодер XML, чтобы выписать JavaBeans к потоку out использование кодирования XML.
XMLEncoder(OutputStream out, String charset, boolean declaration, int indentation) Создает новый кодер XML, чтобы выписать JavaBeans к потоку out использование данного charset запуск с данного indentation.

Сводка метода

Модификатор и Тип	Метод и Описание
void	close() Это вызовы метода flush, пишет заключительная постиноходь и затем закрывает поток вывода, связанный с этим потоком.
void	flush() Этот метод выписывает преамбулу, связанную с кодированием XML, если это уже не было записано и затем выписывает все значения который записанный потоку с прошлого раза flush был вызван.
Объект	getOwner() Получает владельца этого кодера.
void	setOwner(Object owner) Устанавливает владельца этого кодера к owner.
void	writeExpression(Expression oldExp) Записывает Выражение так, чтобы Кодер произвел фактический вывод, когда поток будет сброшен.
void	writeObject(Object o) Запишите представление XML указанного объекта к выводу.
void	writeStatement(Statement oldStm) Записывает Оператор так, чтобы Кодер произвел фактический вывод, когда поток будет сброшен.

Методы, наследованные от class java.beans. Кодер

get, getExceptionListener, getPersistenceDelegate, remove, setExceptionListener, setPersistenceDelegate

Методы, наследованные от class java.lang. Объект

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Деталь конструктора

XMLEncoder

public XMLEncoder(OutputStream out)

Создает новый кодер XML, чтобы выписать JavaBeans к потоку out использование кодирования XML.

Параметры:

out - поток, которому будет записано представление XML объектов

Броски:

IllegalArgumentException - если out null

См. Также:

XMLDecoder.XMLDecoder(InputStream)

XMLEncoder

public XMLEncoder(OutputStream out,
                  String charset,
                  boolean declaration,
                  int indentation)

Создает новый кодер XML, чтобы выписать JavaBeans к потоку out использование данного charset запуск с данного indentation.

Параметры:

out - поток, которому будет записано представление XML объектов

charset - имя требуемого набора символов; может быть или каноническое имя или псевдоним

declaration - должно ли объявление XML быть сгенерировано; установите это в false встраивая содержание в другой XML-документ

indentation - число пробелов, чтобы расположить весь XML-документ с отступом

Броски:

IllegalArgumentException - если out или charset null, или если indentation меньше чем 0

IllegalCharsetNameException - если charset имя недопустимо

UnsupportedCharsetException - если никакая поддержка именованного набора символов не доступна в этом экземпляре виртуальной машины Java

UnsupportedOperationException - если загруженный набор символов не поддерживает кодирование

С тех пор:

1.7

См. Также:

Charset.forName(String)

Деталь метода

setOwner

public void setOwner(Object owner)

Устанавливает владельца этого кодера к owner.

Параметры:

owner - Владелец этого кодера.

См. Также:

getOwner()

getOwner

public Object getOwner()

Получает владельца этого кодера.

Возвраты:

Владелец этого кодера.

См. Также:

setOwner(java.lang.Object)

writeObject

public void writeObject(Object o)

Запишите представление XML указанного объекта к выводу.

Переопределения:

writeObject в class Encoder

Параметры:

o - Объект, который будет записан потоку.

См. Также:

XMLDecoder.readObject()

writeStatement

public void writeStatement(Statement oldStm)

Записывает Оператор так, чтобы Кодер произвел фактический вывод, когда поток будет сброшен.

Этот метод должен только быть вызван в пределах контекста инициализации делегата персистентности.

Переопределения:

writeStatement в class Encoder

Параметры:

oldStm - Оператор, который будет записан потоку.

См. Также:

PersistenceDelegate.initialize(java.lang.Class<?>, java.lang.Object, java.lang.Object, java.beans.Encoder)

writeExpression

public void writeExpression(Expression oldExp)

Записывает Выражение так, чтобы Кодер произвел фактический вывод, когда поток будет сброшен.

Этот метод должен только быть вызван в пределах контекста инициализации делегата персистентности или установки кодер, чтобы читать из пакета ресурса.

Для получения дополнительной информации об использовании пакетов ресурса с XMLEncoder см. http://java.sun.com/products/jfc/tsc/articles/persistence4/#i18n

Переопределения:

writeExpression в class Encoder

Параметры:

oldExp - Выражение, которое будет записано потоку.

См. Также:

PersistenceDelegate.initialize(java.lang.Class<?>, java.lang.Object, java.lang.Object, java.beans.Encoder)

сброс

public void flush()

Этот метод выписывает преамбулу, связанную с кодированием XML, если это уже не было записано и затем выписывает все значения который записанный потоку с прошлого раза flush был вызван. После сбрасывания очищаются все внутренние ссылки на значения, которые были записаны этому потоку.

близко

public void close()

Это вызовы метода flush, пишет заключительная постиноходь и затем закрывает поток вывода, связанный с этим потоком.

Определенный:

close в интерфейсе AutoCloseable