Spec-Zone.ru › OpenJDK 8

Класс JAXB

  • java.lang.Object
    • javax.xml.bind.JAXB

public final class JAXB
extends Object

Класс, определяющий удобные методы для общего простого использования JAXB.

Методы, определённые в этом классе, являются удобными методами, которые объединяют несколько основных операций в JAXBContext, Unmarshaller и Marshaller. Они предназначены для использования разработчиками, которые только начинают работать с JAXB. У них есть следующие характеристики:

  1. В общем случае производительность не обязательно является оптимальной. Ожидается, что люди, которым нужно писать критически важный для производительности код, будут использовать остальную часть API JAXB напрямую.
  2. Ошибки, возникающие во время обработки, упаковываются в DataBindingException (который будет иметь JAXBException в качестве cause). Ожидается, что люди, предпочитающие обработку проверочных исключений, будут использовать остальную часть API JAXB напрямую.

Кроме того, методы unmarshal имеют следующую характеристику:

  1. Валидация схемы не выполняется для входного XML. Обработка будет продолжена, насколько это возможно, даже если в XML есть ошибки. Только в качестве крайней меры этот метод завершится с ошибкой DataBindingException.

Аналогично, методы marshal имеют следующую характеристику:

  1. Обработка будет продолжена, даже если дерево Java-объектов не соответствует требованиям валидности. Только в качестве крайней меры этот метод завершится с ошибкой DataBindingException.

Все методы этого класса требуют не-null аргументов для всех параметров. Методы unmarshal либо завершаются ошибкой, либо возвращают ненулевое значение.

С:
2.1

Методы

