Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
ScriptInterpreter |
|
| 1.0;1 |
1 | package org.apache.maven.plugin.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 java.io.PrintStream; | |
23 | import java.util.List; | |
24 | import java.util.Map; | |
25 | ||
26 | /** | |
27 | * Defines a simple abstraction used to plug-in several script interpreters for the pre-/post-build-hooks. Each | |
28 | * interpretator implementation should be stateless and support reuse. | |
29 | * | |
30 | * @author Benjamin Bentmann | |
31 | * @version $Id: ScriptInterpreter.java 684549 2008-08-10 16:30:43Z bentmann $ | |
32 | */ | |
33 | interface ScriptInterpreter | |
34 | { | |
35 | ||
36 | /** | |
37 | * Evaluates the specified script. | |
38 | * | |
39 | * @param script The script contents to evalute, must not be <code>null</code>. | |
40 | * @param classPath The additional class path for the script interpreter, may be <code>null</code> or empty if only | |
41 | * the plugin realm should be used for the script evaluation. If specified, this class path will precede | |
42 | * the artifacts from the plugin class path. | |
43 | * @param globalVariables The global variables (as a mapping from variable name to value) to define for the script, | |
44 | * may be <code>null</code> if not used. | |
45 | * @param scriptOutput A print stream to redirect any output from the script to, may be <code>null</code> to use | |
46 | * stdout/stderr. | |
47 | * @return The return value from the script, can be <code>null</code> | |
48 | * @throws ScriptEvaluationException If the script evaluation produced an error. | |
49 | */ | |
50 | Object evaluateScript( String script, List classPath, Map globalVariables, PrintStream scriptOutput ) | |
51 | throws ScriptEvaluationException; | |
52 | ||
53 | } |