程序包 cn.taketoday.http.converter.xml

类 MarshallingHttpMessageConverter

java.lang.Object

cn.taketoday.http.converter.AbstractHttpMessageConverter<T>

cn.taketoday.http.converter.xml.AbstractXmlHttpMessageConverter<Object>

cn.taketoday.http.converter.xml.MarshallingHttpMessageConverter

所有已实现的接口:

HttpMessageConverter<Object>

public class MarshallingHttpMessageConverter
extends AbstractXmlHttpMessageConverter<Object>

Implementation of HttpMessageConverter that can read and write XML using Infra Marshaller and Unmarshaller abstractions.

This converter requires a Marshaller and Unmarshaller before it can be used. These can be injected by the constructor or bean properties.

By default, this converter supports text/xml and application/xml. This can be overridden by setting the supportedMediaTypes property.

从以下版本开始:

4.0

作者:

Arjen Poutsma

字段概要

字段

修饰符和类型	字段	说明
private cn.taketoday.oxm.Marshaller	marshaller
private cn.taketoday.oxm.Unmarshaller	unmarshaller

从类继承的字段 cn.taketoday.http.converter.AbstractHttpMessageConverter

logger

构造器概要

构造器

构造器	说明
MarshallingHttpMessageConverter()	Construct a new MarshallingHttpMessageConverter with no Marshaller or Unmarshaller set.
MarshallingHttpMessageConverter(cn.taketoday.oxm.Marshaller marshaller)	Construct a new MarshallingMessageConverter with the given Marshaller set.
MarshallingHttpMessageConverter(cn.taketoday.oxm.Marshaller marshaller, cn.taketoday.oxm.Unmarshaller unmarshaller)	Construct a new MarshallingMessageConverter with the given Marshaller and Unmarshaller.

方法概要

修饰符和类型	方法	说明
boolean	canRead(Class<?> clazz, MediaType mediaType)	This implementation checks if the given class is supported, and if the supported media types include the given media type.
boolean	canWrite(Class<?> clazz, MediaType mediaType)	This implementation checks if the given class is supported, and if the supported media types include the given media type.
protected Object	readFromSource(Class<?> clazz, HttpHeaders headers, Source source)	Abstract template method called from AbstractHttpMessageConverter.read(Class, HttpInputMessage).
void	setMarshaller(cn.taketoday.oxm.Marshaller marshaller)	Set the Marshaller to be used by this message converter.
void	setUnmarshaller(cn.taketoday.oxm.Unmarshaller unmarshaller)	Set the Unmarshaller to be used by this message converter.
protected boolean	supports(Class<?> clazz)	Indicates whether the given class is supported by this converter.
protected void	writeToResult(Object o, HttpHeaders headers, Result result)	Abstract template method called from AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage).

从类继承的方法 cn.taketoday.http.converter.xml.AbstractXmlHttpMessageConverter

readInternal, transform, writeInternal

从类继承的方法 cn.taketoday.http.converter.AbstractHttpMessageConverter

addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.taketoday.http.converter.HttpMessageConverter

getSupportedMediaTypes

字段详细资料

marshaller

@Nullable
private cn.taketoday.oxm.Marshaller marshaller

unmarshaller

@Nullable
private cn.taketoday.oxm.Unmarshaller unmarshaller

构造器详细资料

MarshallingHttpMessageConverter

public MarshallingHttpMessageConverter()

Construct a new MarshallingHttpMessageConverter with no Marshaller or Unmarshaller set. The Marshaller and Unmarshaller must be set after construction by invoking setMarshaller(Marshaller) and setUnmarshaller(Unmarshaller).

MarshallingHttpMessageConverter

public MarshallingHttpMessageConverter(cn.taketoday.oxm.Marshaller marshaller)

Construct a new MarshallingMessageConverter with the given Marshaller set.

If the given Marshaller also implements the Unmarshaller interface, it is used for both marshalling and unmarshalling. Otherwise, an exception is thrown.

Note that all Marshaller implementations in Infra also implement the Unmarshaller interface, so that you can safely use this constructor.

参数:

marshaller - object used as marshaller and unmarshaller

MarshallingHttpMessageConverter

public MarshallingHttpMessageConverter(cn.taketoday.oxm.Marshaller marshaller,
 cn.taketoday.oxm.Unmarshaller unmarshaller)

Construct a new MarshallingMessageConverter with the given Marshaller and Unmarshaller.

参数:

marshaller - the Marshaller to use

unmarshaller - the Unmarshaller to use

方法详细资料

setMarshaller

public void setMarshaller(cn.taketoday.oxm.Marshaller marshaller)

Set the Marshaller to be used by this message converter.

setUnmarshaller

public void setUnmarshaller(cn.taketoday.oxm.Unmarshaller unmarshaller)

Set the Unmarshaller to be used by this message converter.

canRead

public boolean canRead(Class<?> clazz,
 @Nullable
 MediaType mediaType)

从类复制的说明: AbstractHttpMessageConverter

This implementation checks if the given class is supported, and if the supported media types include the given media type.

指定者:

canRead 在接口中 HttpMessageConverter<Object>

覆盖:

canRead 在类中 AbstractHttpMessageConverter<Object>

参数:

clazz - the class to test for readability

mediaType - the media type to read (can be null if not specified); typically the value of a Content-Type header.

返回:

true if readable; false otherwise

canWrite

public boolean canWrite(Class<?> clazz,
 @Nullable
 MediaType mediaType)

从类复制的说明: AbstractHttpMessageConverter

This implementation checks if the given class is supported, and if the supported media types include the given media type.

指定者:

canWrite 在接口中 HttpMessageConverter<Object>

覆盖:

canWrite 在类中 AbstractHttpMessageConverter<Object>

参数:

clazz - the class to test for writability

mediaType - the media type to write (can be null if not specified); typically the value of an Accept header.

返回:

true if writable; false otherwise

supports

protected boolean supports(Class<?> clazz)

从类复制的说明: AbstractHttpMessageConverter

Indicates whether the given class is supported by this converter.

指定者:

supports 在类中 AbstractHttpMessageConverter<Object>

参数:

clazz - the class to test for support

返回:

true if supported; false otherwise

readFromSource

protected Object readFromSource(Class<?> clazz,
 HttpHeaders headers,
 Source source)
                         throws Exception

从类复制的说明: AbstractXmlHttpMessageConverter

Abstract template method called from AbstractHttpMessageConverter.read(Class, HttpInputMessage).

指定者:

readFromSource 在类中 AbstractXmlHttpMessageConverter<Object>

参数:

clazz - the type of object to return

headers - the HTTP input headers

source - the HTTP input body

返回:

the converted object

抛出:

Exception - in case of I/O or conversion errors

writeToResult

protected void writeToResult(Object o,
 HttpHeaders headers,
 Result result)
                      throws Exception

从类复制的说明: AbstractXmlHttpMessageConverter

Abstract template method called from AbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage).

指定者:

writeToResult 在类中 AbstractXmlHttpMessageConverter<Object>

参数:

o - the object to write to the output message

headers - the HTTP output headers

result - the HTTP output body

抛出:

Exception - in case of I/O or conversion errors