Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ZipHandle |
|
| 1.0;1 |
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.IOException; | |
23 | import java.io.InputStream; | |
24 | import java.util.List; | |
25 | ||
26 | /** | |
27 | * A very simplistic approach to hide the underlying mech to deal with ZipFiles, suited for use cases happening in Maven | |
28 | * Indexer. | |
29 | * | |
30 | * @author cstamas | |
31 | */ | |
32 | public interface ZipHandle | |
33 | { | |
34 | /** | |
35 | * Returns true if Zip file this handle is pointing to contains an entry at given path. | |
36 | * | |
37 | * @param path | |
38 | * @return | |
39 | */ | |
40 | boolean hasEntry( String path ) | |
41 | throws IOException; | |
42 | ||
43 | /** | |
44 | * Returns a list of string, with each string representing a valid path for existing entry in this Zip handle. | |
45 | * | |
46 | * @return | |
47 | */ | |
48 | List<String> getEntries(); | |
49 | ||
50 | /** | |
51 | * Returns a list of string, with each string representing a valid path for existing entry in this Zip handle. | |
52 | * | |
53 | * @return | |
54 | */ | |
55 | List<String> getEntries( EntryNameFilter filter ); | |
56 | ||
57 | /** | |
58 | * Returns the "payload" (uncompressed) of the entry at given path, or null if no such path exists in the Zip file | |
59 | * this handle points to. | |
60 | * | |
61 | * @param path | |
62 | * @return | |
63 | */ | |
64 | InputStream getEntryContent( String path ) | |
65 | throws IOException; | |
66 | ||
67 | /** | |
68 | * Closes the zip handle (performs resource cleanup). This method should be called when this zip handle is not | |
69 | * needed anymore, and calling it should be obligatory to prevent resource leaks. | |
70 | */ | |
71 | void close() | |
72 | throws IOException; | |
73 | } |