public class

BufferedImageFilter

extends ImageFilter
implements Cloneable

java.lang.Object
↳	java.awt.image.ImageFilter
	↳	java.awt.image.BufferedImageFilter

Class Overview

The BufferedImageFilter class subclasses an ImageFilter to provide a simple means of using a single-source/single-destination image operator (BufferedImageOp) to filter a BufferedImage in the Image Producer/Consumer/Observer paradigm. Examples of these image operators are: ConvolveOp, AffineTransformOp and LookupOp.

Summary

[Expand]

Inherited Constants

From interface java.awt.image.ImageConsumer

[Expand]

Inherited Fields

From class java.awt.image.ImageFilter

Public Constructors
	BufferedImageFilter(BufferedImageOp op) Constructs a `BufferedImageFilter` with the specified single-source/single-destination operator.

Public Methods
BufferedImageOp	getBufferedImageOp() Returns the `BufferedImageOp`.
void	imageComplete(int status) Filters the information provided in the `imageComplete` method of the `ImageConsumer` interface.
void	setColorModel(ColorModel model) Filters the information provided in the `setColorModel` method of the `ImageConsumer` interface.
void	setDimensions(int width, int height) Filters the information provided in the `setDimensions` method of the `ImageConsumer` interface.
void	setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) Filters the information provided in the `setPixels` method of the `ImageConsumer` interface which takes an array of integers.
void	setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) Filters the information provided in the `setPixels` method of the `ImageConsumer` interface which takes an array of bytes.

[Expand]

Inherited Methods

From class java.awt.image.ImageFilter

Object	clone() Clones this object.
ImageFilter	getFilterInstance(ImageConsumer ic) Returns a unique instance of an ImageFilter object which will actually perform the filtering for the specified ImageConsumer.
void	imageComplete(int status) Filters the information provided in the imageComplete method of the ImageConsumer interface.
void	resendTopDownLeftRight(ImageProducer ip) Responds to a request for a TopDownLeftRight (TDLR) ordered resend of the pixel data from an `ImageConsumer`.
void	setColorModel(ColorModel model) Filter the information provided in the setColorModel method of the ImageConsumer interface.
void	setDimensions(int width, int height) Filters the information provided in the setDimensions method of the ImageConsumer interface.
void	setHints(int hints) Filters the information provided in the setHints method of the ImageConsumer interface.
void	setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of integers.
void	setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of bytes.
void	setProperties(Hashtable<?, ?> props) Passes the properties from the source object along after adding a property indicating the stream of filters it has been run through.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.image.ImageConsumer

abstract void	imageComplete(int status) The imageComplete method is called when the ImageProducer is finished delivering all of the pixels that the source image contains, or when a single frame of a multi-frame animation has been completed, or when an error in loading or producing the image has occured.
abstract void	setColorModel(ColorModel model) Sets the ColorModel object used for the majority of the pixels reported using the setPixels method calls.
abstract void	setDimensions(int width, int height) The dimensions of the source image are reported using the setDimensions method call.
abstract void	setHints(int hintflags) Sets the hints that the ImageConsumer uses to process the pixels delivered by the ImageProducer.
abstract void	setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize) The pixels of the image are delivered using one or more calls to the setPixels method.
abstract void	setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize) Delivers the pixels of the image with one or more calls to this method.
abstract void	setProperties(Hashtable<?, ?> props) Sets the extensible list of properties associated with this image.

Public Constructors

public BufferedImageFilter (BufferedImageOp op)

Constructs a BufferedImageFilter with the specified single-source/single-destination operator.

Parameters

op	the specified `BufferedImageOp` to use to filter a `BufferedImage`

Throws

NullPointerException	if op is null

Public Methods

public BufferedImageOp getBufferedImageOp ()

Returns the BufferedImageOp.

Returns

the operator of this BufferedImageFilter.

public void imageComplete (int status)

Filters the information provided in the imageComplete method of the ImageConsumer interface.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Parameters

status	the status of image loading

Throws

ImagingOpException	if there was a problem calling the filter method of the `BufferedImageOp` associated with this instance.

public void setColorModel (ColorModel model)

Filters the information provided in the setColorModel method of the ImageConsumer interface.

If model is null, this method clears the current ColorModel of this BufferedImageFilter.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Parameters

model	the `ColorModel` to which to set the `ColorModel` of this `BufferedImageFilter`

public void setDimensions (int width, int height)

Filters the information provided in the setDimensions method of the ImageConsumer interface.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Parameters

width	the width to which to set the width of this `BufferedImageFilter`
height	the height to which to set the height of this `BufferedImageFilter`

public void setPixels (int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize)

Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of integers.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Parameters

x	the X coordinate of the upper-left corner of the area of pixels to be set
y	the Y coordinate of the upper-left corner of the area of pixels to be set
w	the width of the area of pixels
h	the height of the area of pixels
model	the specified `ColorModel`
pixels	the array of pixels
off	the offset into the `pixels` array
scansize	the distance from one row of pixels to the next in the `pixels` array

Throws

IllegalArgumentException	if width or height are less than zero.

public void setPixels (int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize)

Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of bytes.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Parameters

x	the X coordinate of the upper-left corner of the area of pixels to be set
y	the Y coordinate of the upper-left corner of the area of pixels to be set
w	the width of the area of pixels
h	the height of the area of pixels
model	the specified `ColorModel`
pixels	the array of pixels
off	the offset into the `pixels` array
scansize	the distance from one row of pixels to the next in the `pixels` array

Throws

IllegalArgumentException	if width or height are less than zero.

Interfaces

Classes

Exceptions

BufferedImageFilter

Class Overview

See Also

Summary

Public Constructors

public BufferedImageFilter (BufferedImageOp op)

Parameters

Throws

Public Methods

public BufferedImageOp getBufferedImageOp ()

Returns

public void imageComplete (int status)

Parameters

Throws

See Also

public void setColorModel (ColorModel model)

Parameters

See Also

public void setDimensions (int width, int height)

Parameters

See Also

public void setPixels (int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize)

Parameters

Throws

See Also

public void setPixels (int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize)

Parameters

Throws

See Also