/* InflaterIf.java - Interface to decompress a data stream.
   Copyright (C) 2005 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath 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 for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package java.util.zip;

/**
 * This interface is used with a address@hidden ZipInputStream} and address@hidden ZipFile}
 * in order to inflate ZIP file content.
 * It enables the user (developer) to have the choice between using this
 * package's address@hidden Inflater} or the genuine address@hidden java.util.zip.Inflater}
 * class provided with the JDK, presuming that a simple Inflater adapter class
 * is provided which extends JDK's Inflater and implements this interface.
 *
 * This way a developer has the option of going for ultimate portability
 * (provided by this package) or optimum performance (provided by the JDK)
 * without having to modify the sources of this package.
 *
 * Please refer to address@hidden java.util.zip.Inflater} for a documentation about
 * what the members of this interface are meant to do.
 *
 * @author Christian Schlichtherle
 */
public interface InflaterIf {

public abstract void setInput(byte[] b, int off, int len);

public abstract void setInput(byte[] b);

public abstract void setDictionary(byte[] b, int off, int len);

public abstract void setDictionary(byte[] b);

public abstract int getRemaining();

public abstract boolean needsInput();

public abstract boolean needsDictionary();

public abstract boolean finished();

public abstract int inflate(byte[] b, int off, int len) throws Exception; // Cannot use DataFormatException -  conflicts with JDK

public abstract int inflate(byte[] b) throws Exception; // Cannot use DataFormatException -  conflicts with JDK

public abstract int getAdler();

public abstract int getTotalIn();

public abstract int getTotalOut();

public abstract void reset();

public abstract void end();
}