javax.media.jai
Class AttributedImage

java.lang.Object
  |
  +--javax.media.jai.PlanarImage
        |
        +--javax.media.jai.RenderedImageAdapter
              |
              +--javax.media.jai.AttributedImage

All Implemented Interfaces:

ImageJAI, PropertyChangeEmitter, PropertySource, RenderedImage, WritablePropertySource

public class AttributedImage

extends RenderedImageAdapter

A class which associates a PlanarImage with an attribute of unspecified type. The class is itself a PlanarImage equivalent to the one which it wraps.

Since:

JAI 1.1

Field Summary

protected Object

attribute The attribute associated with the image.

Fields inherited from class javax.media.jai.RenderedImageAdapter

theImage

Fields inherited from class javax.media.jai.PlanarImage

colorModel, eventManager, height, minX, minY, properties, sampleModel, tileFactory, tileGridXOffset, tileGridYOffset, tileHeight, tileWidth, width

Constructor Summary

AttributedImage(PlanarImage image, Object attribute)
Constructs an AttributedImage.

Method Summary

boolean	equals(Object o) Tests for equality.
Object	getAttribute() Retrieves the attribute.
PlanarImage	getImage() Retrieves the wrapped image.
void	setAttribute(Object attribute) Stores the attribute.
String	toString() toString() method.

Methods inherited from class javax.media.jai.RenderedImageAdapter

copyData, getData, getData, getProperty, getPropertyClass, getPropertyNames, getTile, getWrappedImage

Methods inherited from class javax.media.jai.PlanarImage

addPropertyChangeListener, addPropertyChangeListener, addSink, addSink, addSource, addTileComputationListener, cancelTiles, copyData, copyExtendedData, createColorModel, createSnapshot, createWritableRaster, dispose, finalize, getAsBufferedImage, getAsBufferedImage, getBounds, getColorModel, getDefaultColorModel, getExtendedData, getGraphics, getHeight, getImageID, getMaxTileX, getMaxTileY, getMaxX, getMaxY, getMinTileX, getMinTileY, getMinX, getMinY, getNumBands, getNumSources, getNumXTiles, getNumYTiles, getProperties, getPropertyNames, getSampleModel, getSinks, getSource, getSourceImage, getSourceObject, getSources, getSplits, getTileComputationListeners, getTileFactory, getTileGridXOffset, getTileGridYOffset, getTileHeight, getTileIndices, getTileRect, getTiles, getTiles, getTileWidth, getWidth, overlapsMultipleTiles, prefetchTiles, queueTiles, removeProperty, removePropertyChangeListener, removePropertyChangeListener, removeSink, removeSink, removeSinks, removeSource, removeSources, removeTileComputationListener, setImageLayout, setProperties, setProperty, setSource, setSources, tileXToX, tileXToX, tileYToY, tileYToY, wrapRenderedImage, XToTileX, XToTileX, YToTileY, YToTileY

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

attribute

protected Object attribute

The attribute associated with the image.

Constructor Detail

AttributedImage

public AttributedImage(PlanarImage image,
                       Object attribute)

Constructs an AttributedImage. The attribute parameter may be null

Throws:

IllegalArgumentException - if theImage is null.

Method Detail

getImage

public PlanarImage getImage()

Retrieves the wrapped image.

setAttribute

public void setAttribute(Object attribute)

Stores the attribute.

getAttribute

public Object getAttribute()

Retrieves the attribute.

equals

public boolean equals(Object o)

Tests for equality. The parameter Object must be an AttributedImage the image and attribute of which are equal those of this object according to the equals() methods of the image and attribute of this image, respectively. Attributes are also considered equal if they are both null.

Overrides:

equals in class Object

toString

public String toString()

toString() method.

Overrides:

toString in class PlanarImage