001/* ImageWriterSpi.java --
002   Copyright (C) 2004  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.imageio.spi;
040
041import java.awt.image.RenderedImage;
042import java.io.IOException;
043
044import javax.imageio.ImageTypeSpecifier;
045import javax.imageio.ImageWriter;
046import javax.imageio.stream.ImageOutputStream;
047
048/**
049 * @author Michael Koch (konqueror@gmx.de)
050 */
051public abstract class ImageWriterSpi extends ImageReaderWriterSpi
052{
053  public static final Class[] STANDARD_OUTPUT_TYPE =
054    { ImageOutputStream.class };
055
056  protected Class[] outputTypes;
057  protected String[] readerSpiNames;
058
059  protected ImageWriterSpi()
060  {
061    // Do nothing here.
062  }
063
064  public ImageWriterSpi(String vendorName, String version, String[] names,
065                        String[] suffixes, String[] MIMETypes,
066                        String writerClassName, Class[] outputTypes,
067                        String[] readerSpiNames,
068                        boolean supportsStandardStreamMetadataFormat,
069                        String nativeStreamMetadataFormatName,
070                        String nativeStreamMetadataFormatClassName,
071                        String[] extraStreamMetadataFormatNames,
072                        String[] extraStreamMetadataFormatClassNames,
073                        boolean supportsStandardImageMetadataFormat,
074                        String nativeImageMetadataFormatName,
075                        String nativeImageMetadataFormatClassName,
076                        String[] extraImageMetadataFormatNames,
077                        String[] extraImageMetadataFormatClassNames)
078  {
079    super(vendorName, version, names, suffixes, MIMETypes, writerClassName,
080          supportsStandardStreamMetadataFormat, nativeStreamMetadataFormatName,
081          nativeStreamMetadataFormatClassName, extraStreamMetadataFormatNames,
082          extraStreamMetadataFormatClassNames, supportsStandardImageMetadataFormat,
083          nativeImageMetadataFormatName, nativeImageMetadataFormatClassName,
084          extraImageMetadataFormatNames, extraImageMetadataFormatClassNames);
085
086    if (writerClassName == null)
087      throw new IllegalArgumentException("writerClassName is null");
088
089    if (outputTypes == null
090        || outputTypes.length == 0)
091      throw new IllegalArgumentException("outputTypes may not be null or empty");
092    
093    this.outputTypes = outputTypes;
094    this.readerSpiNames = readerSpiNames;    
095  }
096
097  public abstract boolean canEncodeImage(ImageTypeSpecifier type);
098
099  public boolean canEncodeImage(RenderedImage image)
100  {
101    return canEncodeImage (new ImageTypeSpecifier(image));
102  }
103
104  public ImageWriter createWriterInstance()
105    throws IOException
106  {
107    return createWriterInstance(null);
108  }
109
110  public abstract ImageWriter createWriterInstance(Object extension)
111    throws IOException;
112
113  public String[] getImageReaderSpiNames()
114  {
115    return readerSpiNames;
116  }
117
118  public Class[] getOutputTypes()
119  {
120    return outputTypes;
121  }
122
123  public boolean isFormatLossless()
124  {
125    return true;
126  }
127
128  public boolean isOwnWriter(ImageWriter writer)
129  {
130    if (writer == null)
131      throw new IllegalArgumentException("writer may not be null");
132
133    return pluginClassName.equals(writer.getClass().getName());
134  }
135}