Package net.coobird.thumbnailator.filters

Class Pipeline

java.lang.Object

net.coobird.thumbnailator.filters.Pipeline

All Implemented Interfaces:

ImageFilter

public final class Pipeline
extends java.lang.Object
implements ImageFilter

An ImageFilter which will apply multiple ImageFilters in a specific order.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<ImageFilter>	filtersToApply	A list of image filters to apply.
private java.util.List<ImageFilter>	unmodifiableFiltersToApply	An unmodifiable list of image filters to apply.

Constructor Summary

Constructors

Constructor	Description
Pipeline()	Instantiates a new Pipeline with no image filters to apply.
Pipeline(java.util.List<ImageFilter> filters)	Instantiates a new Pipeline with a list of ImageFilters to apply.
Pipeline(ImageFilter... filters)	Instantiates a new Pipeline with an array of ImageFilters to apply.

Method Summary

Modifier and Type	Method	Description
void	add(ImageFilter filter)	Adds an ImageFilter to the pipeline.
void	addAll(java.util.List<ImageFilter> filters)	Adds a List of ImageFilters to the pipeline.
void	addFirst(ImageFilter filter)	Adds an ImageFilter to the beginning of the pipeline.
java.awt.image.BufferedImage	apply(java.awt.image.BufferedImage img)	Applies a image filtering operation on an image.
java.util.List<ImageFilter>	getFilters()	Returns a list of ImageFilters which will be applied by this Pipeline.

Methods inherited from class java.lang.Object

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

Field Detail

filtersToApply

private final java.util.List<ImageFilter> filtersToApply

A list of image filters to apply.

unmodifiableFiltersToApply

private final java.util.List<ImageFilter> unmodifiableFiltersToApply

An unmodifiable list of image filters to apply. Used by the getFilters() method. This object is created by Collections.unmodifiableList which provides an unmodifiable view of the original list. Therefore, any changes to the original list will also be "visible" from this list as well.

Constructor Detail

Pipeline

public Pipeline()

Instantiates a new Pipeline with no image filters to apply.

Pipeline

public Pipeline(ImageFilter... filters)

Instantiates a new Pipeline with an array of ImageFilters to apply.

Parameters:

filters - An array of ImageFilters to apply.

Pipeline

public Pipeline(java.util.List<ImageFilter> filters)

Instantiates a new Pipeline with a list of ImageFilters to apply.

Parameters:

filters - A list of ImageFilters to apply.

Method Detail

add

public void add(ImageFilter filter)

Adds an ImageFilter to the pipeline.

Parameters:

filter - An ImageFilter.

addFirst

public void addFirst(ImageFilter filter)

Adds an ImageFilter to the beginning of the pipeline.

Parameters:

filter - An ImageFilter.

addAll

public void addAll(java.util.List<ImageFilter> filters)

Adds a List of ImageFilters to the pipeline.

Parameters:

filters - A list of filters to add to the pipeline.

getFilters

public java.util.List<ImageFilter> getFilters()

Returns a list of ImageFilters which will be applied by this Pipeline.

Returns:

A list of filters which are applied by this pipeline.

apply

public java.awt.image.BufferedImage apply(java.awt.image.BufferedImage img)

Description copied from interface: ImageFilter

Applies a image filtering operation on an image.

Specified by:

apply in interface ImageFilter

Parameters:

img - The image to apply the filtering on.

Returns:

The resulting image after applying this filter.