com.communote.server.api.core.image

Class Image

java.lang.Object

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ByteArrayImage, FileImage

public abstract class Image
extends Object
implements Serializable

Image

Author:

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Image(String mimeType, Date lastModificationDate, long size, String providerId, boolean defaultImage)
Image(String mimeType, Date lastModificationDate, long size, String providerId, boolean defaultImage, boolean isExternal)

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes()
Date	getLastModificationDate()
String	getMimeType()
String	getProviderId()
long	getSize()
boolean	isDefaultImage()
boolean	isExternal()
abstract InputStream	openStream()
void	setExternal(boolean isExternal)
void	setLastModificationDate(Date lastModificationDate)
void	setMimeType(String mimeType)
void	setSize(long size)

Methods inherited from class java.lang.Object

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

Constructor Detail

Image

public Image(String mimeType,
             Date lastModificationDate,
             long size,
             String providerId,
             boolean defaultImage)

Parameters:

mimeType - The mimetype.

lastModificationDate - The last modification date.

size - Size of the image in bytes.

providerId - The identifier of the provider that loaded the image

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

Image

public Image(String mimeType,
             Date lastModificationDate,
             long size,
             String providerId,
             boolean defaultImage,
             boolean isExternal)

Parameters:

mimeType - The mimetype.

lastModificationDate - The last modification date.

size - Size of the image in bytes.

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

getBytes

public byte[] getBytes()
                throws IOException

Returns:

Returns the image data as byte array.

Throws:

IOException - Thrown, when there was an array creating the bytes.

getLastModificationDate

public Date getLastModificationDate()

Returns:

the lastModificationDate

getMimeType

public String getMimeType()

Returns:

the mimeType

getProviderId

public String getProviderId()

Returns:

the identifier of the provider that loaded the image

getSize

public long getSize()

Returns:

the size

isDefaultImage

public boolean isDefaultImage()

Returns:

whether the image is a default image or a custom image

isExternal

public boolean isExternal()

Returns:

the isExternal

openStream

public abstract InputStream openStream()
                                throws IOException

Returns:

InputStream to the image.

Throws:

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

setExternal

public void setExternal(boolean isExternal)

Parameters:

isExternal - the isExternal to set

setLastModificationDate

public void setLastModificationDate(Date lastModificationDate)

Parameters:

lastModificationDate - the lastModificationDate to set

setMimeType

public void setMimeType(String mimeType)

Parameters:

mimeType - the mimeType to set

setSize

public void setSize(long size)

Parameters:

size - the size to set