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;
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.Parser;
26 import org.apache.maven.api.cli.ParserException;
27 import org.apache.maven.api.cli.ParserRequest;
28
29 /**
30 * Defines the contract for parsing Maven-specific command-line arguments and creating a MavenInvokerRequest.
31 * This interface extends the general {@link Parser} interface, specializing it for Maven operations.
32 *
33 * @param <R> The specific type of MavenInvokerRequest this parser produces
34 *
35 * @since 4.0.0
36 */
37 @Experimental
38 public interface MavenParser<R extends MavenInvokerRequest<? extends MavenOptions>> extends Parser<R> {
39 /**
40 * Parses the given {@link ParserRequest} to create a {@link MavenInvokerRequest}.
41 * This method is responsible for interpreting the contents of the ParserRequest
42 * and constructing the appropriate {@link MavenInvokerRequest} object for Maven operations.
43 *
44 * @param parserRequest the request containing all necessary information for parsing
45 * @return the parsed {@link MavenInvokerRequest}
46 * @throws ParserException if there's an error during parsing of the request
47 * @throws IOException if there's an I/O error during the parsing process
48 */
49 @Nonnull
50 R parse(@Nonnull ParserRequest parserRequest) throws ParserException, IOException;
51 }