1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19 package org.apache.maven.shared.dependency.analyzer;
20
21 import java.io.IOException;
22 import java.net.URL;
23 import java.util.Set;
24
25 /**
26 * Gets the set of classes contained in a library given either as a jar file or an exploded directory.
27 *
28 * @author <a href="mailto:markhobson@gmail.com">Mark Hobson</a>
29 */
30 public interface ClassAnalyzer {
31
32 /**
33 * <p>analyze.</p>
34 *
35 * @param url the JAR file or directory to analyze
36 * @return a {@link java.util.Set} object
37 * @throws java.io.IOException if any
38 */
39 default Set<String> analyze(URL url) throws IOException {
40 return analyze(url, new ClassesPatterns());
41 }
42
43 /**
44 * <p>analyze.</p>
45 *
46 * @param url the JAR file or directory to analyze
47 * @return a {@link java.util.Set} object
48 * @throws java.io.IOException if any
49 */
50 Set<String> analyze(URL url, ClassesPatterns excludedClasses) throws IOException;
51 }