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;
20
21 import java.io.IOException;
22
23 import org.apache.maven.api.annotations.Experimental;
24 import org.apache.maven.api.annotations.Nonnull;
25
26 /**
27 * Defines the contract for parsing Maven command-line arguments and creating an execution or invoker requests.
28 *
29 * @since 4.0.0
30 */
31 @Experimental
32 public interface Parser {
33 /**
34 * Parses the given ParserRequest to create an {@link InvokerRequest}.
35 * This method does interpret tool arguments.
36 *
37 * @param parserRequest the request containing all necessary information for parsing
38 * @return the parsed invoker request
39 * @throws ParserException if there's an error during parsing of the request
40 * @throws IOException if there's an I/O error during the parsing process
41 */
42 @Nonnull
43 InvokerRequest parseInvocation(@Nonnull ParserRequest parserRequest) throws ParserException, IOException;
44 }