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