Класс AbstractMarshallerImpl

java.lang.Object
- javax.xml.bind.helpers.AbstractMarshallerImpl

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

public abstract class AbstractMarshallerImpl
extends Object
implements Marshaller

Частичная реализация по умолчанию Marshaller .

Этот класс предоставляет частичную реализацию по умолчанию для интерфейса Marshaller.

Единственными методами, которые должен реализовать поставщик JAXB, являются marshal(Object, javax.xml.transform.Result), marshal(Object, javax.xml.stream.XMLStreamWriter) и marshal(Object, javax.xml.stream.XMLEventWriter).

С:: JAXB1.0
См. также:: Marshaller

Вложенные классы

Вложенные классы/интерфейсы, унаследованные от интерфейса javax.xml.bind.Marshaller

Marshaller.Listener

Поля

Поля, унаследованные от интерфейса javax.xml.bind.Marshaller

JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION

Краткое описание конструкторов

Конструктор и описание
`AbstractMarshallerImpl()`

Краткое описание методов

Модификатор и тип	Метод и описание
`<A extends XmlAdapter> A`	`getAdapter(Class<A> type)` Получение адаптера, связанного со специфицированным типом.
`AttachmentMarshaller`	`getAttachmentMarshaller()`
`protected String`	`getEncoding()` Удобный метод для получения текущего кодирования вывода.
`ValidationEventHandler`	`getEventHandler()` Возвращает текущий обработчик событий или обработчик событий по умолчанию, если он не был задан.
`protected String`	`getJavaEncoding(String encoding)` Получение соответствующего имени кодирования Java из имени IANA.
`Marshaller.Listener`	`getListener()` Возвращает зарегистрированный `Marshaller.Listener` с этим `Marshaller`.
`Node`	`getNode(Object obj)` По умолчанию метод getNode не поддерживается и выбрасывает `UnsupportedOperationException`.
`protected String`	`getNoNSSchemaLocation()` Удобный метод для получения текущего значения noNamespaceSchemaLocation.
`Object`	`getProperty(String name)` Реализация по умолчанию метода getProperty обрабатывает четыре определенных свойства в Marshaller.
`Schema`	`getSchema()` Получение объекта JAXP 1.3 `Schema`, используемого для проверки на этапе маршализации.
`protected String`	`getSchemaLocation()` Удобный метод для получения текущего значения schemaLocation.
`protected boolean`	`isFormattedOutput()` Удобный метод для получения флага отформатированного вывода.
`protected boolean`	`isFragment()` Удобный метод для получения флага фрагмента.
`void`	`marshal(Object obj, ContentHandler handler)` Маршализация дерева содержимого, укорененного в `jaxbElement`, в SAX2 события.
`void`	`marshal(Object jaxbElement, File output)` Маршализация дерева содержимого, укорененного в `jaxbElement`, в файл.
`void`	`marshal(Object obj, Node node)` Маршализация дерева содержимого, укорененного в `jaxbElement`, в дерево DOM.
`void`	`marshal(Object obj, OutputStream os)` Маршализация дерева содержимого, укорененного в `jaxbElement`, в поток вывода.
`void`	`marshal(Object obj, Writer w)` Маршализация дерева содержимого, укорененного в `jaxbElement`, в Writer.
`void`	`marshal(Object obj, XMLEventWriter writer)` Маршализация дерева содержимого, укорененного в `jaxbElement`, в `XMLEventWriter`.
`void`	`marshal(Object obj, XMLStreamWriter writer)` Маршализация дерева содержимого, укорененного в `jaxbElement`, в `XMLStreamWriter`.
`<A extends XmlAdapter> void`	`setAdapter(Class<A> type, A adapter)` Связывает настроенный экземпляр `XmlAdapter` с этим маршаллером.
`void`	`setAdapter(XmlAdapter adapter)` Связывает настроенный экземпляр `XmlAdapter` с этим маршаллером.
`void`	`setAttachmentMarshaller(AttachmentMarshaller am)` Связывает контекст, который позволяет передавать двоичные данные внутри XML-документа как оптимизированное XML-бинарное вложение.
`protected void`	`setEncoding(String encoding)` Удобный метод для установки кодирования вывода.
`void`	`setEventHandler(ValidationEventHandler handler)` Разрешает приложению зарегистрировать обработчик событий проверки.
`protected void`	`setFormattedOutput(boolean v)` Удобный метод для установки флага отформатированного вывода.
`protected void`	`setFragment(boolean v)` Удобный метод для установки флага фрагмента.
`void`	`setListener(Marshaller.Listener listener)` Регистрация обратного вызова события маршализации `Marshaller.Listener` с этим `Marshaller`.
`protected void`	`setNoNSSchemaLocation(String location)` Удобный метод для установки noNamespaceSchemaLocation.
`void`	`setProperty(String name, Object value)` Реализация по умолчанию метода setProperty обрабатывает четыре определенных свойства в Marshaller.
`void`	`setSchema(Schema schema)` Укажите объект JAXP 1.3 `Schema`, который должен использоваться для проверки последующих операций маршализации.
`protected void`	`setSchemaLocation(String location)` Удобный метод для установки schemaLocation.

