程序包 cn.taketoday.http.converter

类 ObjectToStringHttpMessageConverter

java.lang.Object

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

cn.taketoday.http.converter.ObjectToStringHttpMessageConverter

所有已实现的接口:

HttpMessageConverter<Object>

public class ObjectToStringHttpMessageConverter
extends AbstractHttpMessageConverter<Object>

An HttpMessageConverter that uses StringHttpMessageConverter for reading and writing content and a ConversionService for converting the String content to and from the target object type.

By default, this converter supports the media type text/plain only. This can be overridden through the supportedMediaTypes property.

A usage example:

 <bean class="cn.taketoday.http.converter.ObjectToStringHttpMessageConverter">
   <constructor-arg>
     <bean class="cn.taketoday.context.support.ConversionServiceFactoryBean"/>
   </constructor-arg>
 </bean>
 

从以下版本开始:

4.0

作者:

Dmitry Katsubo, Rossen Stoyanchev

字段概要

字段

修饰符和类型	字段	说明
private final cn.taketoday.core.conversion.ConversionService	conversionService
private final StringHttpMessageConverter	stringHttpMessageConverter

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

logger

构造器概要

构造器

构造器	说明
ObjectToStringHttpMessageConverter(cn.taketoday.core.conversion.ConversionService conversionService)	A constructor accepting a ConversionService to use to convert the (String) message body to/from the target class type.
ObjectToStringHttpMessageConverter(cn.taketoday.core.conversion.ConversionService conversionService, Charset defaultCharset)	A constructor accepting a ConversionService as well as a default charset.

方法概要

修饰符和类型	方法	说明
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 Long	getContentLength(Object obj, MediaType contentType)	Returns the content length for the given type.
protected Object	readInternal(Class<?> clazz, HttpInputMessage inputMessage)	Abstract template method that reads the actual object.
void	setWriteAcceptCharset(boolean writeAcceptCharset)	Delegates to StringHttpMessageConverter.setWriteAcceptCharset(boolean).
protected boolean	supports(Class<?> clazz)	Indicates whether the given class is supported by this converter.
protected void	writeInternal(Object obj, HttpOutputMessage outputMessage)	Abstract template method that writes the actual body.

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

addDefaultHeaders, canRead, canWrite, 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

字段详细资料

conversionService

private final cn.taketoday.core.conversion.ConversionService conversionService

stringHttpMessageConverter

private final StringHttpMessageConverter stringHttpMessageConverter

构造器详细资料

ObjectToStringHttpMessageConverter

public ObjectToStringHttpMessageConverter(cn.taketoday.core.conversion.ConversionService conversionService)

A constructor accepting a ConversionService to use to convert the (String) message body to/from the target class type. This constructor uses Constant.DEFAULT_CHARSET as the default charset.

参数:

conversionService - the conversion service

ObjectToStringHttpMessageConverter

public ObjectToStringHttpMessageConverter(cn.taketoday.core.conversion.ConversionService conversionService,
 Charset defaultCharset)

A constructor accepting a ConversionService as well as a default charset.

参数:

conversionService - the conversion service

defaultCharset - the default charset

方法详细资料

setWriteAcceptCharset

public void setWriteAcceptCharset(boolean writeAcceptCharset)

Delegates to StringHttpMessageConverter.setWriteAcceptCharset(boolean).

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

readInternal

protected Object readInternal(Class<?> clazz,
 HttpInputMessage inputMessage)
                       throws IOException,
HttpMessageNotReadableException

从类复制的说明: AbstractHttpMessageConverter

Abstract template method that reads the actual object. Invoked from AbstractHttpMessageConverter.read(java.lang.Class<? extends T>, cn.taketoday.http.HttpInputMessage).

指定者:

readInternal 在类中 AbstractHttpMessageConverter<Object>

参数:

clazz - the type of object to return

inputMessage - the HTTP input message to read from

返回:

the converted object

抛出:

IOException - in case of I/O errors

HttpMessageNotReadableException - in case of conversion errors

writeInternal

protected void writeInternal(Object obj,
 HttpOutputMessage outputMessage)
                      throws IOException

从类复制的说明: AbstractHttpMessageConverter

Abstract template method that writes the actual body. Invoked from AbstractHttpMessageConverter.write(T, cn.taketoday.http.MediaType, cn.taketoday.http.HttpOutputMessage).

指定者:

writeInternal 在类中 AbstractHttpMessageConverter<Object>

参数:

obj - the object to write to the output message

outputMessage - the HTTP output message to write to

抛出:

IOException - in case of I/O errors

getContentLength

protected Long getContentLength(Object obj,
 @Nullable
 MediaType contentType)

从类复制的说明: AbstractHttpMessageConverter

Returns the content length for the given type.

By default, this returns null, meaning that the content length is unknown. Can be overridden in subclasses.

覆盖:

getContentLength 在类中 AbstractHttpMessageConverter<Object>

参数:

obj - the type to return the content length for

返回:

the content length, or null if not known