org.mycore.common.content.streams.MCRNotClosingInputStream Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation

There is a newer version: 2024.05

/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe 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 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe 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 MyCoRe.  If not, see .
 */

package org.mycore.common.content.streams;

import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;

/**
 * A FilterInputStream that wraps any InputStream to prevent close() is called.
 * Sometimes, third party code or code you can not change closes an InputStream after
 * it returned -1 on read(). But when using ZipInputStream, this is unwanted, because
 * a ZipInputStream may contain other entries that have to be read and invoked code
 * must be prevented from calling close(). With this class, a ZipInputStream or any other
 * stream can be wrapped to regain control of closing.      
 * 
 * @author Frank L\u00FCtzenkirchen
 */
public class MCRNotClosingInputStream extends FilterInputStream {

    public MCRNotClosingInputStream(InputStream in) {
        super(in);
    }

    /** 
     * Does nothing. When you want to really close the stream, call reallyClose().
     */
    public void close() throws IOException {
    }

    /**
     * Really closes the stream. 
     */
    public void reallyClose() throws IOException {
        super.close();
    }
}