1 package org.codehaus.plexus.languages.java.jpms;
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.nio.file.Path;
24
25 import org.codehaus.plexus.languages.java.version.JavaVersion;
26
27 /**
28 * Extract information from the module-info file
29 *
30 * @author Robert Scholte
31 * @since 1.0.0
32 */
33 interface ModuleInfoParser {
34 /**
35 * Extracts the name from the module-info file
36 *
37 * @param modulePath the path to the {@code module-info.class}
38 * @return the module descriptor
39 * @throws IOException when the file could not be parsed
40 */
41 JavaModuleDescriptor getModuleDescriptor(Path modulePath) throws IOException;
42
43 /**
44 * Extracts the name from the module-info file
45 *
46 * @param modulePath the path to the {@code module-info.class}
47 * @param javaVersion the java version in case of a multirelease jar
48 * @return the module descriptor
49 * @throws IOException when the file could not be parsed
50 */
51 JavaModuleDescriptor getModuleDescriptor(Path modulePath, JavaVersion javaVersion) throws IOException;
52 }