This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-bsf.git
commit f6d4037490bfc39b8e428c88ceb3e80a1e506944 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu Nov 28 11:39:18 2024 -0500 No need for blank Javadoc lines between Javadoc @ tags --- src/main/java/org/apache/bsf/BSFEngine.java | 11 ----------- src/main/java/org/apache/bsf/BSFManager.java | 13 ------------- src/main/java/org/apache/bsf/Main.java | 1 - src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java | 8 -------- src/main/java/org/apache/bsf/util/EngineUtils.java | 8 -------- src/main/java/org/apache/bsf/util/MethodUtils.java | 4 ---- src/main/java/org/apache/bsf/util/ReflectionUtils.java | 7 ------- src/main/java/org/apache/bsf/util/cf/CFDriver.java | 1 - 8 files changed, 53 deletions(-) diff --git a/src/main/java/org/apache/bsf/BSFEngine.java b/src/main/java/org/apache/bsf/BSFEngine.java index 4cfd4a6..bf31fff 100644 --- a/src/main/java/org/apache/bsf/BSFEngine.java +++ b/src/main/java/org/apache/bsf/BSFEngine.java @@ -47,7 +47,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param funcBody the multi-line, value returning script to evaluate * @param paramNames the names of the parameters above assumes * @param arguments values of the above parameters - * * @exception BSFException if anything goes wrong while doin' it. */ Object apply(String source, int lineNo, int columnNo, Object funcBody, Vector paramNames, Vector arguments) throws BSFException; @@ -60,7 +59,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param object object on which to make the call * @param name name of the method / procedure to call * @param args the arguments to be given to the procedure - * * @exception BSFException if anything goes wrong while eval'ing a BSFException is thrown. The reason indicates the problem. */ Object call(Object object, String name, Object[] args) throws BSFException; @@ -75,7 +73,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param paramNames the names of the parameters above assumes * @param arguments values of the above parameters * @param cb the CodeBuffer to compile into - * * @exception BSFException if anything goes wrong while doin' it. */ void compileApply(String source, int lineNo, int columnNo, Object funcBody, Vector paramNames, Vector arguments, CodeBuffer cb) throws BSFException; @@ -89,7 +86,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param columnNo (context info) the column number in source for expr * @param expr the expression to compile * @param cb the CodeBuffer to compile into - * * @exception BSFException if anything goes wrong while compiling a BSFException is thrown. The reason indicates the problem. */ void compileExpr(String source, int lineNo, int columnNo, Object expr, CodeBuffer cb) throws BSFException; @@ -103,7 +99,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param columnNo (context info) the column number in source for script * @param script the script to compile * @param cb the CodeBuffer to compile into - * * @exception BSFException if anything goes wrong while compiling a BSFException is thrown. The reason indicates the problem. */ void compileScript(String source, int lineNo, int columnNo, Object script, CodeBuffer cb) throws BSFException; @@ -113,7 +108,6 @@ public interface BSFEngine extends PropertyChangeListener { * in the most first class way possible. * * @param bean the bean to declare - * * @exception BSFException if the engine cannot do this operation */ void declareBean(BSFDeclaredBean bean) throws BSFException; @@ -126,7 +120,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param lineNo (context info) the line number in source for expr * @param columnNo (context info) the column number in source for expr * @param expr the expression to evaluate - * * @exception BSFException if anything goes wrong while eval'ing a BSFException is thrown. The reason indicates the problem. */ Object eval(String source, int lineNo, int columnNo, Object expr) throws BSFException; @@ -139,7 +132,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param lineNo (context info) the line number in source for expr * @param columnNo (context info) the column number in source for expr * @param script the script to execute - * * @exception BSFException if anything goes wrong while exec'ing a BSFException is thrown. The reason indicates the problem. */ void exec(String source, int lineNo, int columnNo, Object script) throws BSFException; @@ -152,7 +144,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param lineNo (context info) the line number in source for expr * @param columnNo (context info) the column number in source for expr * @param script the script to execute - * * @exception BSFException if anything goes wrong while exec'ing a BSFException is thrown. The reason indicates the problem. */ void iexec(String source, int lineNo, int columnNo, Object script) throws BSFException; @@ -165,7 +156,6 @@ public interface BSFEngine extends PropertyChangeListener { * @param mgr The BSFManager that's hosting this engine. * @param lang Language string which this engine is handling. * @param declaredBeans Vector of BSFDeclaredObject containing beans that should be declared into the language runtime at init time as best as possible. - * * @exception BSFException if anything goes wrong while init'ing a BSFException is thrown. The reason indicates the problem. */ void initialize(BSFManager mgr, String lang, Vector declaredBeans) throws BSFException; @@ -179,7 +169,6 @@ public interface BSFEngine extends PropertyChangeListener { * Undeclare a previously declared bean. * * @param bean the bean to undeclare - * * @exception BSFException if the engine cannot do this operation */ void undeclareBean(BSFDeclaredBean bean) throws BSFException; diff --git a/src/main/java/org/apache/bsf/BSFManager.java b/src/main/java/org/apache/bsf/BSFManager.java index 6543d77..a649e0a 100644 --- a/src/main/java/org/apache/bsf/BSFManager.java +++ b/src/main/java/org/apache/bsf/BSFManager.java @@ -237,7 +237,6 @@ public class BSFManager { * @param funcBody the multi-line, value returning script to evaluate * @param paramNames the names of the parameters above assumes * @param arguments values of the above parameters - * * @exception BSFException if anything goes wrong while running the script */ public Object apply(final String lang, final String source, final int lineNo, final int columnNo, final Object funcBody, final Vector paramNames, @@ -279,7 +278,6 @@ public class BSFManager { * @param paramNames the names of the parameters above assumes * @param arguments values of the above parameters * @param cb code buffer to compile into - * * @exception BSFException if anything goes wrong while running the script */ public void compileApply(final String lang, final String source, final int lineNo, final int columnNo, final Object funcBody, final Vector paramNames, @@ -317,7 +315,6 @@ public class BSFManager { * @param columnNo (context info) the column number in source for expr * @param expr the expression to compile * @param cb code buffer to compile into - * * @exception BSFException if any error while compiling the expression */ public void compileExpr(final String lang, final String source, final int lineNo, final int columnNo, final Object expr, final CodeBuffer cb) @@ -353,7 +350,6 @@ public class BSFManager { * @param columnNo (context info) the column number in source for script * @param script the script to compile * @param cb code buffer to compile into - * * @exception BSFException if any error while compiling the script */ public void compileScript(final String lang, final String source, final int lineNo, final int columnNo, final Object script, final CodeBuffer cb) @@ -396,7 +392,6 @@ public class BSFManager { * @param beanName name to declare bean as * @param bean the bean that's being declared * @param type the type to represent the bean as - * * @exception BSFException if any of the languages that are already running decides to throw an exception when asked to declare this bean. */ public void declareBean(final String beanName, final Object bean, final Class type) throws BSFException { @@ -423,7 +418,6 @@ public class BSFManager { * @param lineNo (context info) the line number in source for expr * @param columnNo (context info) the column number in source for expr * @param expr the expression to evaluate - * * @exception BSFException if anything goes wrong while running the script */ public Object eval(final String lang, final String source, final int lineNo, final int columnNo, final Object expr) throws BSFException { @@ -466,7 +460,6 @@ public class BSFManager { * @param lineNo (context info) the line number in source for expr * @param columnNo (context info) the column number in source for expr * @param script the script to execute - * * @exception BSFException if anything goes wrong while running the script */ public void exec(final String lang, final String source, final int lineNo, final int columnNo, final Object script) throws BSFException { @@ -499,7 +492,6 @@ public class BSFManager { * @param lineNo (context info) the line number in source for expr * @param columnNo (context info) the column number in source for expr * @param script the script to execute - * * @exception BSFException if anything goes wrong while running the script */ public void iexec(final String lang, final String source, final int lineNo, final int columnNo, final Object script) throws BSFException { @@ -553,9 +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). - * * @exception BSFException if file's extension is unknown. */ public static String getLangFromFilename(final String fileName) throws BSFException { @@ -639,7 +629,6 @@ public class BSFManager { * Determine whether a language is registered. * * @param lang string identifying a language - * * @return true iff it is */ public static boolean isLanguageRegistered(final String lang) { @@ -724,7 +713,6 @@ 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 */ public Object lookupBean(final String beanName) { @@ -850,7 +838,6 @@ public class BSFManager { * the bean is unknown. * * @param beanName name of bean to undeclare - * * @exception BSFException if any of the languages that are already running decides to throw an exception when asked to undeclare this bean. */ public void undeclareBean(final String beanName) throws BSFException { diff --git a/src/main/java/org/apache/bsf/Main.java b/src/main/java/org/apache/bsf/Main.java index ad37dee..b2c5815 100644 --- a/src/main/java/org/apache/bsf/Main.java +++ b/src/main/java/org/apache/bsf/Main.java @@ -50,7 +50,6 @@ public class Main { * Static driver to be able to run BSF scripts from the command line. * * @param args command line arguments - * * @exception IOException if any I/O error while loading script */ public static void main(final String[] args) throws IOException { 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 28d0d83..e5dff77 100644 --- a/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java +++ b/src/main/java/org/apache/bsf/engines/jexl/JEXLEngine.java @@ -47,7 +47,6 @@ public class JEXLEngine extends BSFEngineImpl { * @param mgr The {@link BSFManager}. * @param lang The language. * @param declaredBeans The vector of the initially declared beans. - * * @throws BSFException For any exception that occurs while trying to initialize the engine. */ public void initialize(final BSFManager mgr, final String lang, final Vector declaredBeans) throws BSFException { @@ -73,7 +72,6 @@ public class JEXLEngine extends BSFEngineImpl { * Adds this bean to the backing JexlContext. * * @param bean The {@link BSFDeclaredBean} to be added to the backing context. - * * @throws BSFException For any exception that occurs while trying to declare the bean. */ public void declareBean(final BSFDeclaredBean bean) throws BSFException { @@ -84,7 +82,6 @@ public class JEXLEngine extends BSFEngineImpl { * Removes this bean from the backing JexlContext. * * @param bean The {@link BSFDeclaredBean} to be removed from the backing context. - * * @throws BSFException For any exception that occurs while trying to undeclare the bean. */ public void undeclareBean(final BSFDeclaredBean bean) throws BSFException { @@ -98,7 +95,6 @@ public class JEXLEngine extends BSFEngineImpl { * @param lineNo The line number, if it is available. * @param colNo The column number, if it is available. * @param expr The expression to be evaluated. - * * @throws BSFException For any exception that occurs while evaluating the expression. */ public Object eval(final String fileName, final int lineNo, final int colNo, final Object expr) throws BSFException { @@ -127,7 +123,6 @@ public class JEXLEngine extends BSFEngineImpl { * @param lineNo The line number, if it is available. * @param colNo The column number, if it is available. * @param script The script to be executed. - * * @throws BSFException For any exception that occurs while executing the script. */ public void exec(final String fileName, final int lineNo, final int colNo, final Object script) throws BSFException { @@ -156,7 +151,6 @@ public class JEXLEngine extends BSFEngineImpl { * @param lineNo The line number, if it is available. * @param colNo The column number, if it is available. * @param script The script to be executed. - * * @throws BSFException For any exception that occurs while interactively executing the script. */ public void iexec(final String fileName, final int lineNo, final int colNo, final Object script) throws BSFException { @@ -169,9 +163,7 @@ public class JEXLEngine extends BSFEngineImpl { * @param object The object to make the call on. * @param name The call to make. * @param args The arguments to pass. - * * @return The result of the call. - * * @throws BSFException For any exception that occurs while making the call. */ public Object call(final Object object, final String name, final Object[] args) throws BSFException { diff --git a/src/main/java/org/apache/bsf/util/EngineUtils.java b/src/main/java/org/apache/bsf/util/EngineUtils.java index ccceb00..1a84711 100644 --- a/src/main/java/org/apache/bsf/util/EngineUtils.java +++ b/src/main/java/org/apache/bsf/util/EngineUtils.java @@ -72,7 +72,6 @@ public class EngineUtils { * @param lineNo (context info) the line number in source for expr * @param columnNo (context info) the column number in source for expr * @param script the script to execute when the event occurs - * * @exception BSFException if anything goes wrong while running the script */ public static void addEventListener(final Object bean, final String eventSetName, final String filter, final BSFEngine engine, final BSFManager manager, @@ -129,9 +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 - * * @exception BSFException if something goes wrong */ public static Object callBeanMethod(final Object bean, final String methodName, final Object[] args) throws BSFException { @@ -220,9 +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 - * * @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 { @@ -271,7 +266,6 @@ 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 */ public static String getTypeSignatureString(final Class cl) { @@ -313,9 +307,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 - * * @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 493facb..d347a6c 100644 --- a/src/main/java/org/apache/bsf/util/MethodUtils.java +++ b/src/main/java/org/apache/bsf/util/MethodUtils.java @@ -201,9 +201,7 @@ public class MethodUtils { * classes -- Integer.TYPE rather than Integer. "null" may be passed in as an indication that you intend to invoke the method with * a literal null argument and therefore can accept any object type in this position. * @param isStaticReference If true, and if the target is a Class object, only static methods will be accepted as valid matches. - * * @return a Method or Constructor of the appropriate signature - * * @exception SecurityException if security violation * @exception NoSuchMethodException if no such method */ @@ -311,9 +309,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 - * * @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 ba09f7f..40b0725 100644 --- a/src/main/java/org/apache/bsf/util/ReflectionUtils.java +++ b/src/main/java/org/apache/bsf/util/ReflectionUtils.java @@ -68,7 +68,6 @@ public class ReflectionUtils { * @param source event source * @param eventSetName name of event set from event src to bind to * @param processor event processor the event should be delegated to when it occurs; either via processEvent or processExceptionableEvent. - * * @exception IntrospectionException if unable to introspect * @exception IllegalArgumentException if event set is unknown * @exception IllegalAccessException if the event adapter class or initializer is not accessible. @@ -194,9 +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 - * * @exception ClassNotFoundException if class is not loaded * @exception NoSuchMethodException if constructor can't be found * @exception InstantiationException if class can't be instantiated @@ -261,9 +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 - * * @exception ClassNotFoundException if class is not loaded * @exception NoSuchMethodException if constructor can't be found * @exception InstantiationException if class can't be instantiated @@ -320,7 +315,6 @@ public class ReflectionUtils { * @param target the object whose prop is to be gotten * @param propName name of the property to set * @param index index to get (if property is indexed) - * * @exception IntrospectionException if unable to introspect * @exception IllegalArgumentException if problems with args: if the property is unknown, or if the property is given an index when its not, or if the * property is not writeable, or if the given value cannot be assigned to the it (type mismatch). @@ -411,7 +405,6 @@ public class ReflectionUtils { * @param value the property value * @param valueType the type of the above (needed when its null) * @param tcr type convertor registry to use to convert value type to property type if necessary - * * @exception IntrospectionException if unable to introspect * @exception IllegalArgumentException if problems with args: if the property is unknown, or if the property is given an index when its not, or if the * property is not writeable, or if the given value cannot be assigned to the it (type mismatch). diff --git a/src/main/java/org/apache/bsf/util/cf/CFDriver.java b/src/main/java/org/apache/bsf/util/cf/CFDriver.java index d25611d..463af0e 100644 --- a/src/main/java/org/apache/bsf/util/cf/CFDriver.java +++ b/src/main/java/org/apache/bsf/util/cf/CFDriver.java @@ -34,7 +34,6 @@ import java.io.Writer; * can also be used as a filter. * * @see CodeFormatter - * * @version 1.0 */ public class CFDriver {