agi.foundation.graphics.imaging

(agi.foundation.graphics-2023r2.jar)

Class SequenceFilter

java.lang.Object

agi.foundation.graphics.imaging.RasterFilter

agi.foundation.graphics.imaging.SequenceFilter

All Implemented Interfaces:

IDisposable, AutoCloseable

public final class SequenceFilter
extends RasterFilter
implements IDisposable

Applies a sequence of filters to the source raster in the order in which they were added. When ContinueOnFailure is set to true, subsequent filters will still be applied to the source raster even if one or more filters in the sequence cannot be applied.

Constructor Summary

Constructors

Constructor and Description
SequenceFilter() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
void	add(RasterFilter filter) Adds a filter to the sequence.
void	clear() Clears all filters from the sequence.
boolean	contains(RasterFilter filter) Returns true if the sequence contains the filter.
protected void	dispose(boolean disposing)
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
boolean	getContinueOnFailure() Gets whether to continue applying filters in the sequence regardless of individual filter failures.
int	getCount() Gets the number of filters in the collection.
void	remove(RasterFilter filter) Removes a filter from the sequence.
void	setContinueOnFailure(boolean value) Sets whether to continue applying filters in the sequence regardless of individual filter failures.

Methods inherited from class agi.foundation.graphics.imaging.RasterFilter

dispose

Methods inherited from class java.lang.Object

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

Methods inherited from interface agi.foundation.compatibility.IDisposable

close, dispose

Constructor Detail

SequenceFilter

public SequenceFilter()

Initializes a new instance.

Method Detail

finalize

protected void finalize()
                 throws Throwable

Description copied from class: java.lang.Object

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java™ virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Overrides:

finalize in class Object

Throws:

Throwable - the Exception raised by this method

See Also:

WeakReference, PhantomReference

dispose

protected void dispose(boolean disposing)

Overrides:

dispose in class RasterFilter

getContinueOnFailure

public final boolean getContinueOnFailure()

Gets whether to continue applying filters in the sequence regardless of individual filter failures. When set to true, subsequent filters will still be applied to the source raster even if one or more filters in the sequence cannot be applied.

setContinueOnFailure

public final void setContinueOnFailure(boolean value)

Sets whether to continue applying filters in the sequence regardless of individual filter failures. When set to true, subsequent filters will still be applied to the source raster even if one or more filters in the sequence cannot be applied.

getCount

public final int getCount()

Gets the number of filters in the collection.

add

public final void add(RasterFilter filter)

Adds a filter to the sequence.

Parameters:

filter - The RasterFilter to add.

remove

public final void remove(RasterFilter filter)

Removes a filter from the sequence.

Parameters:

filter - The RasterFilter to remove.

clear

public final void clear()

Clears all filters from the sequence.

contains

public final boolean contains(RasterFilter filter)

Returns true if the sequence contains the filter.

Parameters:

filter - The RasterFilter to test.

Returns:

True if the sequence contains the filter.