com.sdl.context.image

Class FileImage

java.lang.Object

com.sdl.context.image.AbstractImage

com.sdl.context.image.FileImage

All Implemented Interfaces:

Image, UriImage, FileResource, Resource, UriResource, Serializable

public class FileImage
extends AbstractImage
implements UriImage, FileResource

Image based on a local file.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileImage(File imageFile) Create a FileImage from a File, this method is protected to force use of the ImageFactory.
protected	FileImage(String imagePath) Create a FileImage from a file path, this method is protected to force use of the ImageFactory.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Return the resource as a byte array.
ByteString	getByteString() Return the resource as a byte array's clone.
File	getFile()
InputStream	getInputStream() Create an input stream for this resource.
ResourceInfo	getResourceInfo()
long	getSize() Return size of the resource in bytes.
String	getUriAsString() Returns the uri (and hence a unique identifier) for a resource as a String.
String	toString()

Methods inherited from class com.sdl.context.image.AbstractImage

getContentType, getExtension, setContentType, setExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sdl.context.resource.api.Resource

getContentType, getExtension

Constructor Detail

FileImage

protected FileImage(String imagePath)

Create a FileImage from a file path, this method is protected to force use of the ImageFactory.

Parameters:

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

FileImage

protected FileImage(File imageFile)

Create a FileImage from a File, this method is protected to force use of the ImageFactory.

Parameters:

imageFile - the File which contains an image

Method Detail

getFile

public File getFile()

Specified by:

getFile in interface FileResource

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from interface: Resource

Create an input stream for this resource. Note that the caller of this method is responsible for closing the input stream.

Specified by:

getInputStream in interface Resource

Returns:

input stream

Throws:

IOException

getSize

public long getSize()
             throws IOException

Description copied from interface: Resource

Return size of the resource in bytes.

Specified by:

getSize in interface Resource

Throws:

IOException

getBytes

public byte[] getBytes()
                throws IOException

Description copied from interface: Resource

Return the resource as a byte array.

Specified by:

getBytes in interface Resource

Throws:

IOException

getByteString

public ByteString getByteString()
                         throws IOException

Description copied from interface: Resource

Return the resource as a byte array's clone.

Specified by:

getByteString in interface Resource

Throws:

IOException

getUriAsString

public String getUriAsString()

Description copied from interface: UriResource

Returns the uri (and hence a unique identifier) for a resource as a String.

Specified by:

getUriAsString in interface UriResource

Returns:

the resource URI as a string

getResourceInfo

public ResourceInfo getResourceInfo()

Specified by:

getResourceInfo in interface UriImage

toString

public String toString()

Overrides:

toString in class Object