Class ImageSourceOpBitmapImpl

java.lang.Object

VASSAL.tools.opcache.AbstractOpImpl<BufferedImage>

VASSAL.tools.imageop.AbstractOpImpl

VASSAL.tools.imageop.AbstractTiledOpImpl

VASSAL.tools.imageop.ImageSourceOpBitmapImpl

All Implemented Interfaces:

ImageOp, SourceOp, Op<BufferedImage>

public class ImageSourceOpBitmapImpl
extends AbstractTiledOpImpl
implements SourceOp

An ImageOp which uses a fixed image as its source. ImageSourceOp holds a reference to the Image it was constructed with in order to prevent it from being garbage collected from the soft cache, since this op has no way of recreating the source image.

Since:

3.1.0

Author:

Joel Uckelman

Field Summary

Fields inherited from class VASSAL.tools.imageop.AbstractTiledOpImpl

numXTiles, numYTiles, tiles, tileSize

Fields inherited from class VASSAL.tools.imageop.AbstractOpImpl

cache, size

Constructor Summary

Constructors

Constructor	Description
ImageSourceOpBitmapImpl(BufferedImage image)	Constructs an ImageOp which will hold and return the image it is constructed with.

Method Summary

Modifier and Type	Method	Description
protected ImageOp	createTileOp(int tileX, int tileY)
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().
String	getName()
List<Op<?>>	getSources()	Returns a list of Ops on which this Op depends.
int	hashCode()

Methods inherited from class VASSAL.tools.imageop.AbstractTiledOpImpl

fixTileSize, 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, toString, 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

Constructor Details

ImageSourceOpBitmapImpl

public ImageSourceOpBitmapImpl(BufferedImage image)

Constructs an ImageOp which will hold and return the image it is constructed with.

Parameters:

image - the source image

Throws:

IllegalArgumentException - if image == null.

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()

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

fixSize

protected void fixSize()

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

Specified by:

fixSize in class AbstractOpImpl

createTileOp

protected ImageOp createTileOp(int tileX,
 int tileY)

Specified by:

createTileOp in class AbstractTiledOpImpl

getName

public String getName()

Specified by:

getName in interface SourceOp

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object