Класс Binder<XmlNode>

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

Экземпляр этого класса сохраняет связь между узлами XML информационной модели и представлением XML-документа в JAXB. Переход между двумя представлениями обеспечивается методами getXMLNode(Object) и getJAXBNode(Object).

Изменения могут быть внесены в представление информационной модели или представление документа в JAXB, при этом другое представление остаётся неизменным. Binder может синхронизировать внесенные изменения в изменённом представлении обратно в другое представление с помощью соответствующих методов обновления Binder, updateXML(Object, Object) или updateJAXB(Object).

Типичный сценарий использования следующий:

• загрузка XML-документа в представление XML-информационной модели
• unmarshal(Object) представление XML-информационной модели в представление JAXB. (Для экономии ресурсов можно выполнить разбор только поддерева представления XML-информационной модели в представление JAXB.)
• доступ/обновление приложения к представлению XML-документа в JAXB.
• updateXML(Object) синхронизирует изменения в представлении JAXB обратно в представление XML-информационной модели. Операция обновления сохраняет как можно больше из исходной XML-информационной модели (т.е. комментарии, PI и т. д.).

Экземпляр Binder создаётся с помощью фабричного метода JAXBContext.createBinder() или JAXBContext.createBinder(Class).

Параметр шаблона XmlNode, является корневым интерфейсом/классом для сохраняющего представление XML-информационной модели. Реализация Binder должна минимально поддерживать значение XmlNode равно org.w3c.dom.Node.class. Реализация Binder может поддерживать альтернативные сохраняющие представления XML-информационной модели.

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

Binder

public Binder()

Методы

unmarshal

Параметры:

xmlNode - документ/элемент для разбора XML-данных.

Возвращает:

новый корневой объект дерева объектов JAXB.

Исключения:

JAXBException - Если при разборе произошли непредвиденные ошибки.

UnmarshalException - Если ValidationEventHandler возвращает false из своего метода handleEvent или Binder не может выполнить привязку XML к Java.

IllegalArgumentException - Если параметр node равен null.

unmarshal

Параметры:

xmlNode - документ/элемент для разбора XML-данных.

declaredType - соответствующий класс, сопоставленный с JAXB, для хранения XML-данных node.

Возвращает:

JAXB Element представление node

Исключения:

JAXBException - Если при разборе произошли непредвиденные ошибки.

UnmarshalException - Если ValidationEventHandler возвращает false из метода handleEvent или Binder не может выполнить привязку XML к Java.

IllegalArgumentException - Если любой из входных параметров равен null.

С:

JAXB2.0

marshal

public abstract void marshal(Object jaxbObject,
                             XmlNode xmlNode)
                      throws JAXBException

Параметры:

jaxbObject - дерево содержимого для преобразования.

xmlNode - параметр должен быть узлом, принимающим дочерние узлы.

Исключения:

JAXBException - Если при преобразовании возникла непредвиденная проблема.

MarshalException - Если ValidationEventHandler возвращает false из метода handleEvent или Binder не может выполнить преобразование jaxbObject (или любого объекта, доступного из jaxbObject).

IllegalArgumentException - Если какой-либо из параметров метода равен null.

getXMLNode

public abstract XmlNode getXMLNode(Object jaxbObject)

Параметры:

jaxbObject - экземпляр, доступный по результатам вызова метода привязки или обновления, который возвратил дерево объектов JAXB.

Возвращает:

null, если указанный объект JAXB неизвестен этому Binder, или если он не связан с XML-элементом.

Исключения:

IllegalArgumentException - Если параметр jaxbObject равен null.

getJAXBNode

public abstract Object getJAXBNode(XmlNode xmlNode)

Возвращает:

null, если указанный XML-узел неизвестен этому Binder, или если он не связан с объектом JAXB.

Исключения:

IllegalArgumentException - Если параметр node равен null.

updateXML

