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.codehaus.plexus.util.cli.CommandLineException;
23  
24  /**
25   * Describes the result of a Maven invocation.
26   * 
27   * @version $Id: DefaultInvocationResult.java 662043 2008-05-31 16:27:02Z bentmann $
28   */
29  public final class DefaultInvocationResult
30      implements InvocationResult
31  {
32  
33      /**
34       * The exception that prevented to execute the command line, will be <code>null</code> if Maven could be
35       * successfully started.
36       */
37      private CommandLineException executionException;
38  
39      /**
40       * The exit code reported by the Maven invocation.
41       */
42      private int exitCode = Integer.MIN_VALUE;
43  
44      /**
45       * Creates a new invocation result
46       */
47      DefaultInvocationResult()
48      {
49          // hide constructor
50      }
51  
52      public int getExitCode()
53      {
54          return exitCode;
55      }
56  
57      public CommandLineException getExecutionException()
58      {
59          return executionException;
60      }
61  
62      /**
63       * Sets the exit code reported by the Maven invocation.
64       * 
65       * @param exitCode The exit code reported by the Maven invocation.
66       */
67      void setExitCode( int exitCode )
68      {
69          this.exitCode = exitCode;
70      }
71  
72      /**
73       * Sets the exception that prevented to execute the command line.
74       * 
75       * @param executionException The exception that prevented to execute the command line, may be <code>null</code>.
76       */
77      void setExecutionException( CommandLineException executionException )
78      {
79          this.executionException = executionException;
80      }
81  
82  }