View Javadoc
1   package org.apache.maven.shared.scriptinterpreter;
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  /**
23   * Signals an invalid value returned from script execution.
24   *
25   * @author Slawomir Jaranowski
26   * @since 1.3
27   */
28  public class ScriptReturnException extends ScriptException
29  {
30  
31      private static final long serialVersionUID = -4705573157701206786L;
32      /**
33       * Result
34       */
35      private final Object result;
36  
37      /**
38       * Creates a new exception with the specified message and result.
39       *
40       * @param message The message, may be <code>null</code>.
41       * @param result The cause, may be <code>null</code>.
42       */
43      ScriptReturnException( String message, Object result )
44      {
45          super( message );
46          this.result = result;
47      }
48  
49      /**
50       * Retrieve result returned by script.
51       *
52       * @return script result.
53       */
54      public Object getResult()
55      {
56          return result;
57      }
58  }