1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2007
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: Compressor.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  
23  package org.crosswire.common.compress;
24  
25  import java.io.ByteArrayOutputStream;
26  import java.io.IOException;
27  
28  /**
29   * A compressor provides the ability to compress and uncompress block text.
30   * Implementing classes are expected to provide a way to supply the input.
31   * 
32   * @see gnu.lgpl.License for license details.<br>
33   *      The copyright to this program is held by it's authors.
34   * @author DM Smith [dmsmith555 at yahoo dot com]
35   */
36  public interface Compressor {
37      /**
38       * The size to read/write when unzipping a compressed byte array of unknown
39       * size.
40       */
41      int BUF_SIZE = 2048;
42  
43      /**
44       * Compresses the input and provides the result.
45       * 
46       * @return the compressed result
47       */
48      ByteArrayOutputStream compress() throws IOException;
49  
50      /**
51       * Uncompresses the input and provides the result.
52       * 
53       * @return the uncompressed result
54       */
55      ByteArrayOutputStream uncompress() throws IOException;
56  
57      /**
58       * Uncompresses the input and provides the result.
59       * 
60       * @param expectedLength
61       *            the size of the result buffer
62       * @return the uncompressed result
63       */
64      ByteArrayOutputStream uncompress(int expectedLength) throws IOException;
65  }
66