Методы, унаследованные от класса java.lang.Object

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

Методы, унаследованные от интерфейса javax.xml.bind.Marshaller

marshal

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

AbstractMarshallerImpl

public AbstractMarshallerImpl()

Методы

marshal

public final void marshal(Object obj,
                          OutputStream os)
                   throws JAXBException

Описание скопировано из интерфейса: Marshaller

Маршализовать дерево содержимого, укорененное в jaxbElement в выходной поток.

Определено в:: marshal в интерфейсе Marshaller
Параметры:: obj - Корень дерева содержимого, подлежащего маршализации.; os - XML будет добавлен в этот поток.
Исключения:: JAXBException - Если во время маршализации возникнет непредвиденная проблема.; MarshalException - Если ValidationEventHandler возвращает false из своего метода handleEvent или Marshaller не может маршализовать obj (или любой объект, доступный из obj). См. Маршализация элемента JAXB.

marshal

public void marshal(Object jaxbElement,
                    File output)
             throws JAXBException

Описание скопировано из интерфейса: Marshaller

Маршализовать дерево содержимого, укорененное в jaxbElement в файл.

Определено в:: marshal в интерфейсе Marshaller
Параметры:: jaxbElement - Корень дерева содержимого, подлежащего маршализации.; output - Файл для записи. Если этот файл уже существует, он будет перезаписан.
Исключения:: JAXBException - Если во время маршализации возникнет непредвиденная проблема.; MarshalException - Если ValidationEventHandler возвращает false из своего метода handleEvent или Marshaller не может маршализовать obj (или любой объект, доступный из obj). См. Маршализация элемента JAXB.

marshal

public final void marshal(Object obj,
                          Writer w)
                   throws JAXBException

Описание скопировано из интерфейса: Marshaller

Маршализовать дерево содержимого, укорененное в jaxbElement в Writer.

Определено в:: marshal в интерфейсе Marshaller
Параметры:: obj - Корень дерева содержимого, подлежащего маршализации.; w - XML будет отправлен в этот writer.
Исключения:: JAXBException - Если во время маршализации возникнет непредвиденная проблема.; MarshalException - Если ValidationEventHandler возвращает false из своего метода handleEvent или Marshaller не может маршализовать obj (или любой объект, доступный из obj). См. Маршализация элемента JAXB.

marshal

public final void marshal(Object obj,
                          ContentHandler handler)
                   throws JAXBException

Описание скопировано из интерфейса: Marshaller

Маршализовать дерево содержимого, укорененное в jaxbElement в события SAX2.

