1 package org.apache.maven.plugin.compiler.module;
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.File;
23 import java.io.IOException;
24
25 /**
26 * Extract information from the module-info file
27 *
28 * @author Robert Scholte
29 * @since 3.6.0
30 */
31 public interface ModuleInfoParser
32 {
33 /**
34 * Defines the type of parser, i.e. using the source or the class files
35 */
36 public enum Type
37 {
38 SOURCE, CLASS
39 }
40
41 /**
42 * What kind of file does the parser use
43 *
44 * @return the type
45 */
46 Type getType();
47
48 /**
49 * Extracts the name from the module-info file
50 *
51 * @param modulePath
52 * @return
53 * @throws IOException
54 */
55 JavaModuleDescriptor getModuleDescriptor( File modulePath )
56 throws IOException;
57 }