Package net.coobird.thumbnailator.tasks.io

Class AbstractImageSource<T>

java.lang.Object

net.coobird.thumbnailator.tasks.io.AbstractImageSource<T>

All Implemented Interfaces:

ImageSource<T>

Direct Known Subclasses:

BufferedImageSource, FileImageSource.UninitializedImageSource, InputStreamImageSource, URLImageSource

public abstract class AbstractImageSource<T>
extends java.lang.Object
implements ImageSource<T>

An abstract class for ImageSources.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	hasReadInput	Indicates whether the input has already been read.
protected java.lang.String	inputFormatName	The image format of the input image.
protected ThumbnailParameter	param	The parameters that should be used when retrieving the image.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractImageSource()	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected <V> V	finishedReading(V returnValue)	Indicates that the ImageSource has completed reading the input file, and returns the value given in the argument.
java.lang.String	getInputFormatName()	Returns the name of the image format.
void	setThumbnailParameter(ThumbnailParameter param)	Sets the ThumbnailParameter from which to retrieve parameters to use when retrieving the image.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.coobird.thumbnailator.tasks.io.ImageSource

getSource, read

Field Detail

inputFormatName

protected java.lang.String inputFormatName

The image format of the input image.

param

protected ThumbnailParameter param

The parameters that should be used when retrieving the image.

hasReadInput

protected boolean hasReadInput

Indicates whether the input has already been read.

Constructor Detail

AbstractImageSource

protected AbstractImageSource()

Default constructor.

Method Detail

finishedReading

protected <V> V finishedReading(V returnValue)

Indicates that the ImageSource has completed reading the input file, and returns the value given in the argument.

This method should be used by implementation classes when returning the result of the ImageSource.read() method, as shown in the following example code:

return finishedReading(sourceImage);

Type Parameters:

V - The return value type.

Parameters:

returnValue - The return value of the ImageSource.read() method.

Returns:

The return value of the ImageSource.read() method.

setThumbnailParameter

public void setThumbnailParameter(ThumbnailParameter param)

Description copied from interface: ImageSource

Sets the ThumbnailParameter from which to retrieve parameters to use when retrieving the image.

Specified by:

setThumbnailParameter in interface ImageSource<T>

Parameters:

param - The ThumbnailParameter with image reading parameters.

getInputFormatName

public java.lang.String getInputFormatName()

Description copied from interface: ImageSource

Returns the name of the image format.

Specified by:

getInputFormatName in interface ImageSource<T>

Returns:

The image format name. If there is no image format information, then null will be returned.