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 org.apache.maven.api.annotations.Experimental;
22 import org.apache.maven.api.annotations.Nullable;
23 import org.apache.maven.api.services.MavenException;
24
25 /**
26 * Represents an exception that occurs during the invocation of a Maven build or command.
27 * This exception is typically thrown when there are errors during the execution of a Maven
28 * process, such as build failures, plugin errors, or other runtime issues.
29 *
30 * @since 4.0.0
31 */
32 @Experimental
33 public class InvokerException extends MavenException {
34 /**
35 * Constructs a new {@code InvokerException} with the specified detail message.
36 *
37 * @param message the detail message explaining the cause of the exception
38 */
39 public InvokerException(@Nullable String message) {
40 super(message);
41 }
42
43 /**
44 * Constructs a new {@code InvokerException} with the specified detail message and cause.
45 *
46 * @param message the detail message explaining the cause of the exception
47 * @param cause the underlying cause of the exception
48 */
49 public InvokerException(@Nullable String message, @Nullable Throwable cause) {
50 super(message, cause);
51 }
52
53 /**
54 * Exception for intentional exit: No message or anything will be displayed, just the
55 * carried exit code will be returned from invoker {@link Invoker#invoke(InvokerRequest)} method.
56 */
57 public static final class ExitException extends InvokerException {
58 private final int exitCode;
59
60 public ExitException(int exitCode) {
61 super("EXIT");
62 this.exitCode = exitCode;
63 }
64
65 public int getExitCode() {
66 return exitCode;
67 }
68 }
69 }