Определено в:: marshal в интерфейсе Marshaller
Параметры:: obj - Корень дерева содержимого, подлежащего маршализации.; handler - XML будет отправлен этому обработчику как события SAX2.
Исключения:: JAXBException - Если во время маршализации возникнет непредвиденная проблема.; MarshalException - Если ValidationEventHandler возвращает false из своего метода handleEvent или Marshaller не может маршализовать obj (или любой объект, доступный из obj). См. Маршализация элемента JAXB.

marshal

public final void marshal(Object obj,
                          Node node)
                   throws JAXBException

Описание скопировано из интерфейса: Marshaller

Маршализовать дерево содержимого, укорененное в jaxbElement в дерево DOM.

Определено в:: marshal в интерфейсе Marshaller
Параметры:: obj - Дерево содержимого, подлежащее маршализации.; node - Узлы DOM будут добавлены как дочерние узлы этого узла. Этот параметр должен быть узлом, принимающим дочерние элементы (Document, DocumentFragment или Element)
Исключения:: JAXBException - Если во время маршализации возникнет непредвиденная проблема.; MarshalException - Если ValidationEventHandler возвращает false из своего метода handleEvent или Marshaller не может маршализовать jaxbElement (или любой объект, доступный из jaxbElement). См. Маршализация элемента JAXB.

getNode

public Node getNode(Object obj)
             throws JAXBException

По умолчанию метод getNode не поддерживается и выбрасывает UnsupportedOperationException. Реализации, которые выбирают поддержку этого метода, должны переопределить этот метод.

Определено в:: getNode в интерфейсе Marshaller
Параметры:: obj - - JAXB Java представление XML содержимого
Возвращает:: представление дерева DOM содержимого
Исключения:: JAXBException - Если во время маршализации возникнет непредвиденная проблема

getEncoding

protected String getEncoding()

Удобный метод для получения текущего кодирования вывода.

Возвращает:: текущее кодирование или "UTF-8", если оно не было установлено.

setEncoding

protected void setEncoding(String encoding)

Удобный метод для установки кодирования вывода.

Параметры:: encoding - допустимое кодирование, как указано в документации к классу Marshaller

getSchemaLocation

protected String getSchemaLocation()

Удобный метод для получения текущей schemaLocation.

Возвращает:: текущая schemaLocation или null, если она не была установлена

setSchemaLocation

protected void setSchemaLocation(String location)

Удобный метод для установки schemaLocation.

Параметры:: location - значение schemaLocation

getNoNSSchemaLocation

protected String getNoNSSchemaLocation()

Удобный метод для получения текущего noNamespaceSchemaLocation.

Возвращает:: текущее noNamespaceSchemaLocation или null, если оно не было установлено

setNoNSSchemaLocation

protected void setNoNSSchemaLocation(String location)

Удобный метод для установки noNamespaceSchemaLocation.

Параметры:: location - значение noNamespaceSchemaLocation

isFormattedOutput

protected boolean isFormattedOutput()

Удобный метод для получения флага отформатированного вывода.

Возвращает:: текущее значение флага отформатированного вывода или false, если он не был установлен.

setFormattedOutput

protected void setFormattedOutput(boolean v)

Удобный метод для установки флага отформатированного вывода.

Параметры:: v - значение флага отформатированного вывода.

isFragment

protected boolean isFragment()

Удобный метод для получения флага фрагмента.

Возвращает:: текущее значение флага фрагмента или false, если он не был установлен.

setFragment

protected void setFragment(boolean v)

Удобный метод для установки флага фрагмента.

Параметры:: v - значение флага фрагмента.

getJavaEncoding

protected String getJavaEncoding(String encoding)
                          throws UnsupportedEncodingException

Получает соответствующее имя Java кодирования из имени IANA. Этот метод является вспомогательным методом для производного класса для преобразования имен кодирования.

Исключения:: UnsupportedEncodingException - Если эта реализация не смогла найти имя Java кодирования.

setProperty

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

Реализация метода setProperty по умолчанию обрабатывает четыре определенных свойства в Marshaller. Если поставщику нужно обработать дополнительные свойства, он должен переопределить этот метод в производном классе.

