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.util.List;
22 import java.util.Optional;
23
24 import org.apache.maven.api.annotations.Experimental;
25 import org.apache.maven.api.annotations.Nonnull;
26 import org.apache.maven.api.cli.mvn.MavenInvokerRequest;
27 import org.apache.maven.api.cli.mvn.MavenOptions;
28
29 /**
30 * Represents a request to invoke Maven in a forked JVM.
31 * This interface extends the {@link MavenInvokerRequest}, adding capabilities specific to forked Maven executions.
32 *
33 * @since 4.0.0
34 */
35 @Experimental
36 public interface ForkedMavenInvokerRequest extends MavenInvokerRequest<MavenOptions> {
37 /**
38 * Returns the list of extra JVM arguments to be passed to the forked Maven process.
39 * These arguments allow for customization of the JVM environment in which Maven will run.
40 *
41 * @return an Optional containing the list of extra JVM arguments, or empty if not specified
42 */
43 @Nonnull
44 Optional<List<String>> jvmArguments();
45 }