Package VASSAL.tools.image

Class FileImageTypeConverter

java.lang.Object

VASSAL.tools.image.FileImageTypeConverter

All Implemented Interfaces:

ImageTypeConverter

public class FileImageTypeConverter
extends Object
implements ImageTypeConverter

Convert a BufferedImage to a different type by caching image data on disk.

Since:

3.2.0

Author:

Joel Uckelman

Field Summary

Fields

Modifier and Type	Field	Description
protected final TemporaryFileFactory	tfactory

Constructor Summary

Constructors

Constructor	Description
FileImageTypeConverter(TemporaryFileFactory tfactory)	Create a converter.

Method Summary

Modifier and Type	Method	Description
BufferedImage	convert(Reference<BufferedImage> ref, int type)	Converts an image to the given type.
protected void	read(InputStream in, BufferedImage dst)
protected void	write(BufferedImage src, OutputStream out)

Methods inherited from class java.lang.Object

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

Field Details

tfactory

protected final TemporaryFileFactory tfactory

Constructor Details

FileImageTypeConverter

public FileImageTypeConverter(TemporaryFileFactory tfactory)

Create a converter.

Parameters:

tfactory - the temporary file to use as a cache

Method Details

convert

public BufferedImage convert(Reference<BufferedImage> ref,
 int type)
                      throws ImageIOException

Converts an image to the given type. WARNING: When this method is called, the sole reference to the image must be the one held by ref in order to allow the source image to be garbage collected after the image data is written to disk.

Specified by:

convert in interface ImageTypeConverter

Parameters:

ref - a holder for the image

type - the type of image to return

Returns:

a converted image

Throws:

ImageIOException - if something goes wrong

write

protected void write(BufferedImage src,
 OutputStream out)
              throws IOException

Throws:

IOException

read

protected void read(InputStream in,
 BufferedImage dst)
             throws IOException

Throws:

IOException