Модификатор и тип Метод и описание
static void marshal(Object jaxbObject, File xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

static void marshal(Object jaxbObject, OutputStream xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

static void marshal(Object jaxbObject, Result xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

static void marshal(Object jaxbObject, String xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

static void marshal(Object jaxbObject, URI xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

static void marshal(Object jaxbObject, URL xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

static void marshal(Object jaxbObject, Writer xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

static <T> T unmarshal(File xml, Class<T> type)

Считывает дерево Java-объектов из заданного входного XML.

static <T> T unmarshal(InputStream xml, Class<T> type)

Считывает дерево Java-объектов из заданного входного XML.

static <T> T unmarshal(Reader xml, Class<T> type)

Считывает дерево Java-объектов из заданного входного XML.

static <T> T unmarshal(Source xml, Class<T> type)

Считывает дерево Java-объектов из заданного входного XML.

static <T> T unmarshal(String xml, Class<T> type)

Считывает дерево Java-объектов из заданного входного XML.

static <T> T unmarshal(URI xml, Class<T> type)

Считывает дерево Java-объектов из заданного входного XML.

static <T> T unmarshal(URL xml, Class<T> type)

Считывает дерево Java-объектов из заданного входного XML.

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

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

Методы

unmarshal

public static <T> T unmarshal(File xml,
                              Class<T> type)

Считывает дерево Java-объектов из заданного XML-ввода.

Параметры:
xml - Читает весь файл как XML.

unmarshal

public static <T> T unmarshal(URL xml,
                              Class<T> type)

Считывает дерево Java-объектов из заданного XML-ввода.

Параметры:
xml - Ресурс, указанный URL, читается полностью.

unmarshal

public static <T> T unmarshal(URI xml,
                              Class<T> type)

Считывает дерево Java-объектов из заданного XML-ввода.

Параметры:
xml - URI преобразуется в turned into URL, а затем обрабатывается согласно URL.

unmarshal

public static <T> T unmarshal(String xml,
                              Class<T> type)

Считывает дерево Java-объектов из заданного XML-ввода.

Параметры:
xml - Строка сначала интерпретируется как абсолютный URI. Если она не a valid absolute URI, то она интерпретируется как File

unmarshal

public static <T> T unmarshal(InputStream xml,
                              Class<T> type)

Считывает дерево Java-объектов из заданного XML-ввода.

Параметры:
xml - Весь поток читается как XML-информационный набор. После успешного завершения поток будет закрыт этим методом.

unmarshal

public static <T> T unmarshal(Reader xml,
                              Class<T> type)

Считывает дерево Java-объектов из заданного XML-ввода.

Параметры:
xml - Поток символов читается как XML-информационный набор. Декларация кодировки в XML будет проигнорирована. После успешного завершения поток будет закрыт этим методом.

unmarshal

public static <T> T unmarshal(Source xml,
                              Class<T> type)

Считывает дерево Java-объектов из заданного XML-ввода.

Параметры:
xml - XML-информационный набор, представленный Source, считывается.

marshal

public static void marshal(Object jaxbObject,
                           File xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

Параметры:
jaxbObject - Java-объект, который должен быть сериализован в XML. Если этот объект является JAXBElement, он предоставит имя тега корня и тело. Если у этого объекта есть XmlRootElement в определении класса, это будет использовано в качестве имени тега корня, а заданный объект предоставит тело. В противном случае, имя тега корня — infered из the short class name. Этот параметр не должен быть null.
xml - XML будет записан в этот файл. Если файл уже существует, он будет перезаписан.
Исключение:
DataBindingException - Если операция завершится неудачно, например, из-за ошибки ввода-вывода или невозможности привязать классы.

marshal

public static void marshal(Object jaxbObject,
                           URL xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

Параметры:
jaxbObject - Java-объект, который должен быть сериализован в XML. Если этот объект является JAXBElement, он предоставит имя тега корня и тело. Если у этого объекта есть XmlRootElement в определении класса, это будет использовано в качестве имени тега корня, а заданный объект предоставит тело. В противном случае, имя тега корня — infered из the short class name. Этот параметр не должен быть null.
xml - XML будет sent к ресурсу, указанному этим URL. Обратите внимание, что не все URL поддерживают такую операцию, и точные семантики зависят от реализации URL. В случае HTTP URLs это выполнит HTTP POST.
Исключение:
DataBindingException - Если операция завершится неудачно, например, из-за ошибки ввода-вывода или невозможности привязать классы.

marshal

public static void marshal(Object jaxbObject,
                           URI xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

Параметры:
jaxbObject - Java-объект, который должен быть сериализован в XML. Если этот объект является JAXBElement, он предоставит имя тега корня и тело. Если у этого объекта есть XmlRootElement в определении класса, это будет использовано в качестве имени тега корня, а заданный объект предоставит тело. В противном случае, имя тега корня — infered из the short class name. Этот параметр не должен быть null.
xml - URI преобразуется в turned into URL, а затем обрабатывается согласно URL. См. выше.
Исключение:
DataBindingException - Если операция завершится неудачно, например, из-за ошибки ввода-вывода или невозможности привязать классы.

marshal

public static void marshal(Object jaxbObject,
                           String xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

Параметры:
jaxbObject - Java-объект, который должен быть сериализован в XML. Если этот объект является JAXBElement, он предоставит имя тега корня и тело. Если у этого объекта есть XmlRootElement в определении класса, это будет использовано в качестве имени тега корня, а заданный объект предоставит тело. В противном случае, имя тега корня — infered из the short class name. Этот параметр не должен быть null.
xml - Строка сначала интерпретируется как абсолютный URI. Если она не a valid absolute URI, то она интерпретируется как File
Исключение:
DataBindingException - Если операция завершится неудачно, например, из-за ошибки ввода-вывода или невозможности привязать классы.

marshal

public static void marshal(Object jaxbObject,
                           OutputStream xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

Параметры:
jaxbObject - Java-объект, который должен быть сериализован в XML. Если этот объект является JAXBElement, он предоставит имя тега корня и тело. Если у этого объекта есть XmlRootElement в определении класса, это будет использовано в качестве имени тега корня, а заданный объект предоставит тело. В противном случае, имя тега корня — infered из the short class name. Этот параметр не должен быть null.
xml - XML будет отправлен в указанный OutputStream. После успешного завершения поток будет закрыт этим методом.
Исключение:
DataBindingException - Если операция завершится неудачно, например, из-за ошибки ввода-вывода или невозможности привязать классы.

marshal

public static void marshal(Object jaxbObject,
                           Writer xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

Параметры:
jaxbObject - Java-объект, который должен быть сериализован в XML. Если этот объект является JAXBElement, он предоставит имя тега корня и тело. Если у этого объекта есть XmlRootElement в определении класса, это будет использовано в качестве имени тега корня, а заданный объект предоставит тело. В противном случае, имя тега корня — infered из the short class name. Этот параметр не должен быть null.
xml - XML будет отправлен как поток символов в указанный Writer. После успешного завершения поток будет закрыт этим методом.
Исключение:
DataBindingException - Если операция завершится неудачно, например, из-за ошибки ввода-вывода или невозможности привязать классы.

marshal

public static void marshal(Object jaxbObject,
                           Result xml)

Записывает дерево Java-объектов в XML и сохраняет его в указанном месте.

Параметры:
jaxbObject - Java-объект, который должен быть сериализован в XML. Если этот объект является JAXBElement, он предоставит имя тега корня и тело. Если у этого объекта есть XmlRootElement в определении класса, это будет использовано в качестве имени тега корня, а заданный объект предоставит тело. В противном случае, имя тега корня — infered из the short class name. Этот параметр не должен быть null.
xml - XML будет отправлен в объект Result.
Исключение:
DataBindingException - Если операция завершится неудачно, например, из-за ошибки ввода-вывода или невозможности привязать классы.

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API