Spec-Zone .ru спецификации, руководства, описания, API

javax.xml.bind
Редактор связей класса <XmlNode>

java.lang.Object
  javax.xml.bind.Binder<XmlNode>

public abstract class Binder<XmlNode>
расширяет java.lang. Объект

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

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

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

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

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

Экземпляр Редактора связей создается, используя метод фабрики JAXBContext#createBinder() или JAXBContext#createBinder(Class).

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

С тех пор:

JAXB 2.0

Автор:

Kohsuke Кавагути (kohsuke.kawaguchi@sun.com) Джозеф Фьалли

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

Binder()

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

abstract ValidationEventHandler	getEventHandler() Возвратите текущий обработчик событий или обработчик стандартного события, если Вы не были установлены.
abstract java.lang.Object	getJAXBNode(XmlNode xmlNode) Получает объект JAXB, связанный с данным элементом XML.
abstract java.lang.Object	getProperty(java.lang.String name) Получите определенное свойство в базовой реализации Binder.
abstract javax.xml.validation.Schema	getSchema() Получает последнее Schema объект (включая нуль) установленный setSchema(Schema) метод.
abstract XmlNode	getXMLNode(java.lang.Object jaxbObject) Связали элемент XML с данным объектом JAXB.
abstract void	marshal(java.lang.Object jaxbObject, XmlNode xmlNode) Упорядочьте дерево объекта JAXB к новому XML-документу.
abstract void	setEventHandler(ValidationEventHandler handler) Позвольте приложению регистрировать ValidationEventHandler.
abstract void	setProperty(java.lang.String name, java.lang.Object value) Установите определенное свойство в базовой реализации Binder.
abstract void	setSchema(javax.xml.validation.Schema schema) Определяет, упорядочивают ли, неупорядочивают и обновляют методы, выполняет проверку допустимости на их контенте XML.
abstract java.lang.Object	unmarshal(XmlNode xmlNode) Неупорядочьте представление инфонабора XML к дереву объекта JAXB.
abstract <T> JAXBElement<T>	unmarshal(XmlNode xmlNode, java.lang.Class<T> declaredType) Неупорядочьте корневой элемент XML по обеспеченному declaredType к дереву объекта JAXB.
abstract java.lang.Object	updateJAXB(XmlNode xmlNode) Берет узел XML и обновляет его связанный объект JAXB и его потомков.
abstract XmlNode	updateXML(java.lang.Object jaxbObject) Берет объект JAXB и обновляет его связанный узел XML и его потомков.
abstract XmlNode	updateXML(java.lang.Object jaxbObject, XmlNode xmlNode) Изменения в JAXB возражают, что дерево обновляется в его связанном дереве синтаксического анализа XML.

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

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

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

Редактор связей

public Binder()

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

неупорядочить

public abstract java.lang.Object unmarshal(XmlNode xmlNode)
                                    throws JAXBException

Неупорядочьте представление инфонабора XML к дереву объекта JAXB.

Этот метод подобен Unmarshaller#unmarshal(Node) с добавлением поддержания ассоциации между узлами XML и произведенными объектами JAXB, включая будущему обновляют операции, updateXML(Object, Object) или updateJAXB(Object).

Когда getSchema() ненуль, xmlNode и его потомки проверяются во время этой работы.

Этот метод броски UnmarshalException когда Редактор связей JAXBContext не имеет отображения для имени элемента XML или типа, specifiable через @xsi:type, xmlNode к JAXB отображенный class. Метод unmarshal(Object, Class) позволяет приложению определить JAXB отображенный class, на который должен быть отображен xmlNode.

Параметры:

xmlNode - документ/элемент, чтобы неупорядочить данные XML от.

Возвраты:

недавно создаваемый корневой объект JAXB возражает дереву.

Броски:

JAXBException - Если какие-либо неожиданные ошибки происходят, неупорядочивая

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

IllegalArgumentException - Если параметр узла является нулем

неупорядочить

public abstract <T> JAXBElement<T> unmarshal(XmlNode xmlNode,
                                             java.lang.Class<T> declaredType)
                                  throws JAXBException

Неупорядочьте корневой элемент XML по обеспеченному declaredType к дереву объекта JAXB.

Реализации Неупорядочивают по Объявленному Типу

Этот метод подобен Unmarshaller#unmarshal(Node, Class) с добавлением поддержания ассоциации между узлами XML и произведенными объектами JAXB, включая будущему обновляют операции, updateXML(Object, Object) или updateJAXB(Object).

Когда getSchema() ненуль, xmlNode и его потомки проверяются во время этой работы.

Параметры:

xmlNode - документ/элемент, чтобы неупорядочить данные XML от.

declaredType - приспособьте JAXB отображенный class, чтобы содержать данные XML node.

Возвраты:

Представление Элемента JAXB node

Броски:

JAXBException - Если какие-либо неожиданные ошибки происходят, неупорядочивая

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

IllegalArgumentException - Если какой-либо из входных параметров является нулем

С тех пор:

JAXB2.0

упорядочить

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

Упорядочьте дерево объекта JAXB к новому XML-документу.

Этот метод подобен Marshaller#marshal(Object, Node) с добавлением поддержания ассоциации между JAXB возражает и произведенные узлы XML, включая будущим операциям обновления такой как updateXML(Object, Object) или updateJAXB(Object).

Когда getSchema() ненуль, упорядоченный xml контент проверяется во время этой работы.

