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