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.api.cli.mvn.forked;
20
21 import java.io.IOException;
22
23 import org.apache.maven.api.annotations.Experimental;
24 import org.apache.maven.api.annotations.Nonnull;
25 import org.apache.maven.api.cli.ParserException;
26 import org.apache.maven.api.cli.ParserRequest;
27 import org.apache.maven.api.cli.mvn.MavenParser;
28
29 /**
30 * Defines the contract for parsing command-line arguments specific to forked Maven executions.
31 * This interface extends the {@link MavenParser}, specializing it for creating {@link ForkedMavenInvokerRequest} objects.
32 *
33 * @since 4.0.0
34 */
35 @Experimental
36 public interface ForkedMavenParser extends MavenParser<ForkedMavenInvokerRequest> {
37 /**
38 * Parses the given ParserRequest to create a ForkedMavenInvokerRequest.
39 * This method is responsible for interpreting the contents of the ParserRequest
40 * and constructing the appropriate ForkedMavenInvokerRequest object for forked Maven operations.
41 *
42 * @param parserRequest the request containing all necessary information for parsing
43 * @return the parsed ForkedMavenInvokerRequest
44 * @throws ParserException if there's an error during parsing of the request
45 * @throws IOException if there's an I/O error during the parsing process
46 */
47 @Nonnull
48 ForkedMavenInvokerRequest parse(@Nonnull ParserRequest parserRequest) throws ParserException, IOException;
49 }