All Packages  This Package  Class Hierarchy  Class Search  Index

java.lang.Object
   |
   +----com.activated.jimi.JimiWriter

Summary

public class  JimiWriter
     extends java.lang.Object
     implements com.activated.util.PropertyOwner
{
          // Constructors 1
     public JimiWriter(JimiEncoder);

          // Methods 13
     public void clearProperties();
     public Object getPossibleValuesForProperty(String) throws InvalidOptionException;
     public Object getProperty(String);
     public String getPropertyDescription(String) throws InvalidOptionException;
     public Enumeration getPropertyNames();
     public void putImage(OutputStream) throws JimiException;
     public void putImage(String) throws JimiException;
     public void setProperty(String, Object) throws InvalidOptionException;
     public void setSource(JimiImage) throws JimiException;
     public void setSource(Image) throws JimiException;
     public void setSource(ImageProducer) throws JimiException;
     public void setSource(Object[]) throws JimiException;
     public void setStorage(StorageFactory);
}

JimiWriter is an abstraction handle object to deal with the control of encoding an image in a specified file format.

Properties set on the JimiWriter object give the client control of image file format specific Encoder Options. These options are specific to the Encoder and documented for each Encoder.

Cross Reference

Returned By:

Jimi.createJimiWriter(), Jimi.createTypedJimiWriter()

   public JimiWriter(JimiEncoder encoder) 

Construct a JimiWriter using a given JimiEncoder.

Parameter	Description
encoder	the encoder to encode images with

   public void setSource(Image img)  throws JimiException

Parameter	Description
img	sets this Image as the image data source to be encoded and output in the the set image file format.

Throws: JimiException

not currently thrown

   public void setSource(ImageProducer prod)  throws JimiException

Parameter	Description
img	sets this ImageProducer as the image data source to be encoded and output in the the set image file format.

Throws: JimiException

not currently thrown

   public void setSource(JimiImage ji)  throws JimiException

Parameter	Description
img	sets this JimiImage as the image data source to be encoded and output in the the set image file format.

Throws: JimiException

not currently thrown

   public void setSource(Object[] images)  throws JimiException

Parameter	Description
images	array of image data source objects to be encoded to the output destination. Each entry in the array must be of type Image, ImageProducer or JimiImage. The image data sources do not have to be all of the same type. Every entry in the array must point to a valid image data source, null entries are not allowed.

Throws: JimiException

if the filetype to write out to does not support multiple images.

Throws: IllegalArgumentException

if there are any invalid entries in the input array.

   public void putImage(String fileName)  throws JimiException

Parameter	Description
fileName	the destination for the image data encoded in the image file format set for this JimiWriter object.

Throws: JimiException

If the output file could not be opened for output or if an error is encountered while encoding the data.

   public void putImage(OutputStream out)  throws JimiException

Parameter	Description
out	the destination for the image data encoded in the image file format set for this JimiWriter object.

Throws: JimiException

If an error is encountered while encoding the data.

   public Object getPossibleValuesForProperty(String propName)  throws InvalidOptionException

The properties of this JimiReader are simple proxies for the properties of the underlying encoder.

Throws: InvalidOptionException

thrown if request values for a property name not supported by this object.

Implements:

getPossibleValuesForProperty in interface PropertyOwner

   public String getPropertyDescription(String propName)  throws InvalidOptionException

Proxies appropriately.

Throws: InvalidOptionException

thrown if request a description for a property name not supported by this object.

Implements:

getPropertyDescription in interface PropertyOwner

   public void clearProperties() 

The properties of this JimiReader are simple proxies for the properties of the underlying encoder.

Implements:

clearProperties in interface PropertyOwner

   public Object getProperty(String key) 

The properties of this JimiReader are simple proxies for the properties of the underlying encoder.

Implements:

getProperty in interface PropertyOwner

   public Enumeration getPropertyNames() 

The properties of this JimiReader are simple proxies for the properties of the underlying encoder.

Implements:

getPropertyNames in interface PropertyOwner

   public void setProperty(String name, 
                           Object value)  throws InvalidOptionException

The properties of this JimiReader are simple proxies for the properties of the underlying encoder.

Throws: InvalidOptionException

thrown if name of the property is not valid for this object or if the value is out of range for this object for th given name.

Implements:

setProperty in interface PropertyOwner

   public void setStorage(StorageFactory sFact) 

Parameter	Description
sFact	the StorageFactory to be used to create JimiImage instances where and when they are required in this class. If null then the default StorageFactory will be used.

All Packages  This Package  Class Hierarchy  Class Search  Index