Package net.coobird.thumbnailator.tasks.io

Class FileImageSource

java.lang.Object

net.coobird.thumbnailator.tasks.io.FileImageSource

All Implemented Interfaces:

ImageSource<java.io.File>

public class FileImageSource
extends java.lang.Object
implements ImageSource<java.io.File>

An ImageSource which reads the source image from a file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	FileImageSource.UninitializedImageSource	Temporary placeholder ImageSource which will be used before the FileImageSource.UninitializedImageSource.read() method is used.

Field Summary

Fields

Modifier and Type	Field	Description
private ImageSource<?>	imageSource	An ImageSource which actually performs the image source operations.
private ThumbnailParameter	param	A ThumbnailParameter object that is given by setThumbnailParameter(ThumbnailParameter).
private java.io.File	sourceFile	The file from which the image should be obtained.

Constructor Summary

Constructors

Constructor	Description
FileImageSource(java.io.File sourceFile)	Instantiates a FileImageSource with the specified file as the source image.
FileImageSource(java.lang.String sourceFilePath)	Instantiates a FileImageSource with the specified file as the source image.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getInputFormatName()	Returns the name of the image format.
java.io.File	getSource()	Returns the source file from which an image is read.
java.awt.image.BufferedImage	read()	Retrieves the image from the source.
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

Field Detail

sourceFile

private final java.io.File sourceFile

The file from which the image should be obtained.

imageSource

private ImageSource<?> imageSource

An ImageSource which actually performs the image source operations. This ImageSource can change during the lifecycle of the FileImageSource class.

param

private ThumbnailParameter param

A ThumbnailParameter object that is given by setThumbnailParameter(ThumbnailParameter). This copy is needed when the imageSource is being replacing during the lifecycle of this class.

Constructor Detail

FileImageSource

public FileImageSource(java.io.File sourceFile)

Instantiates a FileImageSource with the specified file as the source image.

Parameters:

sourceFile - The source image file.

Throws:

java.lang.NullPointerException - If the image is null.

FileImageSource

public FileImageSource(java.lang.String sourceFilePath)

Instantiates a FileImageSource with the specified file as the source image.

Parameters:

sourceFilePath - The filepath of the source image file.

Throws:

java.lang.NullPointerException - If the image is null.

Method Detail

read

public java.awt.image.BufferedImage read()
                                  throws java.io.IOException

Description copied from interface: ImageSource

Retrieves the image from the source.

Specified by:

read in interface ImageSource<java.io.File>

Returns:

The image.

Throws:

java.io.IOException - When a problem occurs while reading or obtaining the image.

getSource

public java.io.File getSource()

Returns the source file from which an image is read.

Specified by:

getSource in interface ImageSource<java.io.File>

Returns:

The File representation of the source file.

getInputFormatName

public java.lang.String getInputFormatName()

Description copied from interface: ImageSource

Returns the name of the image format.

Specified by:

getInputFormatName in interface ImageSource<java.io.File>

Returns:

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

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<java.io.File>

Parameters:

param - The ThumbnailParameter with image reading parameters.