This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-bsf.git
The following commit(s) were added to refs/heads/master by this push:
new a0bf2b2 Javadoc
a0bf2b2 is described below
commit a0bf2b2fb416b79f05b4300183fd936c92f983a1
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:17:29 2026 -0400
Javadoc
---
src/main/java/org/apache/bsf/BSFManager.java | 8 ++++----
src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java | 6 +++---
src/main/java/org/apache/bsf/util/EngineUtils.java | 8 ++++----
src/main/java/org/apache/bsf/util/MethodUtils.java | 2 +-
src/main/java/org/apache/bsf/util/ReflectionUtils.java | 4 ++--
src/main/java/org/apache/bsf/util/cf/CodeFormatter.java | 8 ++++----
6 files changed, 18 insertions(+), 18 deletions(-)
diff --git a/src/main/java/org/apache/bsf/BSFManager.java
b/src/main/java/org/apache/bsf/BSFManager.java
index 918a3d1..dd17373 100644
--- a/src/main/java/org/apache/bsf/BSFManager.java
+++ b/src/main/java/org/apache/bsf/BSFManager.java
@@ -82,7 +82,7 @@ public class BSFManager {
/**
* Returns the defined ClassLoader (the ClassLoader that got used to
define the org.apache.bsf.BSFManager class object).
*
- * @return the defined ClassLoader instance
+ * @return The defined ClassLoader instance
*/
public static ClassLoader getDefinedClassLoader() // rgf, 20070917
{
@@ -545,7 +545,7 @@ public class BSFManager {
* Determine the language of a script file by looking at the file
extension.
*
* @param fileName the name of the file
- * @return the scripting language the file is in if the file extension is
known to me (must have been registered via registerScriptingEngine).
+ * @return The scripting language the file is in if the file extension is
known to me (must have been registered via registerScriptingEngine).
* @exception BSFException if file's extension is unknown.
*/
public static String getLangFromFilename(final String fileName) throws
BSFException {
@@ -612,7 +612,7 @@ public class BSFManager {
/**
* Return the current object registry of the manager.
*
- * @return the current registry.
+ * @return The current registry.
*/
public ObjectRegistry getObjectRegistry() {
return objectRegistry;
@@ -713,7 +713,7 @@ public class BSFManager {
* return a handle to a bean registered in the bean registry by the
application or a scripting engine. Returns null if bean is not found.
*
* @param beanName name of bean to look up
- * @return the bean if its found or null
+ * @return The bean if its found or null
*/
public Object lookupBean(final String beanName) {
logger.debug("BSFManager:lookupBean");
diff --git a/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java
b/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java
index 948ad27..6eb2148 100644
--- a/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java
+++ b/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java
@@ -247,7 +247,7 @@ public class JEXLEngine extends BSFEngineImpl {
*
* @param info the script source info
* @param file the script file
- * @return the source
+ * @return The source
*/
protected String readSource(JexlInfo info, final File file) {
Objects.requireNonNull(file, "file");
@@ -263,7 +263,7 @@ public class JEXLEngine extends BSFEngineImpl {
*
* @param info the script source info
* @param url the script url
- * @return the source
+ * @return The source
*/
protected String readSource(JexlInfo info, final URL url) {
Objects.requireNonNull(url, "url");
@@ -278,7 +278,7 @@ public class JEXLEngine extends BSFEngineImpl {
* Creates a string from a reader.
*
* @param reader to be read.
- * @return the contents of the reader as a String.
+ * @return The contents of the reader as a String.
* @throws IOException on any error reading the reader.
*/
protected static String toString(final BufferedReader reader) throws
IOException {
diff --git a/src/main/java/org/apache/bsf/util/EngineUtils.java
b/src/main/java/org/apache/bsf/util/EngineUtils.java
index 6ecbb7f..632e729 100644
--- a/src/main/java/org/apache/bsf/util/EngineUtils.java
+++ b/src/main/java/org/apache/bsf/util/EngineUtils.java
@@ -128,7 +128,7 @@ public class EngineUtils {
* @param bean the object on which to invoke the method
* @param methodName name of the method
* @param args arguments to be given to the method
- * @return the result of invoking the method, if any
+ * @return The result of invoking the method, if any
* @exception BSFException if something goes wrong
*/
public static Object callBeanMethod(final Object bean, final String
methodName, final Object[] args) throws BSFException {
@@ -217,7 +217,7 @@ public class EngineUtils {
*
* @param className fully qualified name of class to instantiate
* @param args array of constructor args (or null if none)
- * @return the created bean
+ * @return The created bean
* @exception BSFException if something goes wrong (@see
org.apache.cs.util.MethodUtils for the real exceptions that can occur).
*/
public static Object createBean(final String className, final Object
args[]) throws BSFException {
@@ -266,7 +266,7 @@ public class EngineUtils {
* Given a class return the type signature string fragment for it. That
is, return "I" for int, "J" for long, ... etc..
*
* @param cl class object for whom the signature fragment is needed.
- * @return the string representing the type signature
+ * @return The string representing the type signature
*/
public static String getTypeSignatureString(final Class cl) {
if (cl.isPrimitive()) {
@@ -308,7 +308,7 @@ public class EngineUtils {
*
* @param mgr BSFManager who's classLoader and tempDir props are consulted
* @param name name of the class to load
- * @return the loaded class
+ * @return The loaded class
* @exception BSFException if something goes wrong.
*/
public static Class loadClass(final BSFManager mgr, final String name)
throws BSFException {
diff --git a/src/main/java/org/apache/bsf/util/MethodUtils.java
b/src/main/java/org/apache/bsf/util/MethodUtils.java
index 5741628..5f23177 100644
--- a/src/main/java/org/apache/bsf/util/MethodUtils.java
+++ b/src/main/java/org/apache/bsf/util/MethodUtils.java
@@ -310,7 +310,7 @@ public class MethodUtils {
* @param target object on which call is to be made
* @param methodName name of method I'm lookin' for
* @param argTypes array of argument types of method
- * @return the desired method
+ * @return The desired method
* @exception SecurityException if security violation
* @exception NoSuchMethodException if no such method
*/
diff --git a/src/main/java/org/apache/bsf/util/ReflectionUtils.java
b/src/main/java/org/apache/bsf/util/ReflectionUtils.java
index 219e591..d908323 100644
--- a/src/main/java/org/apache/bsf/util/ReflectionUtils.java
+++ b/src/main/java/org/apache/bsf/util/ReflectionUtils.java
@@ -193,7 +193,7 @@ public class ReflectionUtils {
* @param className name of class to instantiate
* @param argTypes array of argument types
* @param args array of arguments
- * @return the newly created bean
+ * @return The newly created bean
* @exception ClassNotFoundException if class is not loaded
* @exception NoSuchMethodException if constructor can't be found
* @exception InstantiationException if class can't be instantiated
@@ -258,7 +258,7 @@ public class ReflectionUtils {
* @param cld the class loader to use. If null, Class.forName is
used.
* @param className name of class to instantiate
* @param args array of arguments
- * @return the newly created bean
+ * @return The newly created bean
* @exception ClassNotFoundException if class is not loaded
* @exception NoSuchMethodException if constructor can't be found
* @exception InstantiationException if class can't be instantiated
diff --git a/src/main/java/org/apache/bsf/util/cf/CodeFormatter.java
b/src/main/java/org/apache/bsf/util/cf/CodeFormatter.java
index 41dd42c..7933d24 100644
--- a/src/main/java/org/apache/bsf/util/cf/CodeFormatter.java
+++ b/src/main/java/org/apache/bsf/util/cf/CodeFormatter.java
@@ -121,7 +121,7 @@ public class CodeFormatter {
/**
* Gets the set of delimiters.
*
- * @return the set of delimiters.
+ * @return The set of delimiters.
* @see #setDelimiters
*/
public String getDelimiters() {
@@ -131,7 +131,7 @@ public class CodeFormatter {
/**
* Gets the size of the indentation step.
*
- * @return the size of the indentation step.
+ * @return The size of the indentation step.
* @see #setIndentationStep
*/
public int getIndentationStep() {
@@ -141,7 +141,7 @@ public class CodeFormatter {
/**
* Gets the maximum line length.
*
- * @return the maximum line length.
+ * @return The maximum line length.
* @see #setMaxLineLength
*/
public int getMaxLineLength() {
@@ -151,7 +151,7 @@ public class CodeFormatter {
/**
* Gets the set of sticky delimiters.
*
- * @return the set of sticky delimiters.
+ * @return The set of sticky delimiters.
* @see #setStickyDelimiters
*/
public String getStickyDelimiters() {
