javax.media.jai.iterator
Class RandomIterFactory

java.lang.Object
  javax.media.jai.iterator.RandomIterFactory

public class RandomIterFactory

extends Object

A factory class to instantiate instances of the RandomIter and WritableRandomIter interfaces on sources of type Raster, RenderedImage, and WritableRenderedImage.

See Also:

RandomIter, WritableRandomIter

Method Summary

static RandomIter	create(Raster ras, Rectangle bounds) Constructs and returns an instance of RandomIter suitable for iterating over the given bounding rectangle within the given Raster source.
static RandomIter	create(RenderedImage im, Rectangle bounds) Constructs and returns an instance of RandomIter suitable for iterating over the given bounding rectangle within the given RenderedImage source.
static WritableRandomIter	createWritable(WritableRaster ras, Rectangle bounds) Constructs and returns an instance of WritableRandomIter suitable for iterating over the given bounding rectangle within the given WritableRaster source.
static WritableRandomIter	createWritable(WritableRenderedImage im, Rectangle bounds) Constructs and returns an instance of WritableRandomIter suitable for iterating over the given bounding rectangle within the given WritableRenderedImage source.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static RandomIter create(RenderedImage im,
                                Rectangle bounds)

Constructs and returns an instance of RandomIter suitable for iterating over the given bounding rectangle within the given RenderedImage source. If the bounds parameter is null, the entire image will be used.

Parameters:

im - a read-only RenderedImage source.

bounds - the bounding Rectangle for the iterator, or null.

Returns:

a RandomIter allowing read-only access to the source.

create

public static RandomIter create(Raster ras,
                                Rectangle bounds)

Constructs and returns an instance of RandomIter suitable for iterating over the given bounding rectangle within the given Raster source. If the bounds parameter is null, the entire Raster will be used.

Parameters:

ras - a read-only Raster source.

bounds - the bounding Rectangle for the iterator, or null.

Returns:

a RandomIter allowing read-only access to the source.

createWritable

public static WritableRandomIter createWritable(WritableRenderedImage im,
                                                Rectangle bounds)

Constructs and returns an instance of WritableRandomIter suitable for iterating over the given bounding rectangle within the given WritableRenderedImage source. If the bounds parameter is null, the entire image will be used.

Parameters:

im - a WritableRenderedImage source.

bounds - the bounding Rectangle for the iterator, or null.

Returns:

a WritableRandomIter allowing read/write access to the source.

createWritable

public static WritableRandomIter createWritable(WritableRaster ras,
                                                Rectangle bounds)

Constructs and returns an instance of WritableRandomIter suitable for iterating over the given bounding rectangle within the given WritableRaster source. If the bounds parameter is null, the entire Raster will be used.

Parameters:

ras - a WritableRaster source.

bounds - the bounding Rectangle for the iterator, or null.

Returns:

a WritableRandomIter allowing read/write access to the source.