com.alanbuttars.commons.compress.stub.decompress.DecompressCompressedFileWithStubBzip2Impl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons-compress Show documentation

Commons Compress is an API which provides a more friendly wrapper around the Apache Commons Compress library.

The newest version!

/*
 * Copyright (C) Alan Buttars
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.alanbuttars.commons.compress.stub.decompress;

import static com.alanbuttars.commons.compress.files.util.CompressedFiles.BZIP2;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import org.apache.commons.compress.compressors.bzip2.BZip2CompressorInputStream;

import com.alanbuttars.commons.compress.files.input.CompressedFileInputStream;
import com.alanbuttars.commons.compress.files.input.CompressedFileInputStreamImpl;
import com.alanbuttars.commons.compress.files.util.CompressedFiles;
import com.alanbuttars.commons.util.annotations.VisibleForTesting;
import com.alanbuttars.commons.util.functions.Function;

/**
 * Extension of {@link DecompressCompressedFileWithStub} for {@link CompressedFiles#BZIP2} files. For details on the
 * file format, see https://en.wikipedia.org/wiki/Bzip2.
 * 
 * @author Alan Buttars
 *
 */
public class DecompressCompressedFileWithStubBzip2Impl extends DecompressCompressedFileWithStub {

	private boolean decompressConcatenated;

	DecompressCompressedFileWithStubBzip2Impl(File source) {
		super(source, BZIP2);
		this.decompressConcatenated = false;
	}

	/**
	 * If set to true, decompresses the stream until the end of the input. By default, it is set to
	 * false. See {@link BZip2CompressorInputStream#BZip2CompressorInputStream(InputStream, boolean)}.
	 */
	public DecompressCompressedFileWithStubBzip2Impl andDecompressConcatenated(boolean decompressConcatenated) {
		this.decompressConcatenated = decompressConcatenated;
		return this;
	}

	@Override
	protected Function decompressionFunction() {
		return new Function() {

			@Override
			public CompressedFileInputStream apply(InputStream inputStream) {
				try {
					return createCompressedFileInputStream(inputStream, decompressConcatenated);
				}
				catch (IOException e) {
					throw new RuntimeException(e);
				}
			}

		};
	}

	@VisibleForTesting
	protected CompressedFileInputStream createCompressedFileInputStream(InputStream inputStream, boolean decompressConcatenated) throws IOException {
		return new CompressedFileInputStreamImpl(new BZip2CompressorInputStream(inputStream, decompressConcatenated));
	}

}