Class SourceOpDiskCacheBitmapImpl

java.lang.Object

VASSAL.tools.opcache.AbstractOpImpl<BufferedImage>

VASSAL.tools.imageop.AbstractOpImpl

VASSAL.tools.imageop.AbstractTileOpImpl

VASSAL.tools.imageop.SourceOpDiskCacheBitmapImpl

All Implemented Interfaces:

ImageOp, SourceOp, Op<BufferedImage>

public class SourceOpDiskCacheBitmapImpl
extends AbstractTileOpImpl
implements SourceOp

An ImageOp which loads tiles from the tile cache.

Since:

3.2.0

Author:

Joel Uckelman

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	hash	The cached hash code of this object.
protected final String	name	The name of the image file.
protected double	scale
protected final ImageTileSource	tileSrc
protected final int	tileX
protected final int	tileY

Fields inherited from class VASSAL.tools.imageop.AbstractOpImpl

cache, size

Constructor Summary

Constructors

Constructor	Description
SourceOpDiskCacheBitmapImpl(String name, int tileX, int tileY, double scale)	Constructs an ImageOp which will load the given file.
SourceOpDiskCacheBitmapImpl(String name, int tileX, int tileY, double scale, ImageTileSource tileSrc)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BufferedImage	eval()	Runs the Op.
protected void	fixSize()	Sets the size which is used by AbstractOpImpl.getSize(), AbstractOpImpl.getHeight(), and AbstractOpImpl.getWidth().
protected Dimension	getImageSize()
String	getName()	Returns the name of the image which AbstractOpImpl.getImage() will produce.
List<Op<?>>	getSources()	Returns a list of Ops on which this Op depends.
int	hashCode()
String	toString()

Methods inherited from class VASSAL.tools.imageop.AbstractTileOpImpl

getFutureTile, getNumXTiles, getNumYTiles, getTile, getTileHeight, getTileIndices, getTileOp, getTileSize, getTileWidth

Methods inherited from class VASSAL.tools.imageop.AbstractOpImpl

clearCache, getFutureImage, getFutureTile, getHeight, getImage, getImage, getSize, getSizeFromCache, getTile, getTileOp, getWidth

Methods inherited from class VASSAL.tools.opcache.AbstractOpImpl

get, get, getFuture, newKey, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface VASSAL.tools.imageop.ImageOp

getFutureImage, getFutureTile, getFutureTile, getHeight, getImage, getImage, getNumXTiles, getNumYTiles, getSize, getTile, getTile, getTileHeight, getTileIndices, getTileOp, getTileOp, getTileSize, getTileWidth, getWidth

Methods inherited from interface VASSAL.tools.opcache.Op

newKey, update

Field Details

name

protected final String name

The name of the image file.

hash

protected final int hash

The cached hash code of this object.

tileX

protected final int tileX

tileY

protected final int tileY

scale

protected double scale

tileSrc

protected final ImageTileSource tileSrc

Constructor Details

SourceOpDiskCacheBitmapImpl

public SourceOpDiskCacheBitmapImpl(String name,
 int tileX,
 int tileY,
 double scale)

Constructs an ImageOp which will load the given file.

Parameters:

name - the name of the image to load

Throws:

IllegalArgumentException - if name is null.

SourceOpDiskCacheBitmapImpl

public SourceOpDiskCacheBitmapImpl(String name,
 int tileX,
 int tileY,
 double scale,
 ImageTileSource tileSrc)

Method Details

getSources

public List<Op<?>> getSources()

Description copied from class: AbstractOpImpl

Returns a list of Ops on which this Op depends.

Specified by:

getSources in interface Op<BufferedImage>

Specified by:

getSources in class AbstractOpImpl<BufferedImage>

Returns:

the Ops on which this Op depends

eval

public BufferedImage eval()
                   throws ImageIOException

Runs the Op. This method should be called only by the caching framework.

Specified by:

eval in interface ImageOp

Specified by:

eval in interface Op<BufferedImage>

Specified by:

eval in class AbstractOpImpl

Returns:

the result of running this Op

Throws:

IOException - if the image cannot be loaded from the image file.

ImageIOException

fixSize

protected void fixSize()

Sets the size which is used by AbstractOpImpl.getSize(), AbstractOpImpl.getHeight(), and AbstractOpImpl.getWidth().

Specified by:

fixSize in class AbstractOpImpl

getImageSize

protected Dimension getImageSize()

getName

public String getName()

Returns the name of the image which AbstractOpImpl.getImage() will produce.

Specified by:

getName in interface SourceOp

Returns:

the name of the image in the DataArchive.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object