BMPEncodeParam.java
上传用户:btjssb159
上传日期:2018-01-04
资源大小:241k
文件大小:4k
源码类别:

DNA

开发平台:

Java

  1. /*
  2.  * Copyright (c) 2001 Sun Microsystems, Inc. All Rights Reserved.
  3.  *
  4.  * Redistribution and use in source and binary forms, with or without 
  5.  * modification, are permitted provided that the following conditions are met:
  6.  * 
  7.  * -Redistributions of source code must retain the above copyright notice, this 
  8.  * list of conditions and the following disclaimer.
  9.  *
  10.  * -Redistribution in binary form must reproduct the above copyright notice,
  11.  * this list of conditions and the following disclaimer in the documentation
  12.  * and/or other materials provided with the distribution.
  13.  * 
  14.  * Neither the name of Sun Microsystems, Inc. or the names of contributors may
  15.  * be used to endorse or promote products derived from this software without
  16.  * specific prior written permission.
  17.  * 
  18.  * This software is provided "AS IS," without a warranty of any kind. ALL
  19.  * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING ANY
  20.  * IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
  21.  * NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN AND ITS LICENSORS SHALL NOT BE
  22.  * LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING
  23.  * OR DISTRIBUTING THE SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR ITS
  24.  * LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT,
  25.  * INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER
  26.  * CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF
  27.  * OR INABILITY TO USE SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
  28.  * POSSIBILITY OF SUCH DAMAGES.
  29.  * 
  30.  * You acknowledge that Software is not designed,licensed or intended for use in 
  31.  * the design, construction, operation or maintenance of any nuclear facility.
  32.  */
  33. /**
  34.  * An instance of <code>ImageEncodeParam</code> for encoding images in
  35.  * the BMP format.
  36.  *
  37.  * <p> This class allows for the specification of various parameters
  38.  * while encoding (writing) a BMP format image file.  By default, the
  39.  * version used is VERSION_3, no compression is used, and the data layout
  40.  * is bottom_up, such that the pixels are stored in bottom-up order, the
  41.  * first scanline being stored last. 
  42.  *
  43.  * <p><b> This class is not a committed part of the JAI API.  It may
  44.  * be removed or changed in future releases of JAI.</b>
  45.  * 
  46.  */
  47. public class BMPEncodeParam implements ImageEncodeParam {
  48.     // version constants
  49.     /** Constant for BMP version 2. */
  50.     public static final int VERSION_2 = 0;
  51.     /** Constant for BMP version 3. */
  52.     public static final int VERSION_3 = 1;
  53.     /** Constant for BMP version 4. */
  54.     public static final int VERSION_4 = 2;
  55.     // Default values
  56.     private int version = VERSION_3;
  57.     private boolean compressed = false;
  58.     private boolean topDown = false;
  59.     
  60.     /**
  61.      * Constructs an BMPEncodeParam object with default values for parameters.
  62.      */
  63.     public BMPEncodeParam() {}
  64.     /** Sets the BMP version to be used. */
  65.     public void setVersion(int versionNumber) {
  66. checkVersion(versionNumber);
  67. this.version = versionNumber;
  68.     }
  69.     /** Returns the BMP version to be used. */
  70.     public int getVersion() {
  71. return version;
  72.     }
  73.     /** If set, the data will be written out compressed, if possible. */
  74.     public void setCompressed(boolean compressed) {
  75. this.compressed = compressed;
  76.     }
  77.     /** 
  78.      * Returns the value of the parameter <code>compressed</code>.
  79.      */
  80.     public boolean isCompressed() {
  81. return compressed;
  82.     }
  83.     /** 
  84.      * If set, the data will be written out in a top-down manner, the first
  85.      * scanline being written first.
  86.      */
  87.     public void setTopDown(boolean topDown) {
  88. this.topDown = topDown;
  89.     }
  90.     /**
  91.      * Returns the value of the <code>topDown</code> parameter.
  92.      */
  93.     public boolean isTopDown() {
  94. return topDown;
  95.     }
  96.     // Method to check whether we can handle the given version.
  97.     private void checkVersion(int versionNumber) {
  98. if ( !(versionNumber == VERSION_2 ||
  99.        versionNumber == VERSION_3 ||
  100.        versionNumber == VERSION_4) ) {
  101.     throw new RuntimeException(JaiI18N.getString("BMPEncodeParam0")); 
  102. }
  103.     }
  104. }