Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
InvocationResult |
|
| 1.0;1 |
1 | package org.apache.maven.shared.invoker; | |
2 | ||
3 | /* | |
4 | * Licensed to the Apache Software Foundation (ASF) under one | |
5 | * or more contributor license agreements. See the NOTICE file | |
6 | * distributed with this work for additional information | |
7 | * regarding copyright ownership. The ASF licenses this file | |
8 | * to you under the Apache License, Version 2.0 (the | |
9 | * "License"); you may not use this file except in compliance | |
10 | * with the License. You may obtain a copy of the License at | |
11 | * | |
12 | * http://www.apache.org/licenses/LICENSE-2.0 | |
13 | * | |
14 | * Unless required by applicable law or agreed to in writing, | |
15 | * software distributed under the License is distributed on an | |
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
17 | * KIND, either express or implied. See the License for the | |
18 | * specific language governing permissions and limitations | |
19 | * under the License. | |
20 | */ | |
21 | ||
22 | import org.codehaus.plexus.util.cli.CommandLineException; | |
23 | ||
24 | /** | |
25 | * Describes the result of a Maven invocation. | |
26 | * | |
27 | * @author jdcasey | |
28 | * @version $Id: InvocationResult.java 662043 2008-05-31 16:27:02Z bentmann $ | |
29 | */ | |
30 | public interface InvocationResult | |
31 | { | |
32 | ||
33 | /** | |
34 | * Gets the exception that possibly occurred during the execution of the command line. | |
35 | * | |
36 | * @return The exception that prevented to invoke Maven or <code>null</code> if the command line was successfully | |
37 | * processed by the operating system. | |
38 | */ | |
39 | CommandLineException getExecutionException(); | |
40 | ||
41 | /** | |
42 | * Gets the exit code from the Maven invocation. A non-zero value indicates a build failure. <strong>Note:</strong> | |
43 | * This value is undefined if {@link #getExecutionException()} reports an exception. | |
44 | * | |
45 | * @return The exit code from the Maven invocation. | |
46 | */ | |
47 | int getExitCode(); | |
48 | ||
49 | } |