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 org.apache.maven.api.annotations.Experimental;
22 import org.apache.maven.api.annotations.Nonnull;
23 import org.apache.maven.api.cli.Invoker;
24 import org.apache.maven.api.cli.InvokerException;
25
26 /**
27 * Defines the contract for a component responsible for invoking Maven using information provided in an invoker request.
28 * This interface extends the general {@link Invoker} interface, specializing it for Maven-specific operations.
29 *
30 * @param <R> The specific type of {@link MavenInvokerRequest} this invoker can handle
31 *
32 * @since 4.0.0
33 */
34 @Experimental
35 public interface MavenInvoker<R extends MavenInvokerRequest<? extends MavenOptions>> extends Invoker<R> {
36 /**
37 * Invokes Maven using the provided MavenInvokerRequest.
38 * This method is responsible for executing the Maven build process
39 * based on the information contained in the request.
40 *
41 * @param invokerRequest the request containing all necessary information for the Maven invocation
42 * @return an integer representing the exit code of the Maven invocation (0 typically indicates success)
43 * @throws InvokerException if an error occurs during the Maven invocation process
44 */
45 @Override
46 int invoke(@Nonnull R invokerRequest) throws InvokerException;
47 }