类 MarshallingHttpMessageConverter
- java.lang.Object
- org.springframework.http.converter.AbstractHttpMessageConverter<T>
- org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter<Object>
- org.springframework.http.converter.xml.MarshallingHttpMessageConverter
- 所有已实现的接口:
HttpMessageConverter<Object>
public class MarshallingHttpMessageConverter extends AbstractXmlHttpMessageConverter<Object>
Implementation ofHttpMessageConverterthat can read and write XML using Spring'sMarshallerandUnmarshallerabstractions.This converter requires a
MarshallerandUnmarshallerbefore it can be used. These can be injected by the constructor or bean properties.By default, this converter supports
text/xmlandapplication/xml. This can be overridden by setting thesupportedMediaTypesproperty.- 从以下版本开始:
- 3.0
- 作者:
- Arjen Poutsma
字段概要
从类继承的字段 org.springframework.http.converter.AbstractHttpMessageConverter
logger
构造器概要
构造器 构造器 说明 MarshallingHttpMessageConverter()MarshallingHttpMessageConverter(Marshaller marshaller)Construct a newMarshallingMessageConverterwith the givenMarshallerset.MarshallingHttpMessageConverter(Marshaller marshaller, Unmarshaller unmarshaller)Construct a newMarshallingMessageConverterwith the givenMarshallerandUnmarshaller.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 booleancanRead(Class<?> clazz, MediaType mediaType)This implementation checks if the given class is supported, and if the supported media typesinclude the given media type.booleancanWrite(Class<?> clazz, MediaType mediaType)protected ObjectreadFromSource(Class<?> clazz, HttpHeaders headers, Source source)Abstract template method called fromAbstractHttpMessageConverter.read(Class, HttpInputMessage).voidsetMarshaller(Marshaller marshaller)Set theMarshallerto be used by this message converter.voidsetUnmarshaller(Unmarshaller unmarshaller)Set theUnmarshallerto be used by this message converter.protected booleansupports(Class<?> clazz)Indicates whether the given class is supported by this converter.protected voidwriteToResult(Object o, HttpHeaders headers, Result result)Abstract template method called fromAbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage).从类继承的方法 org.springframework.http.converter.xml.AbstractXmlHttpMessageConverter
readInternal, transform, writeInternal
从类继承的方法 org.springframework.http.converter.AbstractHttpMessageConverter
addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, getDefaultContentType, getSupportedMediaTypes, read, setDefaultCharset, setSupportedMediaTypes, write
构造器详细资料
MarshallingHttpMessageConverter
public MarshallingHttpMessageConverter()
Construct a newMarshallingHttpMessageConverterwith noMarshallerorUnmarshallerset. The Marshaller and Unmarshaller must be set after construction by invokingsetMarshaller(Marshaller)andsetUnmarshaller(Unmarshaller).
MarshallingHttpMessageConverter
public MarshallingHttpMessageConverter(Marshaller marshaller)
Construct a newMarshallingMessageConverterwith the givenMarshallerset.If the given
Marshalleralso implements theUnmarshallerinterface, it is used for both marshalling and unmarshalling. Otherwise, an exception is thrown.Note that all
Marshallerimplementations in Spring also implement theUnmarshallerinterface, so that you can safely use this constructor.- 参数:
marshaller- object used as marshaller and unmarshaller
MarshallingHttpMessageConverter
public MarshallingHttpMessageConverter(Marshaller marshaller, Unmarshaller unmarshaller)
Construct a newMarshallingMessageConverterwith the givenMarshallerandUnmarshaller.- 参数:
marshaller- the Marshaller to useunmarshaller- the Unmarshaller to use
方法详细资料
setMarshaller
public void setMarshaller(Marshaller marshaller)
Set theMarshallerto be used by this message converter.
setUnmarshaller
public void setUnmarshaller(Unmarshaller unmarshaller)
Set theUnmarshallerto be used by this message converter.
canRead
public boolean canRead(Class<?> clazz, @Nullable MediaType mediaType)
从类复制的说明:AbstractHttpMessageConverterThis implementation checks if the given class is supported, and if the supported media typesinclude the given media type.- 指定者:
canRead在接口中HttpMessageConverter<Object>- 覆盖:
canRead在类中AbstractHttpMessageConverter<Object>- 参数:
clazz- the class to test for readabilitymediaType- the media type to read (can benullif not specified); typically the value of aContent-Typeheader.- 返回:
trueif readable;falseotherwise
canWrite
public boolean canWrite(Class<?> clazz, @Nullable MediaType mediaType)
从类复制的说明:AbstractHttpMessageConverterThis 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 writabilitymediaType- the media type to write (can benullif not specified); typically the value of anAcceptheader.- 返回:
trueif writable;falseotherwise
supports
protected boolean supports(Class<?> clazz)
从类复制的说明:AbstractHttpMessageConverterIndicates whether the given class is supported by this converter.- 指定者:
supports在类中AbstractHttpMessageConverter<Object>- 参数:
clazz- the class to test for support- 返回:
trueif supported;falseotherwise
readFromSource
protected Object readFromSource(Class<?> clazz, HttpHeaders headers, Source source) throws Exception
从类复制的说明:AbstractXmlHttpMessageConverterAbstract template method called fromAbstractHttpMessageConverter.read(Class, HttpInputMessage).- 指定者:
readFromSource在类中AbstractXmlHttpMessageConverter<Object>- 参数:
clazz- the type of object to returnheaders- the HTTP input headerssource- 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
从类复制的说明:AbstractXmlHttpMessageConverterAbstract template method called fromAbstractXmlHttpMessageConverter.writeInternal(Object, HttpOutputMessage).- 指定者:
writeToResult在类中AbstractXmlHttpMessageConverter<Object>- 参数:
o- the object to write to the output messageheaders- the HTTP output headersresult- the HTTP output body- 抛出:
Exception- in case of I/O or conversion errors