1 package org.apache.maven.index.util.zip; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import java.io.Closeable; 23 import java.io.IOException; 24 import java.io.InputStream; 25 import java.util.List; 26 27 /** 28 * A very simplistic approach to hide the underlying mech to deal with ZipFiles, suited for use cases happening in Maven 29 * Indexer. 30 * 31 * @author cstamas 32 */ 33 public interface ZipHandle 34 extends Closeable 35 { 36 /** 37 * Returns true if Zip file this handle is pointing to contains an entry at given path. 38 * 39 * @param path 40 * @return 41 */ 42 boolean hasEntry( String path ) 43 throws IOException; 44 45 /** 46 * Returns a list of string, with each string representing a valid path for existing entry in this Zip handle. 47 * 48 * @return 49 */ 50 List<String> getEntries(); 51 52 /** 53 * Returns a list of string, with each string representing a valid path for existing entry in this Zip handle. 54 * 55 * @return 56 */ 57 List<String> getEntries( EntryNameFilter filter ); 58 59 /** 60 * Returns the "payload" (uncompressed) of the entry at given path, or null if no such path exists in the Zip file 61 * this handle points to. 62 * 63 * @param path 64 * @return 65 */ 66 InputStream getEntryContent( String path ) 67 throws IOException; 68 69 /** 70 * Closes the zip handle (performs resource cleanup). This method should be called when this zip handle is not 71 * needed anymore, and calling it should be obligatory to prevent resource leaks. 72 */ 73 void close() 74 throws IOException; 75 }