/* * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation.  Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.imageio.plugins.bmp; import java.util.Locale;import javax.imageio.ImageWriteParam; import com.sun.imageio.plugins.bmp.BMPConstants; /** * A subclass of <code>ImageWriteParam</code> for encoding images in * the BMP format. * * <p> This class allows for the specification of various parameters * while writing a BMP format image file.  By default, the data layout * is bottom-up, such that the pixels are stored in bottom-up order, * the first scanline being stored last. * * <p>The particular compression scheme to be used can be specified by using * the <code>setCompressionType()</code> method with the appropriate type * string.  The compression scheme specified will be honored if and only if it * is compatible with the type of image being written. If the specified * compression scheme is not compatible with the type of image being written * then the <code>IOException</code> will be thrown by the BMP image writer. * If the compression type is not set explicitly then <code>getCompressionType()</code> * will return <code>null</code>. In this case the BMP image writer will select * a compression type that supports encoding of the given image without loss * of the color resolution. * <p>The compression type strings and the image type(s) each supports are * listed in the following * table: * * <p><table border=1> * <caption><b>Compression Types</b></caption> * <tr><th>Type String</th> <th>Description</th>  <th>Image Types</th></tr> * <tr><td>BI_RGB</td>  <td>Uncompressed RLE</td> <td><= 8-bits/sample</td></tr> * <tr><td>BI_RLE8</td> <td>8-bit Run Length Encoding</td> <td><= 8-bits/sample</td></tr> * <tr><td>BI_RLE4</td> <td>4-bit Run Length Encoding</td> <td><= 4-bits/sample</td></tr> * <tr><td>BI_BITFIELDS</td> <td>Packed data</td> <td> 16 or 32 bits/sample</td></tr> * </table> */public class BMPImageWriteParam extends ImageWriteParam {     private boolean topDown = false;     /**     * Constructs a <code>BMPImageWriteParam</code> set to use a given     * <code>Locale</code> and with default values for all parameters.     *     * @param locale a <code>Locale</code> to be used to localize     * compression type names and quality descriptions, or     * <code>null</code>.     */    public BMPImageWriteParam(Locale locale) {        super(locale);         // Set compression types ("BI_RGB" denotes uncompressed).        compressionTypes = BMPConstants.compressionTypeNames.clone();         // Set compression flag.        canWriteCompressed = true;        compressionMode = MODE_COPY_FROM_METADATA;        compressionType = compressionTypes[BMPConstants.BI_RGB];    }     /**     * Constructs an <code>BMPImageWriteParam</code> object with default     * values for all parameters and a <code>null</code> <code>Locale</code>.     */    public BMPImageWriteParam() {        this(null);    }     /**     * If set, the data will be written out in a top-down manner, the first     * scanline being written first.     *     * @param topDown whether the data are written in top-down order.     */    public void setTopDown(boolean topDown) {        this.topDown = topDown;    }     /**     * Returns the value of the <code>topDown</code> parameter.     * The default is <code>false</code>.     *     * @return whether the data are written in top-down order.     */    public boolean isTopDown() {        return topDown;    }}