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-jelly.git
The following commit(s) were added to refs/heads/master by this push:
new 3009b757 Javadoc
3009b757 is described below
commit 3009b757e5550f36cb1e0867d8ba27092a9ccfff
Author: Gary Gregory <[email protected]>
AuthorDate: Sun Aug 2 15:54:10 2026 -0400
Javadoc
---
.../org/apache/commons/jelly/parser/XMLParser.java | 44 +++++++++++-----------
.../apache/commons/jelly/avalon/JellyService.java | 10 ++---
.../apache/commons/digester/rss/RSSDigester.java | 16 ++++----
.../commons/jelly/tags/soap/StringInputStream.java | 6 +--
.../javax/servlet/jsp/jstl/sql/ResultImpl.java | 2 +-
.../apache/commons/jelly/tags/sql/ResultImpl.java | 2 +-
.../apache/commons/jelly/swing/TestSwingTags.java | 2 +-
7 files changed, 41 insertions(+), 41 deletions(-)
diff --git a/core/src/main/java/org/apache/commons/jelly/parser/XMLParser.java
b/core/src/main/java/org/apache/commons/jelly/parser/XMLParser.java
index 1316a48d..7d076cd0 100644
--- a/core/src/main/java/org/apache/commons/jelly/parser/XMLParser.java
+++ b/core/src/main/java/org/apache/commons/jelly/parser/XMLParser.java
@@ -262,7 +262,7 @@ public class XMLParser extends DefaultHandler {
* @param buffer The characters from the XML document
* @param start Starting offset into the buffer
* @param length Number of characters from the buffer
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void characters(final char buffer[], final int start, final int
length)
@@ -531,7 +531,7 @@ public class XMLParser extends DefaultHandler {
/**
* Process notification of the end of the document being reached.
*
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void endDocument() throws SAXException {
@@ -548,7 +548,7 @@ public class XMLParser extends DefaultHandler {
* string if Namespace processing is not being performed.
* @param qName The qualified XML 1.0 name (with prefix), or the
* empty string if qualified names are not available.
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void endElement(final String namespaceURI, final String localName,
final String qName)
@@ -585,7 +585,7 @@ public class XMLParser extends DefaultHandler {
* Process notification that a namespace prefix is going out of scope.
*
* @param prefix Prefix that is going out of scope
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void endPrefixMapping(final String prefix) throws SAXException {
@@ -621,7 +621,7 @@ public class XMLParser extends DefaultHandler {
* error handler, if any, otherwise throw a SAXException with the error.
*
* @param exception The error information
- * @throws SAXException if a parsing exception occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
@Override
public void error(final SAXParseException exception) throws SAXException {
@@ -644,7 +644,7 @@ public class XMLParser extends DefaultHandler {
* supplied error handler, if any, otherwise throw a SAXException with the
error.
*
* @param exception The fatal error information
- * @throws SAXException if a parsing exception occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
@Override
public void fatalError(final SAXParseException exception) throws
SAXException {
@@ -871,7 +871,7 @@ public class XMLParser extends DefaultHandler {
/**
* Return the XMLReader to be used for parsing the input document.
*
- * @throws SAXException if no XMLReader can be instantiated
+ * @throws SAXException Thrown if no XMLReader can be instantiated
*/
public synchronized XMLReader getXMLReader() throws SAXException {
if (reader == null) {
@@ -901,7 +901,7 @@ public class XMLParser extends DefaultHandler {
* @param buffer The characters from the XML document
* @param start Starting offset into the buffer
* @param len Number of characters from the buffer
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void ignorableWhitespace(final char buffer[], final int start,
final int len)
@@ -936,8 +936,8 @@ public class XMLParser extends DefaultHandler {
*
* @param file File containing the XML data to be parsed
* @return The script.
- * @throws IOException if an input/output error occurs
- * @throws SAXException if a parsing exception occurs
+ * @throws IOException Thrown if an input/output error occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
public Script parse(final File file) throws IOException, SAXException {
return parse(file.toURL());
@@ -949,8 +949,8 @@ public class XMLParser extends DefaultHandler {
*
* @param input Input source containing the XML data to be parsed
* @return The script.
- * @throws IOException if an input/output error occurs
- * @throws SAXException if a parsing exception occurs
+ * @throws IOException Thrown if an input/output error occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
public Script parse(final InputSource input) throws IOException,
SAXException {
ensureConfigured();
@@ -1007,8 +1007,8 @@ public class XMLParser extends DefaultHandler {
*
* @param uri URI containing the XML data to be parsed
* @return The script.
- * @throws IOException if an input/output error occurs
- * @throws SAXException if a parsing exception occurs
+ * @throws IOException Thrown if an input/output error occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
public Script parse(final String uri) throws IOException, SAXException {
ensureConfigured();
@@ -1023,8 +1023,8 @@ public class XMLParser extends DefaultHandler {
*
* @param url URL containing the XML data to be parsed
* @return The script.
- * @throws IOException if an input/output error occurs
- * @throws SAXException if a parsing exception occurs
+ * @throws IOException Thrown if an input/output error occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
public Script parse(final URL url) throws IOException, SAXException {
ensureConfigured();
@@ -1041,7 +1041,7 @@ public class XMLParser extends DefaultHandler {
*
* @param target The processing instruction target
* @param data The processing instruction data (if any)
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void processingInstruction(final String target, final String data)
@@ -1148,7 +1148,7 @@ public class XMLParser extends DefaultHandler {
* Process notification of a skipped entity.
*
* @param name Name of the skipped entity
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void skippedEntity(final String name) throws SAXException {
@@ -1158,7 +1158,7 @@ public class XMLParser extends DefaultHandler {
/**
* Process notification of the beginning of the document being reached.
*
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void startDocument() throws SAXException {
@@ -1181,7 +1181,7 @@ public class XMLParser extends DefaultHandler {
* string if qualified names are not available.\
* @param list The attributes attached to the element. If there are
* no attributes, it shall be an empty Attributes object.
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void startElement(
@@ -1257,7 +1257,7 @@ public class XMLParser extends DefaultHandler {
*
* @param prefix Prefix that is being declared
* @param namespaceURI Corresponding namespace URI being mapped to
- * @throws SAXException if a parsing error is to be reported
+ * @throws SAXException Thrown if a parsing error is to be reported
*/
@Override
public void startPrefixMapping(final String prefix, final String
namespaceURI)
@@ -1298,7 +1298,7 @@ public class XMLParser extends DefaultHandler {
* NOT throw a SAXException by default if no error handler is supplied.
*
* @param exception The warning information
- * @throws SAXException if a parsing exception occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
@Override
public void warning(final SAXParseException exception) throws SAXException
{
diff --git
a/jelly-tags/avalon/src/main/java/org/apache/commons/jelly/avalon/JellyService.java
b/jelly-tags/avalon/src/main/java/org/apache/commons/jelly/avalon/JellyService.java
index f8543eb3..0afc0c55 100644
---
a/jelly-tags/avalon/src/main/java/org/apache/commons/jelly/avalon/JellyService.java
+++
b/jelly-tags/avalon/src/main/java/org/apache/commons/jelly/avalon/JellyService.java
@@ -36,7 +36,7 @@ public interface JellyService {
*
* @param params Parameters to be supplied to the script
* @return All of the variables from the JellyContext
- * @throws Exception if the script raises some kind of exception while
processing
+ * @throws Exception Thrown if the script raises some kind of exception
while processing
*/
Map runNamedScript( String name, Map params ) throws Exception;
@@ -49,7 +49,7 @@ public interface JellyService {
* @param params Parameters to be supplied to the script
* @param out is the outputStream for output to be sent
* @return All of the variables from the JellyContext
- * @throws Exception if the script raises some kind of exception while
processing
+ * @throws Exception Thrown if the script raises some kind of exception
while processing
*/
Map runNamedScript( String name, Map params, OutputStream out ) throws
Exception;
@@ -61,7 +61,7 @@ public interface JellyService {
* @param params Parameters to be supplied to the script
* @param output is the XMLOutput for any output to be sent
* @return All of the variables from the JellyContext
- * @throws Exception if the script raises some kind of exception while
processing
+ * @throws Exception Thrown if the script raises some kind of exception
while processing
*/
Map runNamedScript( String name, Map params, XMLOutput output ) throws
Exception;
@@ -71,7 +71,7 @@ public interface JellyService {
* @param url The URL of the script
* @param params Parameters to be supplied to the script
* @return All of the variables from the JellyContext
- * @throws Exception if the script raises some kind of exception while
processing
+ * @throws Exception Thrown if the script raises some kind of exception
while processing
*/
Map runScript( String url, Map params ) throws Exception;
@@ -83,7 +83,7 @@ public interface JellyService {
* @param params Parameters to be supplied to the script
* @param out The OutputStream to send the output of the script to
* @return All of the variables from the JellyContext
- * @throws Exception if the script raises some kind of exception while
processing
+ * @throws Exception Thrown if the script raises some kind of exception
while processing
*/
Map runScript( String url, Map params, OutputStream out ) throws Exception;
diff --git
a/jelly-tags/betwixt/src/test/java/org/apache/commons/digester/rss/RSSDigester.java
b/jelly-tags/betwixt/src/test/java/org/apache/commons/digester/rss/RSSDigester.java
index 463ee723..fa03bd0f 100644
---
a/jelly-tags/betwixt/src/test/java/org/apache/commons/digester/rss/RSSDigester.java
+++
b/jelly-tags/betwixt/src/test/java/org/apache/commons/digester/rss/RSSDigester.java
@@ -208,8 +208,8 @@ public class RSSDigester extends Digester {
* the root element from the object stack (which will be the Channel).
*
* @param file File containing the XML data to be parsed
- * @throws IOException if an input/output error occurs
- * @throws SAXException if a parsing exception occurs
+ * @throws IOException Thrown if an input/output error occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
@Override
public Object parse(final File file) throws IOException, SAXException {
@@ -225,8 +225,8 @@ public class RSSDigester extends Digester {
* Channel).
*
* @param input Input source containing the XML data to be parsed
- * @throws IOException if an input/output error occurs
- * @throws SAXException if a parsing exception occurs
+ * @throws IOException Thrown if an input/output error occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
@Override
public Object parse(final InputSource input) throws IOException,
SAXException {
@@ -242,8 +242,8 @@ public class RSSDigester extends Digester {
* the Channel).
*
* @param input Input stream containing the XML data to be parsed
- * @throws IOException if an input/output error occurs
- * @throws SAXException if a parsing exception occurs
+ * @throws IOException Thrown if an input/output error occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
@Override
public Object parse(final InputStream input) throws IOException,
SAXException {
@@ -259,8 +259,8 @@ public class RSSDigester extends Digester {
* the Channel).
*
* @param uri URI containing the XML data to be parsed
- * @throws IOException if an input/output error occurs
- * @throws SAXException if a parsing exception occurs
+ * @throws IOException Thrown if an input/output error occurs
+ * @throws SAXException Thrown if a parsing exception occurs
*/
@Override
public Object parse(final String uri) throws IOException, SAXException {
diff --git
a/jelly-tags/soap/src/main/java/org/apache/commons/jelly/tags/soap/StringInputStream.java
b/jelly-tags/soap/src/main/java/org/apache/commons/jelly/tags/soap/StringInputStream.java
index aacc005c..74eca99d 100644
---
a/jelly-tags/soap/src/main/java/org/apache/commons/jelly/tags/soap/StringInputStream.java
+++
b/jelly-tags/soap/src/main/java/org/apache/commons/jelly/tags/soap/StringInputStream.java
@@ -46,7 +46,7 @@ public class StringInputStream
/**
* Closes the Stringreader.
*
- * @throws IOException if the original StringReader fails to be closed
+ * @throws IOException Thrown if the original StringReader fails to be
closed
*/
@Override
public void close() throws IOException
@@ -89,7 +89,7 @@ public class StringInputStream
* such input.
*
* @return The value of the next character in the StringReader
- * @throws IOException if the original StringReader fails to be read
+ * @throws IOException Thrown if the original StringReader fails to be read
*/
@Override
public int read() throws IOException
@@ -100,7 +100,7 @@ public class StringInputStream
/**
* Resets the StringReader.
*
- * @throws IOException if the StringReader fails to be reset
+ * @throws IOException Thrown if the StringReader fails to be reset
*/
@Override
public synchronized void reset() throws IOException
diff --git
a/jelly-tags/sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java
b/jelly-tags/sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java
index cd6b7c20..09077257 100644
--- a/jelly-tags/sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java
+++ b/jelly-tags/sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java
@@ -48,7 +48,7 @@ final class ResultImpl implements Result {
* row
* @param startRow beginning row to be cached
* @param maxRows query maximum rows limit
- * @throws SQLException if a database error occurs
+ * @throws SQLException Thrown if a database error occurs
*/
public ResultImpl(final ResultSet rs, final int startRow, final int
maxRows)
throws SQLException
diff --git
a/jelly-tags/sql/src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java
b/jelly-tags/sql/src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java
index 2ed70d88..e00784b2 100644
---
a/jelly-tags/sql/src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java
+++
b/jelly-tags/sql/src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java
@@ -100,7 +100,7 @@ public class ResultImpl implements Result {
* row
* @param startRow beginning row to be cached
* @param maxRows query maximum rows limit
- * @throws SQLException if a database error occurs
+ * @throws SQLException Thrown if a database error occurs
*/
public ResultImpl(final ResultSet rs, final int startRow, final int
maxRows)
throws SQLException {
diff --git
a/jelly-tags/swing/src/test/java/org/apache/commons/jelly/swing/TestSwingTags.java
b/jelly-tags/swing/src/test/java/org/apache/commons/jelly/swing/TestSwingTags.java
index 752dcbc9..39b009e9 100644
---
a/jelly-tags/swing/src/test/java/org/apache/commons/jelly/swing/TestSwingTags.java
+++
b/jelly-tags/swing/src/test/java/org/apache/commons/jelly/swing/TestSwingTags.java
@@ -50,7 +50,7 @@ public class TestSwingTags extends BaseJellyTest {
* @param container The Container to search in
* @param name The name to look for
* @return The first component with the given name
- * @throws Exception if the name isn't found
+ * @throws Exception Thrown if the name isn't found
*/
protected static Component componentByName(final Container container,
final String name) throws Exception{
final Component[] components = container.getComponents();
