htsjdk.samtools.util.zip.InflaterFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of htsjdk Show documentation

A Java API for high-throughput sequencing data (HTS) formats

There is a newer version: 4.1.3

/*
 * The MIT License
 *
 * Copyright (c) 2013 The Broad Institute
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package htsjdk.samtools.util.zip;

import htsjdk.samtools.util.BlockGunzipper;
import java.util.zip.Inflater;

/**
 * Factory for {@link Inflater} objects used by {@link BlockGunzipper}.
 * This class may be extended to provide alternative inflaters (e.g., for improved performance).
 * The default implementation returns a JDK {@link Inflater}
 */
public class InflaterFactory {

    public InflaterFactory() {
        //Note: made explicit constructor to make searching for references easier
    }

    /**
     * Returns an inflater object that will be used when reading DEFLATE compressed files.
     * Subclasses may override to provide their own inflater implementation.
     * The default implementation returns a JDK {@link Inflater}
     * @param gzipCompatible if true then use GZIP compatible compression
     */
    public Inflater makeInflater(final boolean gzipCompatible) {
        return new Inflater(gzipCompatible);
    }
}