public abstract XmlNode updateXML(Object jaxbObject)
                           throws JAXBException

updateXML( jaxbObject, getXMLNode(jaxbObject));

Исключения:

JAXBException - Если при обновлении соответствующего XML-содержимого возникла непредвиденная проблема.

IllegalArgumentException - Если параметр jaxbObject равен null.

updateXML

public abstract XmlNode updateXML(Object jaxbObject,
                                  XmlNode xmlNode)
                           throws JAXBException

Параметры:

jaxbObject - корень потенциально изменённого дерева объектов JAXB

xmlNode - корень целевого XML-дерева обновления

Возвращает:

обновлённый XML-узел. Как правило, это тот же узел, что вы передали как xmlNode, но это может быть другой объект, например, когда имя тега объекта изменилось.

Исключения:

JAXBException - Если при обновлении соответствующего XML-содержимого возникла непредвиденная проблема.

IllegalArgumentException - Если любой из входных параметров равен null.

updateJAXB

public abstract Object updateJAXB(XmlNode xmlNode)
                           throws JAXBException

Возвращает:

обновлённый объект JAXB. Как правило, это тот же объект, что и был возвращён предыдущим вызовом метода marshal(Object,Object) или updateJAXB(Object), но это может быть другой объект, например, когда имя XML-элемента изменилось.

Исключения:

JAXBException - Если при обновлении соответствующего содержимого, сопоставленного с JAXB, возникла непредвиденная проблема.

IllegalArgumentException - Если параметр node равен null.

setSchema

public abstract void setSchema(Schema schema)

Указывает, выполняют ли методы преобразования, разбора и обновления проверку XML-содержимого.

Параметры:

schema - установить в null для отключения проверки.

См. также:

Unmarshaller.setSchema(Schema)

getSchema

public abstract Schema getSchema()

Возвращает последний объект Schema (включая null), установленный методом setSchema(Schema).

Возвращает:

объект Schema для проверки или null, если его нет

setEventHandler

public abstract void setEventHandler(ValidationEventHandler handler)
                              throws JAXBException

Параметры:

handler - обработчик событий валидации.

Исключения:

JAXBException - если при установке обработчика событий возникла ошибка.

getEventHandler

public abstract ValidationEventHandler getEventHandler()
                                                throws JAXBException

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

Возвращает:

текущий ValidationEventHandler или обработчик событий по умолчанию, если он не был установлен.

Исключения:

JAXBException - если при получении текущего обработчика событий возникла ошибка.

setProperty

public abstract void setProperty(String name,
                                 Object value)
                          throws PropertyException

Установите конкретное свойство в базовой реализации Binder. Этот метод может использоваться только для установки одного из стандартных свойств разбора/сериализации, определённых JAXB, или свойства, специфичного для поставщика, для связки, разбора или сериализации. Попытка установить неопределённое свойство приведёт к выбрасыванию исключения PropertyException. См. Поддерживаемые свойства разбора и Поддерживаемые свойства сериализации.

Параметры:

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

value — значение свойства, которое необходимо установить

Исключения:

PropertyException — при возникновении ошибки при обработке заданного свойства или значения

IllegalArgumentException — если параметр name имеет значение null

getProperty

public abstract Object getProperty(String name)
                            throws PropertyException

Получить конкретное свойство в базовой реализации Binder. Этот метод может использоваться только для получения одного из стандартных свойств разбора/сериализации, определённых JAXB, или свойства, специфичного для поставщика, для связки, разбора или сериализации. Попытка получить неопределённое свойство приведёт к выбрасыванию исключения PropertyException. См. Поддерживаемые свойства разбора и Поддерживаемые свойства сериализации.

Параметры:

name — имя свойства для извлечения

Возвращает:

значение запрашиваемого свойства

Исключения:

PropertyException — при возникновении ошибки при извлечении заданного свойства или значения имени свойства

IllegalArgumentException — если параметр name имеет значение null