View Javadoc
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   */
27  public final class DefaultInvocationResult implements InvocationResult {
28  
29      /**
30       * The exception that prevented to execute the command line, will be <code>null</code> if Maven could be
31       * successfully started.
32       */
33      private CommandLineException executionException;
34  
35      /**
36       * The exit code reported by the Maven invocation.
37       */
38      private int exitCode = Integer.MIN_VALUE;
39  
40      /**
41       * Creates a new invocation result
42       */
43      DefaultInvocationResult() {
44          // hide constructor
45      }
46  
47      /**
48       * <p>Getter for the field <code>exitCode</code>.</p>
49       *
50       * @return a int.
51       */
52      public int getExitCode() {
53          return exitCode;
54      }
55  
56      /**
57       * <p>Getter for the field <code>executionException</code>.</p>
58       *
59       * @return a {@link org.apache.maven.shared.utils.cli.CommandLineException} object.
60       */
61      public CommandLineException getExecutionException() {
62          return executionException;
63      }
64  
65      /**
66       * Sets the exit code reported by the Maven invocation.
67       *
68       * @param exitCode The exit code reported by the Maven invocation.
69       */
70      void setExitCode(int exitCode) {
71          this.exitCode = exitCode;
72      }
73  
74      /**
75       * Sets the exception that prevented to execute the command line.
76       *
77       * @param executionException The exception that prevented to execute the command line, may be <code>null</code>.
78       */
79      void setExecutionException(CommandLineException executionException) {
80          this.executionException = executionException;
81      }
82  }