ch.specchio.types

Class SerialisableBufferedImage

java.lang.Object

ch.specchio.types.SerialisableBufferedImage

All Implemented Interfaces:

java.io.Serializable

public class SerialisableBufferedImage
extends java.lang.Object
implements java.io.Serializable

An image that can be serialised by both Java and Jersey.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SerialisableBufferedImage() Constructor.

Method Summary

Modifier and Type	Method and Description
java.awt.image.BufferedImage	getImage() Get a BufferedImage object representing this image.
byte[]	getImageData()
java.lang.String	getName()
void	readImage(java.io.InputStream in, java.lang.String mimeType) Read an image from an input steam.
void	setImage(java.awt.image.BufferedImage imageIn) Set the image.
void	setImageData(byte[] image_data)
void	setName(java.lang.String name)
void	writeImage(java.io.OutputStream out) Write an image to an output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialisableBufferedImage

public SerialisableBufferedImage()

Constructor.

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getImageData

public byte[] getImageData()

setImageData

public void setImageData(byte[] image_data)

getImage

public java.awt.image.BufferedImage getImage()
                                      throws java.io.IOException,
                                             java.lang.ClassNotFoundException

Get a BufferedImage object representing this image.

Returns:

a BufferedImage object, or null if this object has not been initialised

Throws:

java.lang.ClassNotFoundException - no decoder found for the internal image data

java.io.IOException - could not decode the image data

readImage

public void readImage(java.io.InputStream in,
                      java.lang.String mimeType)
               throws java.lang.ClassNotFoundException,
                      java.io.IOException

Read an image from an input steam.

Parameters:

in - the input stream

mimeType - the MIME type of the image

Throws:

java.lang.ClassNotFoundException - no usable decoder/encoder found

java.io.IOException - input error

setImage

public void setImage(java.awt.image.BufferedImage imageIn)
              throws java.lang.ClassNotFoundException,
                     java.io.IOException

Set the image.

Parameters:

imageIn - the image

Throws:

java.lang.ClassNotFoundException - no encoder found for the image data

java.io.IOException - output error

writeImage

public void writeImage(java.io.OutputStream out)
                throws java.io.IOException

Write an image to an output stream.

Parameters:

out - the output stream

Throws:

java.io.IOException - output error