org.conqat.lib.commons.filesystem.ZipContentProvider Maven / Gradle / Ivy

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

Provides common utility functions

There is a newer version: 2024.7.2

Show newest version

/*
 * Copyright (c) CQSE GmbH
 *
 * 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 org.conqat.lib.commons.filesystem;

import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Enumeration;

import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;

/**
 * {@link PathBasedContentProviderBase} implementation working on ZIP/JAR files.
 *
 * @author hummelb
 */
/* package */final class ZipContentProvider extends PathBasedContentProviderBase {

	/** The underlying ZIP file. */
	private final ZipFile zipFile;

	/** Constructor. */
	public ZipContentProvider(ZipFile zipFile) {
		this.zipFile = zipFile;
	}

	/** {@inheritDoc} */
	@Override
	public Collection getPaths() {
		Collection result = new ArrayList<>();
		Enumeration e = zipFile.getEntries();
		while (e.hasMoreElements()) {
			ZipArchiveEntry entry = e.nextElement();
			if (!entry.isDirectory()) {
				result.add(entry.getName());
			}
		}
		return result;
	}

	/** {@inheritDoc} */
	@Override
	public InputStream openStream(String relativePath) throws IOException {
		ZipArchiveEntry entry = zipFile.getEntry(relativePath);
		if (entry == null) {
			throw new IOException("Unknown path: " + relativePath);
		}
		return zipFile.getInputStream(entry);
	}

	/** {@inheritDoc} */
	@Override
	public void close() throws IOException {
		zipFile.close();
	}
}