Параметры:

jaxbObject - Дерево контента, которое будет упорядочено.

xmlNode - Параметром должен быть Узел, который принимает дочерние элементы.

Броски:

JAXBException - Если какая-либо неожиданная проблема происходит во время маршалинга.

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

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

getXMLNode

public abstract XmlNode getXMLNode(java.lang.Object jaxbObject)

Связали элемент XML с данным объектом JAXB.

Однажды JAXB возражают, что дерево связывается с фрагментом XML, этот метод включает навигации между этими двумя деревьями.

Ассоциация между элементом XML и объектом JAXB устанавливается связывать методами и методами обновления. Отметьте, что эта ассоциация является частичной; не все элементы XML связали объекты JAXB, и не все объекты JAXB связали элементы XML.

Параметры:

jaxbObject - Экземпляр, который достижим от предшествующего звонка в метод связывания или обновления, который возвратил JAXB, возражает дереву.

Возвраты:

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

Броски:

IllegalArgumentException - Если jaxbObject параметр является нулем

getJAXBNode

public abstract java.lang.Object getJAXBNode(XmlNode xmlNode)

Получает объект JAXB, связанный с данным элементом XML.

Однажды JAXB возражают, что дерево связывается с фрагментом XML, этот метод включает навигации между этими двумя деревьями.

Ассоциация между элементом XML и объектом JAXB устанавливается неупорядочиванием, упорядочьте и обновите методы. Отметьте, что эта ассоциация является частичной; не все элементы XML связали объекты JAXB, и не все объекты JAXB связали элементы XML.

Возвраты:

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

Броски:

IllegalArgumentException - Если параметр узла является нулем

updateXML

public abstract XmlNode updateXML(java.lang.Object jaxbObject)
                           throws JAXBException

Берет объект JAXB и обновляет его связанный узел XML и его потомков.

Это - метод удобства:

 updateXML( jaxbObject, getXMLNode(jaxbObject));
 

Броски:

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

IllegalArgumentException - Если jaxbObject параметр является нулем

updateXML

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

Изменения в JAXB возражают, что дерево обновляется в его связанном дереве синтаксического анализа XML.

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

Например, неизвестные элементы/атрибуты в XML, которые не были связаны с JAXB, оставят нетронутыми (тогда как работа маршалинга создала бы новое дерево, которое не содержит ни одного из тех.)

Как побочный эффект, эта работа обновляет ассоциацию между узлами XML и объектами JAXB.

Параметры:

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

xmlNode - корень обновления предназначается для дерева синтаксического анализа XML

Возвраты:

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

Броски:

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

IllegalArgumentException - Если какой-либо из входных параметров является нулем

updateJAXB

public abstract java.lang.Object updateJAXB(XmlNode xmlNode)
                                     throws JAXBException

Берет узел XML и обновляет его связанный объект JAXB и его потомков.

Эта работа может считаться "оперативным" немаршалингом. Различие - то, что вместо того, чтобы создать совершенно новое дерево JAXB, эта работа обновляет существующее дерево, снова используя так много объектов JAXB насколько возможно.

Как побочный эффект, эта работа обновляет ассоциацию между узлами XML и объектами JAXB.

Возвраты:

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

Броски:

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

IllegalArgumentException - Если параметр узла является нулем

setSchema

public abstract void setSchema(javax.xml.validation.Schema schema)

Определяет, упорядочивают ли, неупорядочивают и обновляют методы, выполняет проверку допустимости на их контенте XML.

Параметры:

schema - установите в NULL, чтобы отключить проверку допустимости.

См. Также:

Unmarshaller#setSchema(Schema)

getSchema

public abstract javax.xml.validation.Schema getSchema()

Получает последнее Schema объект (включая нуль) установленный setSchema(Schema) метод.

Возвраты:

объект Схемы для проверки допустимости или нуля, если не существующий

setEventHandler

public abstract void setEventHandler(ValidationEventHandler handler)
                              throws JAXBException

Позвольте приложению регистрировать ValidationEventHandler.

ValidationEventHandler вызовет Провайдер JAXB, если с какими-либо ошибками проверки допустимости встретятся во время звонков в какой-либо Редактор связей, неупорядочивают, упорядочивают и обновляют методы.

Вызов этого метода с нулевым параметром заставит Редактор связей возвращаться назад к обработчику стандартного события значения по умолчанию.

Параметры:

handler - обработчик событий проверки допустимости

Броски:

JAXBException - если с ошибкой встретились, устанавливая обработчик событий

getEventHandler

public abstract ValidationEventHandler getEventHandler()
                                                throws JAXBException

Возвратите текущий обработчик событий или обработчик стандартного события, если Вы не были установлены.

Возвраты:

текущий ValidationEventHandler или обработчик стандартного события, если это не было установлено

Броски:

JAXBException - если с ошибкой встретились, получая текущий обработчик событий

setProperty

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

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

Параметры:

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

value - значение свойства, которое будет установлено

Броски:

PropertyException - когда есть ошибка, обрабатывая данное свойство или значение

IllegalArgumentException - Если параметр имени является нулем

getProperty

public abstract java.lang.Object getProperty(java.lang.String name)
                                      throws PropertyException

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

Параметры:

name - имя свойства, чтобы получить

Возвраты:

значение требуемого свойства

Броски:

PropertyException - когда есть ошибка, получая данное свойство или имя свойства значения

IllegalArgumentException - Если параметр имени является нулем