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.shared.invoker;
20
21 import org.apache.maven.shared.utils.cli.CommandLineException;
22
23 /**
24 * Describes the result of a Maven invocation.
25 *
26 * @author jdcasey
27 */
28 public interface InvocationResult {
29
30 /**
31 * Gets the exception that possibly occurred during the execution of the command line.
32 *
33 * @return The exception that prevented to invoke Maven or <code>null</code> if the command line was successfully
34 * processed by the operating system.
35 */
36 CommandLineException getExecutionException();
37
38 /**
39 * Gets the exit code from the Maven invocation. A non-zero value indicates a build failure. <strong>Note:</strong>
40 * This value is undefined if {@link #getExecutionException()} reports an exception.
41 *
42 * @return The exit code from the Maven invocation.
43 */
44 int getExitCode();
45 }