01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17:
18: /* $Id: ImageWriter.java 496556 2007-01-16 00:59:48Z cam $ */
19:
20: package org.apache.xmlgraphics.image.writer;
21:
22: import java.awt.image.RenderedImage;
23: import java.io.IOException;
24: import java.io.OutputStream;
25:
26: /**
27: * Interface which allows image library independent image writing.
28: *
29: * @version $Id: ImageWriter.java 496556 2007-01-16 00:59:48Z cam $
30: */
31: public interface ImageWriter {
32:
33: /**
34: * Encodes an image and writes it to an OutputStream.
35: * @param image the image to be encoded
36: * @param out the OutputStream to write to
37: * @throws IOException In case of an /IO problem
38: */
39: public void writeImage(RenderedImage image, OutputStream out)
40: throws IOException;
41:
42: /**
43: * Encodes an image and writes it to an OutputStream.
44: * @param image the image to be encoded
45: * @param out the OutputStream to write to
46: * @param params a parameters object to customize the encoding.
47: * @throws IOException In case of an /IO problem
48: */
49: public void writeImage(RenderedImage image, OutputStream out,
50: ImageWriterParams params) throws IOException;
51:
52: /** @return the target MIME type supported by this ImageWriter */
53: public String getMIMEType();
54:
55: /** @return true if the ImageWriter is expected to work properly in the current environment */
56: public boolean isFunctional();
57:
58: /** @return true if the implemented format supports multiple pages in a single file */
59: public boolean supportsMultiImageWriter();
60:
61: /**
62: * Creates a MultiImageWriter instance that lets you put multiple pages into a single file
63: * if the format supports it.
64: * @param out the OutputStream to write the image to
65: * @return the requested MultiImageWriter instance
66: * @throws IOException In case of an /IO problem
67: */
68: public MultiImageWriter createMultiImageWriter(OutputStream out)
69: throws IOException;
70:
71: }
|