This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-scripting-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 3596310 Fix Javadoc issues per Oracle conventions (#64)
3596310 is described below
commit 359631008fe3585e707b5606d12556559c5cd183
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Sun Dec 28 13:40:40 2025 +0000
Fix Javadoc issues per Oracle conventions (#64)
---
.../maven/plugins/scripting/AbstractScriptEvaluator.java | 10 ++++++----
.../java/org/apache/maven/plugins/scripting/EvalMojo.java | 4 ++--
.../maven/plugins/scripting/FileScriptEvaluator.java | 15 ++++++++-------
.../maven/plugins/scripting/ResourceScriptEvaluator.java | 14 +++++++-------
.../maven/plugins/scripting/StringScriptEvaluator.java | 15 ++++++++-------
.../scripting/UnsupportedScriptEngineException.java | 3 +--
6 files changed, 32 insertions(+), 29 deletions(-)
diff --git
a/src/main/java/org/apache/maven/plugins/scripting/AbstractScriptEvaluator.java
b/src/main/java/org/apache/maven/plugins/scripting/AbstractScriptEvaluator.java
index d6bfb3a..3ebf907 100644
---
a/src/main/java/org/apache/maven/plugins/scripting/AbstractScriptEvaluator.java
+++
b/src/main/java/org/apache/maven/plugins/scripting/AbstractScriptEvaluator.java
@@ -28,7 +28,8 @@ import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.scripting.engine.ContextAwareEngine;
/**
- * Evaluates a script in the appropriate context and return its possibly null
result
+ * Evaluates a script in the appropriate context and return its possibly null
result.
+ *
* @author Rusi Popov
*/
abstract class AbstractScriptEvaluator {
@@ -37,8 +38,8 @@ abstract class AbstractScriptEvaluator {
* @param bindings not null bindings to provide to the script to execute
* @param log engine logger if context aware
* @return the possibly null result the script produced
+ * @throws ScriptException if an error occurs in script
* @throws UnsupportedScriptEngineException when the engine is not
configured correctly
- * @throws ScriptException if an error occurs in script.
*/
protected final Object eval(Bindings bindings, Log log) throws
ScriptException, UnsupportedScriptEngineException {
ScriptEngineManager manager = new ScriptEngineManager();
@@ -54,11 +55,12 @@ abstract class AbstractScriptEvaluator {
}
/**
- * AbstractScriptEvaluator the script
+ * AbstractScriptEvaluator the script.
+ *
* @param engine not null
* @param context not null, initialized
* @return possibly null result of the script
- * @throws ScriptException if an error occurs in script.
+ * @throws ScriptException if an error occurs in script
*/
protected abstract Object eval(ScriptEngine engine, ScriptContext context)
throws ScriptException;
diff --git a/src/main/java/org/apache/maven/plugins/scripting/EvalMojo.java
b/src/main/java/org/apache/maven/plugins/scripting/EvalMojo.java
index ec55f24..43f9f22 100644
--- a/src/main/java/org/apache/maven/plugins/scripting/EvalMojo.java
+++ b/src/main/java/org/apache/maven/plugins/scripting/EvalMojo.java
@@ -32,7 +32,7 @@ import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
/**
- * Evaluate the specified script or scriptFile
+ * Evaluate the specified script or scriptFile.
*
* @author Robert Scholte
* @since 3.0.0
@@ -43,7 +43,7 @@ public class EvalMojo extends AbstractMojo {
private String engineName;
/**
- * When used, also specify the engineName
+ * When used, also specify the engineName.
*/
@Parameter
private String script;
diff --git
a/src/main/java/org/apache/maven/plugins/scripting/FileScriptEvaluator.java
b/src/main/java/org/apache/maven/plugins/scripting/FileScriptEvaluator.java
index 0b1dff9..f48c2a8 100644
--- a/src/main/java/org/apache/maven/plugins/scripting/FileScriptEvaluator.java
+++ b/src/main/java/org/apache/maven/plugins/scripting/FileScriptEvaluator.java
@@ -31,17 +31,18 @@ import java.io.UncheckedIOException;
/**
* Evaluates a script held in a file. Use the engine name to override the
engine if the file name does not refer/decode
* to a valid engine name or not define any at all.
+ *
* @author Rusi Popov
*/
public class FileScriptEvaluator extends AbstractScriptEvaluator {
/**
- * Not null, existing readable file with the script
+ * Not null, existing readable file with the script.
*/
private final File scriptFile;
/**
- * Possibly null engine name
+ * Possibly null engine name.
*/
private final String engineName;
@@ -56,10 +57,10 @@ public class FileScriptEvaluator extends
AbstractScriptEvaluator {
}
/**
- * @param engine the script engine.
- * @param context the script context.
- * @return the result of the scriptFile.
- * @throws ScriptException if an error occurs in script.
+ * @param engine the script engine
+ * @param context the script context
+ * @return the result of the scriptFile
+ * @throws ScriptException if an error occurs in script
* @see
org.apache.maven.plugins.scripting.AbstractScriptEvaluator#eval(javax.script.ScriptEngine,
javax.script.ScriptContext)
*/
protected Object eval(ScriptEngine engine, ScriptContext context) throws
ScriptException {
@@ -71,7 +72,7 @@ public class FileScriptEvaluator extends
AbstractScriptEvaluator {
}
/**
- * Gets the script engine by engineName, otherwise by extension of the
sciptFile
+ * Gets the script engine by engineName, otherwise by extension of the
sciptFile.
*
* @param manager the script engine manager
* @throws UnsupportedScriptEngineException if specified engine is not
available
diff --git
a/src/main/java/org/apache/maven/plugins/scripting/ResourceScriptEvaluator.java
b/src/main/java/org/apache/maven/plugins/scripting/ResourceScriptEvaluator.java
index f0adb4d..8db4eb6 100644
---
a/src/main/java/org/apache/maven/plugins/scripting/ResourceScriptEvaluator.java
+++
b/src/main/java/org/apache/maven/plugins/scripting/ResourceScriptEvaluator.java
@@ -38,12 +38,12 @@ import java.io.UncheckedIOException;
public class ResourceScriptEvaluator extends AbstractScriptEvaluator {
/**
- * Not null, existing readable file with the script
+ * Not null, existing readable file with the script.
*/
private final String resourceName;
/**
- * Possibly null engine name
+ * Possibly null engine name.
*/
private final String engineName;
@@ -58,10 +58,10 @@ public class ResourceScriptEvaluator extends
AbstractScriptEvaluator {
}
/**
- * @param engine the script engine.
- * @param context the script context.
- * @return the result of the scriptFile.
- * @throws ScriptException if an error occurs in script.
+ * @param engine the script engine
+ * @param context the script context
+ * @return the result of the scriptFile
+ * @throws ScriptException if an error occurs in script
* @see
org.apache.maven.plugins.scripting.AbstractScriptEvaluator#eval(javax.script.ScriptEngine,
javax.script.ScriptContext)
*/
protected Object eval(ScriptEngine engine, ScriptContext context) throws
ScriptException {
@@ -75,7 +75,7 @@ public class ResourceScriptEvaluator extends
AbstractScriptEvaluator {
}
/**
- * Gets the script engine by engineName, otherwise by extension of the
sciptFile
+ * Gets the script engine by engineName, otherwise by extension of the
sciptFile.
*
* @param manager the script engine manager
* @throws UnsupportedScriptEngineException if specified engine is not
available
diff --git
a/src/main/java/org/apache/maven/plugins/scripting/StringScriptEvaluator.java
b/src/main/java/org/apache/maven/plugins/scripting/StringScriptEvaluator.java
index 8408888..2f26c87 100644
---
a/src/main/java/org/apache/maven/plugins/scripting/StringScriptEvaluator.java
+++
b/src/main/java/org/apache/maven/plugins/scripting/StringScriptEvaluator.java
@@ -24,18 +24,19 @@ import javax.script.ScriptEngineManager;
import javax.script.ScriptException;
/**
- * Evaluates a script held in a string
+ * Evaluates a script held in a string.
+ *
* @author Rusi Popov
*/
public class StringScriptEvaluator extends AbstractScriptEvaluator {
/**
- * Not null name of the engine to execute the script
+ * Not null name of the engine to execute the script.
*/
private final String engineName;
/**
- * The non-null script itself
+ * The non-null script itself.
*/
private final String script;
@@ -57,7 +58,7 @@ public class StringScriptEvaluator extends
AbstractScriptEvaluator {
}
/**
- * @param manager the script engine manager.
+ * @param manager the script engine manager
* @throws UnsupportedScriptEngineException if the engineName is not
supported
* @see
org.apache.maven.plugins.scripting.AbstractScriptEvaluator#getEngine(javax.script.ScriptEngineManager)
*/
@@ -71,9 +72,9 @@ public class StringScriptEvaluator extends
AbstractScriptEvaluator {
}
/**
- * @param engine the script engine.
- * @param context the script context.
- * @throws ScriptException if an error occurs in script.
+ * @param engine the script engine
+ * @param context the script context
+ * @throws ScriptException if an error occurs in script
* @see
org.apache.maven.plugins.scripting.AbstractScriptEvaluator#eval(javax.script.ScriptEngine,
javax.script.ScriptContext)
*/
protected Object eval(ScriptEngine engine, ScriptContext context) throws
ScriptException {
diff --git
a/src/main/java/org/apache/maven/plugins/scripting/UnsupportedScriptEngineException.java
b/src/main/java/org/apache/maven/plugins/scripting/UnsupportedScriptEngineException.java
index 52a9118..6e5d97e 100644
---
a/src/main/java/org/apache/maven/plugins/scripting/UnsupportedScriptEngineException.java
+++
b/src/main/java/org/apache/maven/plugins/scripting/UnsupportedScriptEngineException.java
@@ -19,10 +19,9 @@
package org.apache.maven.plugins.scripting;
/**
- * Exception
+ * Exception.
*
* @author Robert Scholte
- *
*/
public class UnsupportedScriptEngineException extends Exception {
public UnsupportedScriptEngineException(String message) {