Определено в:: setProperty в интерфейсе Marshaller
Параметры:: name - имя свойства, которое нужно установить. Это значение может быть указано с использованием одного из постоянных полей или строки, предоставленной пользователем.; value - значение свойства, которое нужно установить
Исключения:: PropertyException - при возникновении ошибки при обработке заданного свойства или значения

getProperty

public Object getProperty(String name)
                   throws PropertyException

Реализация метода getProperty по умолчанию обрабатывает четыре определенных свойства в Marshaller. Если поставщику нужно поддерживать дополнительные свойства, специфичные для поставщика, он должен переопределить этот метод в производном классе.

Определено в:: getProperty в интерфейсе Marshaller
Параметры:: name - имя свойства, которое нужно получить
Возвращает:: значение запрошенного свойства
Исключения:: PropertyException - при возникновении ошибки при получении заданного свойства или имени свойства

getEventHandler

public ValidationEventHandler getEventHandler()
                                       throws JAXBException

Описание скопировано из интерфейса: Marshaller

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

Определено в:: getEventHandler в интерфейсе Marshaller
Возвращает:: текущий ValidationEventHandler или обработчик событий по умолчанию, если он не был задан
Исключения:: JAXBException - если возникла ошибка при получении текущего обработчика событий
См. также:: Marshaller.getEventHandler()

setEventHandler

public void setEventHandler(ValidationEventHandler handler)
                     throws JAXBException

Описание скопировано из интерфейса: Marshaller

Разрешает приложению зарегистрировать обработчик события валидации.

Обработчик события валидации будет вызываться поставщиком JAXB, если при вызовах методов API маршализации обнаружатся какие-либо ошибки валидации. Если клиентское приложение не зарегистрирует обработчик события валидации перед вызовом одного из методов маршализации, обработка событий валидации будет выполняться по умолчанию, что приведет к завершению операции маршализации после первой ошибки или фатальной ошибки.

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

Указано в:: setEventHandler в интерфейсе Marshaller
Параметры:: handler - обработчик события валидации
Исключения:: JAXBException - если при настройке обработчика возникла ошибка
См. также:: Marshaller.setEventHandler(ValidationEventHandler)

marshal

public void marshal(Object obj,
                    XMLEventWriter writer)
             throws JAXBException

Описание скопировано из интерфейса: Marshaller

Маршализация дерева содержимого, укоренённого в jaxbElement в XMLEventWriter.

Указано в:: marshal в интерфейсе Marshaller
Параметры:: obj - Дерево содержимого, укорененное в jaxbElement, подлежащее маршализации.; writer - XML будет отправлен этому обработчику.
Исключения:: JAXBException - Если во время маршализации возникла непредвиденная проблема.; MarshalException - Если ValidationEventHandler возвращает false из своего метода handleEvent или Marshaller не может выполнить маршализация obj (или любого объекта, доступного из obj). См. Маршализация элемента JAXB.

marshal

public void marshal(Object obj,
                    XMLStreamWriter writer)
             throws JAXBException

Описание скопировано из интерфейса: Marshaller

Маршализация дерева содержимого, укоренённого в jaxbElement в XMLStreamWriter.

Указано в:: marshal в интерфейсе Marshaller
Параметры:: obj - Дерево содержимого, подлежащее маршализации.; writer - XML будет отправлен этому обработчику.
Исключения:: JAXBException - Если во время маршализации возникла непредвиденная проблема.; MarshalException - Если ValidationEventHandler возвращает false из своего метода handleEvent или Marshaller не может выполнить маршализация obj (или любого объекта, доступного из obj). См. Маршализация элемента JAXB.

setSchema

public void setSchema(Schema schema)

Описание скопировано из интерфейса: Marshaller

Укажите объект JAXP 1.3 Schema, который должен использоваться для валидации последующих операций маршализации. Передача null в этот метод отключит валидацию.

