程序包 cn.taketoday.http.converter

类 ResourceRegionHttpMessageConverter

java.lang.Object

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

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

cn.taketoday.http.converter.ResourceRegionHttpMessageConverter

所有已实现的接口:

GenericHttpMessageConverter<Object>, HttpMessageConverter<Object>

public class ResourceRegionHttpMessageConverter
extends AbstractGenericHttpMessageConverter<Object>

Implementation of HttpMessageConverter that can write a single ResourceRegion or Collections of ResourceRegions.

从以下版本开始:

4.0

作者:

Brian Clozel, Juergen Hoeller, Sam Brannen

字段概要

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

logger

构造器概要

构造器

构造器	说明
ResourceRegionHttpMessageConverter()

方法概要

修饰符和类型	方法	说明
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	canRead(Type type, Class<?> contextClass, MediaType mediaType)	Indicates whether the given type can be read by this converter.
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.
boolean	canWrite(Type type, Class<?> clazz, MediaType mediaType)	Indicates whether the given class can be written by this converter.
protected MediaType	getDefaultContentType(Object object)	Returns the default content type for the given type.
private static void	print(OutputStream os, String buf)
private static void	println(OutputStream os)
Object	read(Type type, Class<?> contextClass, HttpInputMessage inputMessage)	Read an object of the given type form the given input message, and returns it.
protected cn.taketoday.core.io.ResourceRegion	readInternal(Class<?> clazz, HttpInputMessage inputMessage)	Abstract template method that reads the actual object.
protected void	writeInternal(Object object, Type type, HttpOutputMessage outputMessage)	Abstract template method that writes the actual body.
protected void	writeResourceRegion(cn.taketoday.core.io.ResourceRegion region, HttpOutputMessage outputMessage)
private void	writeResourceRegionCollection(Collection<cn.taketoday.core.io.ResourceRegion> resourceRegions, HttpOutputMessage outputMessage)

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

supports, write, writeInternal

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

addDefaultHeaders, canRead, canWrite, getContentLength, getDefaultCharset, 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, getSupportedMediaTypes, read, write

构造器详细资料

ResourceRegionHttpMessageConverter

public ResourceRegionHttpMessageConverter()

方法详细资料

getDefaultContentType

protected MediaType getDefaultContentType(Object object)

从类复制的说明: AbstractHttpMessageConverter

Returns the default content type for the given type. Called when AbstractHttpMessageConverter.write(T, cn.taketoday.http.MediaType, cn.taketoday.http.HttpOutputMessage) is invoked without a specified content type parameter.

By default, this returns the first element of the supportedMediaTypes property, if any. Can be overridden in subclasses.

覆盖:

getDefaultContentType 在类中 AbstractHttpMessageConverter<Object>

参数:

object - the type to return the content type for

返回:

the content type, or null if not known

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

canRead

public boolean canRead(Type type,
 @Nullable
 Class<?> contextClass,
 @Nullable
 MediaType mediaType)

从接口复制的说明: GenericHttpMessageConverter

Indicates whether the given type can be read by this converter. This method should perform the same checks than HttpMessageConverter.canRead(Class, MediaType) with additional ones related to the generic type.

指定者:

canRead 在接口中 GenericHttpMessageConverter<Object>

覆盖:

canRead 在类中 AbstractGenericHttpMessageConverter<Object>

参数:

type - the (potentially generic) type to test for readability

contextClass - a context class for the target type, for example a class in which the target type appears in a method signature (can be null)

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

read

public Object read(Type type,
 @Nullable
 Class<?> contextClass,
 HttpInputMessage inputMessage)
            throws IOException,
HttpMessageNotReadableException

从接口复制的说明: GenericHttpMessageConverter

Read an object of the given type form the given input message, and returns it.

参数:

type - the (potentially generic) type of object to return. This type must have previously been passed to the canRead method of this interface, which must have returned true.

contextClass - a context class for the target type, for example a class in which the target type appears in a method signature (can be null)

inputMessage - the HTTP input message to read from

返回:

the converted object

抛出:

IOException - in case of I/O errors

HttpMessageNotReadableException - in case of conversion errors

readInternal

protected cn.taketoday.core.io.ResourceRegion 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

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

canWrite

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

从接口复制的说明: GenericHttpMessageConverter

Indicates whether the given class can be written by this converter.

This method should perform the same checks than HttpMessageConverter.canWrite(Class, MediaType) with additional ones related to the generic type.

指定者:

canWrite 在接口中 GenericHttpMessageConverter<Object>

覆盖:

canWrite 在类中 AbstractGenericHttpMessageConverter<Object>

参数:

type - the (potentially generic) type to test for writability (can be null if not specified)

clazz - the source object 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

writeInternal

protected void writeInternal(Object object,
 @Nullable
 Type type,
 HttpOutputMessage outputMessage)
                      throws IOException,
HttpMessageNotWritableException

从类复制的说明: AbstractGenericHttpMessageConverter

Abstract template method that writes the actual body. Invoked from AbstractGenericHttpMessageConverter.write(T, java.lang.reflect.Type, cn.taketoday.http.MediaType, cn.taketoday.http.HttpOutputMessage).

指定者:

writeInternal 在类中 AbstractGenericHttpMessageConverter<Object>

参数:

object - the object to write to the output message

type - the type of object to write (may be null)

outputMessage - the HTTP output message to write to

抛出:

IOException - in case of I/O errors

HttpMessageNotWritableException - in case of conversion errors

writeResourceRegion

protected void writeResourceRegion(cn.taketoday.core.io.ResourceRegion region,
 HttpOutputMessage outputMessage)
                            throws IOException

抛出:

IOException

writeResourceRegionCollection

private void writeResourceRegionCollection(Collection<cn.taketoday.core.io.ResourceRegion> resourceRegions,
 HttpOutputMessage outputMessage)
                                    throws IOException

抛出:

IOException

println

private static void println(OutputStream os)
                     throws IOException

抛出:

IOException

print

private static void print(OutputStream os,
 String buf)
                   throws IOException

抛出:

IOException