程序包 cn.taketoday.http.converter

类 BufferedImageHttpMessageConverter

java.lang.Object

cn.taketoday.http.converter.BufferedImageHttpMessageConverter

所有已实现的接口:

HttpMessageConverter<BufferedImage>

public class BufferedImageHttpMessageConverter
extends Object
implements HttpMessageConverter<BufferedImage>

Implementation of HttpMessageConverter that can read and write BufferedImages.

By default, this converter can read all media types that are supported by the registered image readers, and writes using the media type of the first available registered image writer. The latter can be overridden by setting the defaultContentType property.

If the cacheDir property is set, this converter will cache image data.

The process(ImageReadParam) and process(ImageWriteParam) template methods allow subclasses to override Image I/O parameters.

从以下版本开始:

4.0

作者:

Arjen Poutsma

字段概要

字段

修饰符和类型	字段	说明
private File	cacheDir
private MediaType	defaultContentType
private final ArrayList<MediaType>	readableMediaTypes

构造器概要

构造器

构造器	说明
BufferedImageHttpMessageConverter()

方法概要

修饰符和类型	方法	说明
boolean	canRead(Class<?> clazz, MediaType mediaType)	Indicates whether the given class can be read by this converter.
boolean	canWrite(Class<?> clazz, MediaType mediaType)	Indicates whether the given class can be written by this converter.
private ImageInputStream	createImageInputStream(InputStream is)
private ImageOutputStream	createImageOutputStream(OutputStream os)
private MediaType	getContentType(MediaType contentType)
MediaType	getDefaultContentType()	Returns the default Content-Type to be used for writing.
List<MediaType>	getSupportedMediaTypes()	Return the list of media types supported by this converter.
private boolean	isReadable(MediaType mediaType)
private boolean	isWritable(MediaType mediaType)
protected void	process(ImageReadParam irp)	Template method that allows for manipulating the ImageReadParam before it is used to read an image.
protected void	process(ImageWriteParam iwp)	Template method that allows for manipulating the ImageWriteParam before it is used to write an image.
BufferedImage	read(Class<? extends BufferedImage> clazz, HttpInputMessage inputMessage)	Read an object of the given type from the given input message, and returns it.
void	setCacheDir(File cacheDir)	Sets the cache directory.
void	setDefaultContentType(MediaType defaultContentType)	Sets the default Content-Type to be used for writing.
void	write(BufferedImage image, MediaType contentType, HttpOutputMessage outputMessage)	Write an given object to the given output message.
private void	writeInternal(BufferedImage image, MediaType contentType, OutputStream body)

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

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

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

getSupportedMediaTypes

字段详细资料

readableMediaTypes

private final ArrayList<MediaType> readableMediaTypes

cacheDir

@Nullable
private File cacheDir

defaultContentType

@Nullable
private MediaType defaultContentType

构造器详细资料

BufferedImageHttpMessageConverter

public BufferedImageHttpMessageConverter()

方法详细资料

setDefaultContentType

public void setDefaultContentType(@Nullable
 MediaType defaultContentType)

Sets the default Content-Type to be used for writing.

抛出:

IllegalArgumentException - if the given content type is not supported by the Java Image I/O API

getDefaultContentType

@Nullable
public MediaType getDefaultContentType()

Returns the default Content-Type to be used for writing. Called when write(java.awt.image.BufferedImage, cn.taketoday.http.MediaType, cn.taketoday.http.HttpOutputMessage) is invoked without a specified content type parameter.

setCacheDir

public void setCacheDir(File cacheDir)

Sets the cache directory. If this property is set to an existing directory, this converter will cache image data.

canRead

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

从接口复制的说明: HttpMessageConverter

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

指定者:

canRead 在接口中 HttpMessageConverter<BufferedImage>

参数:

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

isReadable

private boolean isReadable(@Nullable
 MediaType mediaType)

canWrite

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

从接口复制的说明: HttpMessageConverter

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

指定者:

canWrite 在接口中 HttpMessageConverter<BufferedImage>

参数:

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

isWritable

private boolean isWritable(@Nullable
 MediaType mediaType)

getSupportedMediaTypes

public List<MediaType> getSupportedMediaTypes()

从接口复制的说明: HttpMessageConverter

Return the list of media types supported by this converter. The list may not apply to every possible target element type and calls to this method should typically be guarded via canWrite(clazz, null. The list may also exclude MIME types supported only for a specific class. Alternatively, use HttpMessageConverter.getSupportedMediaTypes(Class) for a more precise list.

指定者:

getSupportedMediaTypes 在接口中 HttpMessageConverter<BufferedImage>

返回:

the list of supported media types

read

public BufferedImage read(@Nullable
 Class<? extends BufferedImage> clazz,
 HttpInputMessage inputMessage)
                   throws IOException,
HttpMessageNotReadableException

从接口复制的说明: HttpMessageConverter

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

指定者:

read 在接口中 HttpMessageConverter<BufferedImage>

参数:

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

inputMessage - the HTTP input message to read from

返回:

the converted object

抛出:

IOException - in case of I/O errors

HttpMessageNotReadableException - in case of conversion errors

createImageInputStream

private ImageInputStream createImageInputStream(InputStream is)
                                         throws IOException

抛出:

IOException

write

public void write(BufferedImage image,
 @Nullable
 MediaType contentType,
 HttpOutputMessage outputMessage)
           throws IOException,
HttpMessageNotWritableException

从接口复制的说明: HttpMessageConverter

Write an given object to the given output message.

指定者:

write 在接口中 HttpMessageConverter<BufferedImage>

参数:

image - the object to write to the output message. The type of this object must have previously been passed to the canWrite method of this interface, which must have returned true.

contentType - the content type to use when writing. May be null to indicate that the default content type of the converter must be used. If not null, this media type must have previously been passed to the canWrite method of this interface, which must have returned true.

outputMessage - the message to write to

抛出:

IOException - in case of I/O errors

HttpMessageNotWritableException - in case of conversion errors

getContentType

private MediaType getContentType(@Nullable
 MediaType contentType)

writeInternal

private void writeInternal(BufferedImage image,
 MediaType contentType,
 OutputStream body)
                    throws IOException,
HttpMessageNotWritableException

抛出:

IOException

HttpMessageNotWritableException

createImageOutputStream

private ImageOutputStream createImageOutputStream(OutputStream os)
                                           throws IOException

抛出:

IOException

process

protected void process(ImageReadParam irp)

Template method that allows for manipulating the ImageReadParam before it is used to read an image.

The default implementation is empty.

process

protected void process(ImageWriteParam iwp)

Template method that allows for manipulating the ImageWriteParam before it is used to write an image.

The default implementation is empty.