Package VASSAL.tools.image

Class ImageIOImageLoader

java.lang.Object

VASSAL.tools.image.ImageIOImageLoader

All Implemented Interfaces:

ImageLoader

public class ImageIOImageLoader
extends Object
implements ImageLoader

An image loader which wraps ImageIO. This class handles the assorted problems with various versions of ImageIO, ensuring that we can reliably load image files to {link BufferedImages} with a predictable type.

Since:

3.1.0

Author:

Joel Uckelman

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	ImageIOImageLoader.Wrapper<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected static ImageIOImageLoader.Wrapper<BufferedImage>	readImage	A functor for reading images.
protected static ImageIOImageLoader.Wrapper<Dimension>	readSize	A functor for reading image dimensions.
protected ImageTypeConverter	tconv
protected static boolean	YCbCrBug

Constructor Summary

Constructors

Constructor	Description
ImageIOImageLoader(ImageTypeConverter tconv)	Create an image loader.

Method Summary

Modifier and Type	Method	Description
protected BufferedImage	fix_tRNS(Reference<BufferedImage> ref, int tRNS, int type)
protected BufferedImage	fix_YCbCr(Reference<BufferedImage> ref, int type)
BufferedImage	load(String name, InputStream in, int typeIfOpaque, int typeIfTransparent, boolean managed)	Loads an image.
Dimension	size(String name, InputStream in)	Gets the size of an image.
protected <T> T	wrapImageIO(String name, InputStream in, ImageIOImageLoader.Wrapper<T> w)

Methods inherited from class java.lang.Object

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

Field Details

tconv

protected final ImageTypeConverter tconv

YCbCrBug

protected static final boolean YCbCrBug

readImage

protected static final ImageIOImageLoader.Wrapper<BufferedImage> readImage

A functor for reading images.

readSize

protected static final ImageIOImageLoader.Wrapper<Dimension> readSize

A functor for reading image dimensions.

Constructor Details

ImageIOImageLoader

public ImageIOImageLoader(ImageTypeConverter tconv)

Create an image loader.

Parameters:

tconv - the ImageTypeConverter to use for type conversions

Method Details

load

public BufferedImage load(String name,
 InputStream in,
 int typeIfOpaque,
 int typeIfTransparent,
 boolean managed)
                   throws ImageIOException

Loads an image.

Specified by:

load in interface ImageLoader

Parameters:

name - the image name

in - the input stream

typeIfOpaque - the requested image type for opaque images

typeIfTransparent - the requested image type for transparent images

managed - true if a managed image should be returned

Returns:

the image

Throws:

BrokenImageException - if the image is faulty

UnrecognizedImageTypeException - if the image type is not recognized

ImageIOException - if reading the image goes wrong

wrapImageIO

protected <T> T wrapImageIO(String name,
 InputStream in,
 ImageIOImageLoader.Wrapper<T> w)
                     throws ImageIOException

Throws:

ImageIOException

fix_tRNS

protected BufferedImage fix_tRNS(Reference<BufferedImage> ref,
 int tRNS,
 int type)
                          throws ImageIOException

Throws:

ImageIOException

fix_YCbCr

protected BufferedImage fix_YCbCr(Reference<BufferedImage> ref,
 int type)
                           throws ImageIOException

Throws:

ImageIOException

size

public Dimension size(String name,
 InputStream in)
               throws ImageIOException

Gets the size of an image.

Specified by:

size in interface ImageLoader

Parameters:

name - the image name

in - the input stream

Returns:

the size of the image

Throws:

BrokenImageException - if the image is faulty

UnrecognizedImageTypeException - if the image type is not recognized

ImageIOException - if reading the image goes wrong