Compressor.java
上传用户:quxuerui
上传日期:2018-01-08
资源大小:41811k
文件大小:3k
源码类别:

网格计算

开发平台:

Java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one
  3.  * or more contributor license agreements.  See the NOTICE file
  4.  * distributed with this work for additional information
  5.  * regarding copyright ownership.  The ASF licenses this file
  6.  * to you under the Apache License, Version 2.0 (the
  7.  * "License"); you may not use this file except in compliance
  8.  * with the License.  You may obtain a copy of the License at
  9.  *
  10.  *     http://www.apache.org/licenses/LICENSE-2.0
  11.  *
  12.  * Unless required by applicable law or agreed to in writing, software
  13.  * distributed under the License is distributed on an "AS IS" BASIS,
  14.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15.  * See the License for the specific language governing permissions and
  16.  * limitations under the License.
  17.  */
  18. package org.apache.hadoop.io.compress;
  19. import java.io.IOException;
  20. /**
  21.  * Specification of a stream-based 'compressor' which can be  
  22.  * plugged into a {@link CompressionOutputStream} to compress data.
  23.  * This is modelled after {@link java.util.zip.Deflater}
  24.  * 
  25.  */
  26. public interface Compressor {
  27.   /**
  28.    * Sets input data for compression. 
  29.    * This should be called whenever #needsInput() returns 
  30.    * <code>true</code> indicating that more input data is required.
  31.    * 
  32.    * @param b Input data
  33.    * @param off Start offset
  34.    * @param len Length
  35.    */
  36.   public void setInput(byte[] b, int off, int len);
  37.   
  38.   /**
  39.    * Returns true if the input data buffer is empty and 
  40.    * #setInput() should be called to provide more input. 
  41.    * 
  42.    * @return <code>true</code> if the input data buffer is empty and 
  43.    * #setInput() should be called in order to provide more input.
  44.    */
  45.   public boolean needsInput();
  46.   
  47.   /**
  48.    * Sets preset dictionary for compression. A preset dictionary 
  49.    * is used when the history buffer can be predetermined. 
  50.    *
  51.    * @param b Dictionary data bytes
  52.    * @param off Start offset
  53.    * @param len Length
  54.    */
  55.   public void setDictionary(byte[] b, int off, int len);
  56.   /**
  57.    * Return number of uncompressed bytes input so far.
  58.    */
  59.   public long getBytesRead();
  60.   /**
  61.    * Return number of compressed bytes output so far.
  62.    */
  63.   public long getBytesWritten();
  64.   /**
  65.    * When called, indicates that compression should end
  66.    * with the current contents of the input buffer.
  67.    */
  68.   public void finish();
  69.   
  70.   /**
  71.    * Returns true if the end of the compressed 
  72.    * data output stream has been reached.
  73.    * @return <code>true</code> if the end of the compressed
  74.    * data output stream has been reached.
  75.    */
  76.   public boolean finished();
  77.   
  78.   /**
  79.    * Fills specified buffer with compressed data. Returns actual number
  80.    * of bytes of compressed data. A return value of 0 indicates that
  81.    * needsInput() should be called in order to determine if more input
  82.    * data is required.
  83.    * 
  84.    * @param b Buffer for the compressed data
  85.    * @param off Start offset of the data
  86.    * @param len Size of the buffer
  87.    * @return The actual number of bytes of compressed data.
  88.    */
  89.   public int compress(byte[] b, int off, int len) throws IOException;
  90.   
  91.   /**
  92.    * Resets compressor so that a new set of input data can be processed.
  93.    */
  94.   public void reset();
  95.   
  96.   /**
  97.    * Closes the compressor and discards any unprocessed input.
  98.    */
  99.   public void end(); 
  100. }