com.communote.server.api.core.image

Class FileImage

java.lang.Object

com.communote.server.api.core.image.Image

com.communote.server.api.core.image.FileImage

All Implemented Interfaces:

Serializable

public class FileImage
extends Image

Image which streams the image from a file.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileImage(File file, String mimeType, String providerId, boolean defaultImage)
FileImage(File file, String mimeType, String providerId, boolean defaultImage, boolean isExternal)

Method Summary

Modifier and Type	Method and Description
InputStream	openStream()

Methods inherited from class com.communote.server.api.core.image.Image

getBytes, getLastModificationDate, getMimeType, getProviderId, getSize, isDefaultImage, isExternal, setExternal, setLastModificationDate, setMimeType, setSize

Methods inherited from class java.lang.Object

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

Constructor Detail

FileImage

public FileImage(File file,
                 String mimeType,
                 String providerId,
                 boolean defaultImage)

Parameters:

file - The file this image is for.

mimeType - The mimetype for this image.

providerId - The identifier of the provider that loaded the image

defaultImage - whether the image is a default image or a custom image

FileImage

public FileImage(File file,
                 String mimeType,
                 String providerId,
                 boolean defaultImage,
                 boolean isExternal)

Parameters:

file - The file this image is for.

mimeType - The mimetype for this image.

providerId - The identifier of the provider that loaded the image

defaultImage - whether the image is a default image or a custom image

isExternal - Set to true, if this image is an external image.

Method Detail

openStream

public InputStream openStream()
                       throws IOException

Specified by:

openStream in class Image

Returns:

Returns a new FileInputStream to the file containing the image. You should explicitly close the stream after processing the image to avoid locked files.

Throws:

IOException - Thrown, when there was an error opening the stream.