Этот метод позволяет вызывающей стороне валидировать маршализованный XML по мере его маршализации.

Изначально этот свойство установлено на null.

Указано в:: setSchema в интерфейсе Marshaller
Параметры:: schema - Объект схемы для валидации операций маршализации или null для отключения валидации

getSchema

public Schema getSchema()

Описание скопировано из интерфейса: Marshaller

Получение объекта JAXP 1.3 Schema, используемого для валидации при маршализации. Если для маршалайзера не установлена схема, этот метод вернёт null, указывая, что валидация при маршализации не будет выполнена.

Указано в:: getSchema в интерфейсе Marshaller
Возвращает:: объект Schema, используемый для валидации при маршализации, или null, если он отсутствует.

setAdapter

public void setAdapter(XmlAdapter adapter)

Описание скопировано из интерфейса: Marshaller

Связывает настроенный экземпляр XmlAdapter с этим маршалайзером.

Это удобный метод, который вызывает setAdapter(adapter.getClass(),adapter);.

Указано в:: setAdapter в интерфейсе Marshaller
См. также:: Marshaller.setAdapter(Class,XmlAdapter)

setAdapter

public <A extends XmlAdapter> void setAdapter(Class<A> type,
                                              A adapter)

Описание скопировано из интерфейса: Marshaller

Связывает настроенный экземпляр XmlAdapter с этим маршалайзером.

Каждый маршалайзер внутренне содержит Map<Class,XmlAdapter>, который используется для маршализации классов, поля/методы которых аннотированы XmlJavaTypeAdapter.

Этот метод позволяет приложениям использовать настроенный экземпляр XmlAdapter. Если экземпляр адаптера не задан, маршалайзер создаст его, вызвав конструктор по умолчанию.

Указано в:: setAdapter в интерфейсе Marshaller
Параметры:: type - Тип адаптера. Указанный экземпляр будет использоваться, когда XmlJavaTypeAdapter.value() ссылается на этот тип.; adapter - Экземпляр адаптера для использования. Если null, текущий адаптер для этого типа будет удалён.

getAdapter

public <A extends XmlAdapter> A getAdapter(Class<A> type)

Описание скопировано из интерфейса: Marshaller

Получает адаптер, связанный с указанным типом. Это обратная операция метода Marshaller.setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter).

Указано в:: getAdapter в интерфейсе Marshaller

setAttachmentMarshaller

public void setAttachmentMarshaller(AttachmentMarshaller am)

Описание скопировано из интерфейса: Marshaller

Связывает контекст, который позволяет передавать двоичные данные в XML-документе в качестве оптимизированного вложения XML-двоичных данных. Вложение ссылается из модели содержимого XML-документа с помощью URI идентификаторов содержимого (cid), хранящихся в XML-документе.

Указано в:: setAttachmentMarshaller в интерфейсе Marshaller

getAttachmentMarshaller

public AttachmentMarshaller getAttachmentMarshaller()

Указано в:: getAttachmentMarshaller в интерфейсе Marshaller

setListener

public void setListener(Marshaller.Listener listener)

Описание скопировано из интерфейса: Marshaller

Регистрирует обратный вызов события маршализации Marshaller.Listener с этим Marshaller.

На один маршалайзер может быть зарегистрирован только один обработчик. Установка обработчика заменяет ранее установленный обработчик. Можно отменить регистрацию текущего обработчика, установив обработчик в null.

Указано в:: setListener в интерфейсе Marshaller
Параметры:: listener - экземпляр класса, реализующего Marshaller.Listener

getListener

public Marshaller.Listener getListener()

Описание скопировано из интерфейса: Marshaller

Возвращает зарегистрированный Marshaller.Listener с этим Marshaller.

Указано в:: getListener в интерфейсе Marshaller
Возвращает:: зарегистрированный Marshaller.Listener или null если с этим маршалайзером не зарегистрирован обработчик.

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.