com.sdl.context.image

Class ImageFactory

java.lang.Object

com.sdl.context.image.ImageFactory

All Implemented Interfaces:

UriImageFactory, ResourceFactory<UriImage>

@Component
public class ImageFactory
extends Object
implements UriImageFactory

Factory for creating images.

Constructor Summary

Constructors

Constructor and Description
ImageFactory()

Method Summary

Modifier and Type	Method and Description
UriImage	create(String uriAsString) Create a UriImage from a URI as a string.
UriImage	create(String uriAsString, String extension) Create a UriImage from a URI as a string which has a known image extension (specifying the extension means that we don't need to look it up).
UriImage	create(URL url) Create a UriImage from a URL.
protected UriImage	create(URL url, String extension) Create a UriImage from a URL with a known extension (so we don't have to look it up).
FileImage	createFileImage(File imageFile) Create a FileImage from a File.
protected FileImage	createFileImage(File imageFile, String extension) Create a FileImage from a File which has a known extension (so we don't have to look it up).
FileImage	createFileImage(String imagePath) Create a FileImage from a file path.
protected FileImage	createFileImage(String imagePath, String extension) Create a FileImage from a file path which has a known extension (so we don't have to look it up).
TransformedImage	createTransformedImage(BufferedImage bufferedImage, String outputFormat) Create a transformed image (of the desired format) from a bufferedImage.
TransformedImage	createTransformedImage(Image image) Create a transformed image (of the desired format) from an Image.
TransformedImage	createTransformedImage(Image image, String extension) Create a transformed image (of the desired format) from an Image.
protected UrlImage	createUrlImage(URL url, String extension)

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageFactory

public ImageFactory()

Method Detail

create

public UriImage create(String uriAsString)
                throws URISyntaxException,
                       IOException

Create a UriImage from a URI as a string.

Specified by:

create in interface ResourceFactory<UriImage>

Parameters:

uriAsString - the URL as a string, e.g. "http://localhost:8080/images/mygif.gif"

Returns:

the UrlImage

Throws:

URISyntaxException

IOException

create

public UriImage create(String uriAsString,
                       String extension)
                throws URISyntaxException,
                       IOException

Create a UriImage from a URI as a string which has a known image extension (specifying the extension means that we don't need to look it up).

Specified by:

create in interface ResourceFactory<UriImage>

Parameters:

uriAsString - the URL as a string, e.g. "http://localhost:8080/images/mypng.png"

extension - the image extension e.g. "png"

Returns:

the UrlImage

Throws:

URISyntaxException

IOException

createTransformedImage

public TransformedImage createTransformedImage(BufferedImage bufferedImage,
                                               String outputFormat)

Create a transformed image (of the desired format) from a bufferedImage.

Parameters:

bufferedImage - a buffered image

outputFormat - the output format required e.g. "png"

Returns:

the transformed image

createTransformedImage

public TransformedImage createTransformedImage(Image image)
                                        throws IOException

Create a transformed image (of the desired format) from an Image.

Parameters:

image - an image

Returns:

the transformed image

Throws:

IOException

createTransformedImage

public TransformedImage createTransformedImage(Image image,
                                               String extension)
                                        throws IOException

Create a transformed image (of the desired format) from an Image.

Parameters:

image - an image

extension - the output format required e.g. "png"

Returns:

the transformed image

Throws:

IOException

create

public UriImage create(URL url)
                throws URISyntaxException,
                       IOException

Create a UriImage from a URL.

Specified by:

create in interface UriImageFactory

Parameters:

url - the URL

Returns:

the UriImage

Throws:

URISyntaxException

IOException

createFileImage

public FileImage createFileImage(String imagePath)
                          throws IOException

Create a FileImage from a file path.

Parameters:

imagePath - the path of a file which contains an image, e.g. cwd-image-extension/target/test-classes/pictures/snow.jpg

Returns:

the FileImage

Throws:

IOException

createFileImage

public FileImage createFileImage(File imageFile)
                          throws IOException

Create a FileImage from a File.

Parameters:

imageFile - the File which contains an image

Returns:

the FileImage

Throws:

IOException

create

protected UriImage create(URL url,
                          String extension)
                   throws URISyntaxException,
                          IOException

Create a UriImage from a URL with a known extension (so we don't have to look it up).

Parameters:

url - the URL

extension - the image extension e.g. "png"

Returns:

the UriImage

Throws:

URISyntaxException

IOException

createFileImage

protected FileImage createFileImage(String imagePath,
                                    String extension)
                             throws IOException

Create a FileImage from a file path which has a known extension (so we don't have to look it up).

Parameters:

imagePath - the path of a file which contains an image, e.g. cwd-image-extension/target/test-classes/pictures/snow.jpg

extension - the image extension e.g. "png"

Returns:

the FileImage

Throws:

IOException

createFileImage

protected FileImage createFileImage(File imageFile,
                                    String extension)
                             throws IOException

Create a FileImage from a File which has a known extension (so we don't have to look it up).

Parameters:

imageFile - the File which contains an image

extension - the image extension e.g. "png"

Returns:

the FileImage

Throws:

IOException

createUrlImage

protected UrlImage createUrlImage(URL url,
                                  String extension)
                           throws URISyntaxException,
                                  IOException

Throws:

URISyntaxException

IOException