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: ImageEncoderImpl.java 447277 2006-09-18 06:19:34Z jeremias $ */
19:
20: package org.apache.xmlgraphics.image.codec.util;
21:
22: import java.awt.image.ColorModel;
23: import java.awt.image.Raster;
24: import java.awt.image.RenderedImage;
25: import java.io.IOException;
26: import java.io.OutputStream;
27:
28: /**
29: * A partial implementation of the ImageEncoder interface useful for
30: * subclassing.
31: *
32: * <p><b> This class is not a committed part of the JAI API. It may
33: * be removed or changed in future releases of JAI.</b>
34: */
35: public abstract class ImageEncoderImpl implements ImageEncoder {
36:
37: /** The OutputStream associcted with this ImageEncoder. */
38: protected OutputStream output;
39:
40: /** The ImageEncodeParam object associcted with this ImageEncoder. */
41: protected ImageEncodeParam param;
42:
43: /**
44: * Constructs an ImageEncoderImpl with a given OutputStream
45: * and ImageEncoderParam instance.
46: */
47: public ImageEncoderImpl(OutputStream output, ImageEncodeParam param) {
48: this .output = output;
49: this .param = param;
50: }
51:
52: /**
53: * Returns the current parameters as an instance of the
54: * ImageEncodeParam interface. Concrete implementations of this
55: * interface will return corresponding concrete implementations of
56: * the ImageEncodeParam interface. For example, a JPEGImageEncoder
57: * will return an instance of JPEGEncodeParam.
58: */
59: public ImageEncodeParam getParam() {
60: return param;
61: }
62:
63: /**
64: * Sets the current parameters to an instance of the
65: * ImageEncodeParam interface. Concrete implementations
66: * of ImageEncoder may throw a RuntimeException if the
67: * params argument is not an instance of the appropriate
68: * subclass or subinterface. For example, a JPEGImageEncoder
69: * will expect param to be an instance of JPEGEncodeParam.
70: */
71: public void setParam(ImageEncodeParam param) {
72: this .param = param;
73: }
74:
75: /** Returns the OutputStream associated with this ImageEncoder. */
76: public OutputStream getOutputStream() {
77: return output;
78: }
79:
80: /**
81: * Encodes a Raster with a given ColorModel and writes the output
82: * to the OutputStream associated with this ImageEncoder.
83: */
84: public void encode(Raster ras, ColorModel cm) throws IOException {
85: RenderedImage im = new SingleTileRenderedImage(ras, cm);
86: encode(im);
87: }
88:
89: /**
90: * Encodes a RenderedImage and writes the output to the
91: * OutputStream associated with this ImageEncoder.
92: */
93: public abstract void encode(RenderedImage im) throws IOException;
94: }
|