Package VASSAL.tools.imageop

Class SourceOpBitmapImpl

java.lang.Object

VASSAL.tools.opcache.AbstractOpImpl<BufferedImage>

VASSAL.tools.imageop.AbstractOpImpl

VASSAL.tools.imageop.AbstractTiledOpImpl

VASSAL.tools.imageop.SourceOpBitmapImpl

All Implemented Interfaces:

ImageOp, SourceOp, Op<BufferedImage>

Direct Known Subclasses:

SourceOpTiledBitmapImpl

public class SourceOpBitmapImpl
extends AbstractTiledOpImpl
implements SourceOp

An ImageOp which loads an image from the DataArchive.

Since:

3.1.0

Author:

Joel Uckelman

Field Summary

Fields

Modifier and Type	Field	Description
protected DataArchive	darch	The archive file from which the image will be loaded
protected FileArchive	farch
protected int	hash	The cached hash code of this object.
protected String	name	The name of the image file.

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

Modifier	Constructor	Description
	SourceOpBitmapImpl(String name)	Constructs an ImageOp which will load the given file.
	SourceOpBitmapImpl(String name, DataArchive archive)
protected	SourceOpBitmapImpl(String name, DataArchive da, FileArchive fa)
	SourceOpBitmapImpl(String name, FileArchive archive)

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().	protected Dimension
getImageSize()		protected InputStream
getInputStream()		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.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, 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.

darch

protected final DataArchive darch

The archive file from which the image will be loaded

farch

protected final FileArchive farch

Constructor Details

SourceOpBitmapImpl

public SourceOpBitmapImpl(String name)

Constructs an ImageOp which will load the given file.

Parameters:

name - the name of the image to load

Throws:

IllegalArgumentException - if name is null.

SourceOpBitmapImpl

public SourceOpBitmapImpl(String name,
 DataArchive archive)

SourceOpBitmapImpl

public SourceOpBitmapImpl(String name,
 FileArchive archive)

SourceOpBitmapImpl

protected SourceOpBitmapImpl(String name,
 DataArchive da,
 FileArchive fa)

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

getInputStream

protected InputStream getInputStream()
                              throws IOException

Throws:

IOException

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

createTileOp

protected ImageOp createTileOp(int tileX,
 int tileY)

Specified by:

createTileOp in class AbstractTiledOpImpl

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