This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/xerces-j.git
The following commit(s) were added to refs/heads/main by this push:
new a4dd6eade [XERCESJ-1781] fix incorrect Javadoc re SAXException (#51)
a4dd6eade is described below
commit a4dd6eade9e9e3451b4c29b2093c93c7f199f40e
Author: Samael <[email protected]>
AuthorDate: Wed Nov 19 12:19:56 2025 +0000
[XERCESJ-1781] fix incorrect Javadoc re SAXException (#51)
* [XERCESJ-1781] fix incorrect Javadoc re SAXException
* [XERCESJ-1781] fix incorrect Javadoc re SAXException
---
.../impl/XMLDocumentFragmentScannerImpl.java | 14 -----------
.../apache/xerces/impl/XMLDocumentScannerImpl.java | 14 -----------
src/org/apache/xerces/impl/XMLEntityManager.java | 14 -----------
src/org/apache/xerces/impl/XMLErrorReporter.java | 14 -----------
src/org/apache/xerces/impl/XMLNamespaceBinder.java | 14 -----------
src/org/apache/xerces/impl/XMLScanner.java | 9 -------
.../apache/xerces/impl/dtd/XMLDTDProcessor.java | 14 -----------
.../apache/xerces/impl/dtd/XMLDTDValidator.java | 14 -----------
.../xerces/impl/xs/identity/XPathMatcher.java | 6 ++---
.../xerces/impl/xs/opti/SchemaParsingConfig.java | 5 ----
.../apache/xerces/parsers/AbstractDOMParser.java | 5 ----
.../apache/xerces/parsers/AbstractSAXParser.java | 15 ++++--------
.../xerces/parsers/AbstractXMLDocumentParser.java | 3 ---
.../xerces/parsers/BasicParserConfiguration.java | 23 +++++++++++-------
src/org/apache/xerces/parsers/DOMParserImpl.java | 5 ----
.../apache/xerces/parsers/DTDConfiguration.java | 5 ----
.../xerces/parsers/NonValidatingConfiguration.java | 5 ----
src/org/apache/xerces/parsers/XMLParser.java | 19 +++++++++++----
.../xerces/util/ParserConfigurationSettings.java | 22 ++++++++---------
src/org/apache/xerces/xni/parser/XMLComponent.java | 9 ++++---
.../xerces/xni/parser/XMLParserConfiguration.java | 28 ++++++++++------------
21 files changed, 63 insertions(+), 194 deletions(-)
diff --git a/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
b/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
index 0441fcd0a..4086cbe71 100644
--- a/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
+++ b/src/org/apache/xerces/impl/XMLDocumentFragmentScannerImpl.java
@@ -332,20 +332,6 @@ public class XMLDocumentFragmentScannerImpl
// XMLComponent methods
//
- /**
- * Resets the component. The component can query the component manager
- * about any features and properties that affect the operation of the
- * component.
- *
- * @param componentManager The component manager.
- *
- * @throws SAXException Thrown by component on initialization error.
- * For example, if a feature or property is
- * required for the operation of the component, the
- * component manager may throw a
- * SAXNotRecognizedException or a
- * SAXNotSupportedException.
- */
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException {
diff --git a/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
b/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
index 374eee871..8dca6b544 100644
--- a/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
+++ b/src/org/apache/xerces/impl/XMLDocumentScannerImpl.java
@@ -252,20 +252,6 @@ public class XMLDocumentScannerImpl
// XMLComponent methods
//
- /**
- * Resets the component. The component can query the component manager
- * about any features and properties that affect the operation of the
- * component.
- *
- * @param componentManager The component manager.
- *
- * @throws SAXException Thrown by component on initialization error.
- * For example, if a feature or property is
- * required for the operation of the component, the
- * component manager may throw a
- * SAXNotRecognizedException or a
- * SAXNotSupportedException.
- */
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException {
diff --git a/src/org/apache/xerces/impl/XMLEntityManager.java
b/src/org/apache/xerces/impl/XMLEntityManager.java
index 7defb4932..8df84a7b7 100644
--- a/src/org/apache/xerces/impl/XMLEntityManager.java
+++ b/src/org/apache/xerces/impl/XMLEntityManager.java
@@ -1288,20 +1288,6 @@ public class XMLEntityManager
// XMLComponent methods
//
- /**
- * Resets the component. The component can query the component manager
- * about any features and properties that affect the operation of the
- * component.
- *
- * @param componentManager The component manager.
- *
- * @throws SAXException Thrown by component on initialization error.
- * For example, if a feature or property is
- * required for the operation of the component, the
- * component manager may throw a
- * SAXNotRecognizedException or a
- * SAXNotSupportedException.
- */
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException {
diff --git a/src/org/apache/xerces/impl/XMLErrorReporter.java
b/src/org/apache/xerces/impl/XMLErrorReporter.java
index 96505c63c..f6e9e61e8 100644
--- a/src/org/apache/xerces/impl/XMLErrorReporter.java
+++ b/src/org/apache/xerces/impl/XMLErrorReporter.java
@@ -413,20 +413,6 @@ public class XMLErrorReporter
// XMLComponent methods
//
- /**
- * Resets the component. The component can query the component manager
- * about any features and properties that affect the operation of the
- * component.
- *
- * @param componentManager The component manager.
- *
- * @throws SAXException Thrown by component on initialization error.
- * For example, if a feature or property is
- * required for the operation of the component, the
- * component manager may throw a
- * SAXNotRecognizedException or a
- * SAXNotSupportedException.
- */
public void reset(XMLComponentManager componentManager)
throws XNIException {
diff --git a/src/org/apache/xerces/impl/XMLNamespaceBinder.java
b/src/org/apache/xerces/impl/XMLNamespaceBinder.java
index 1133f7fcd..1f20bca16 100644
--- a/src/org/apache/xerces/impl/XMLNamespaceBinder.java
+++ b/src/org/apache/xerces/impl/XMLNamespaceBinder.java
@@ -184,20 +184,6 @@ public class XMLNamespaceBinder
// XMLComponent methods
//
- /**
- * Resets the component. The component can query the component manager
- * about any features and properties that affect the operation of the
- * component.
- *
- * @param componentManager The component manager.
- *
- * @throws SAXException Thrown by component on initialization error.
- * For example, if a feature or property is
- * required for the operation of the component, the
- * component manager may throw a
- * SAXNotRecognizedException or a
- * SAXNotSupportedException.
- */
public void reset(XMLComponentManager componentManager)
throws XNIException {
diff --git a/src/org/apache/xerces/impl/XMLScanner.java
b/src/org/apache/xerces/impl/XMLScanner.java
index 8b7fe8ccc..71173144c 100644
--- a/src/org/apache/xerces/impl/XMLScanner.java
+++ b/src/org/apache/xerces/impl/XMLScanner.java
@@ -205,15 +205,6 @@ public abstract class XMLScanner
// XMLComponent methods
//
- /**
- * Resets the component. The component can query the component manager
about
- * any features and properties that affect the operation of the component.
- *
- * @param componentManager the component manager
- *
- * @throws SAXException Throws exception if required features and
- * properties cannot be found.
- */
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException {
diff --git a/src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
b/src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
index 9e9f29082..7673cb039 100644
--- a/src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
+++ b/src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
@@ -276,20 +276,6 @@ public class XMLDTDProcessor
// XMLComponent methods
//
- /*
- * Resets the component. The component can query the component manager
- * about any features and properties that affect the operation of the
- * component.
- *
- * @param componentManager The component manager.
- *
- * @throws SAXException Thrown by component on finitialization error.
- * For example, if a feature or property is
- * required for the operation of the component, the
- * component manager may throw a
- * SAXNotRecognizedException or a
- * SAXNotSupportedException.
- */
public void reset(XMLComponentManager componentManager) throws
XMLConfigurationException {
boolean parser_settings;
diff --git a/src/org/apache/xerces/impl/dtd/XMLDTDValidator.java
b/src/org/apache/xerces/impl/dtd/XMLDTDValidator.java
index 378f0e823..de906ca97 100644
--- a/src/org/apache/xerces/impl/dtd/XMLDTDValidator.java
+++ b/src/org/apache/xerces/impl/dtd/XMLDTDValidator.java
@@ -404,20 +404,6 @@ public class XMLDTDValidator
// XMLComponent methods
//
- /*
- * Resets the component. The component can query the component manager
- * about any features and properties that affect the operation of the
- * component.
- *
- * @param componentManager The component manager.
- *
- * @throws SAXException Thrown by component on finitialization error.
- * For example, if a feature or property is
- * required for the operation of the component, the
- * component manager may throw a
- * SAXNotRecognizedException or a
- * SAXNotSupportedException.
- */
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException {
diff --git a/src/org/apache/xerces/impl/xs/identity/XPathMatcher.java
b/src/org/apache/xerces/impl/xs/identity/XPathMatcher.java
index 83c69657c..96c895f09 100644
--- a/src/org/apache/xerces/impl/xs/identity/XPathMatcher.java
+++ b/src/org/apache/xerces/impl/xs/identity/XPathMatcher.java
@@ -197,10 +197,8 @@ public class XPathMatcher {
* by using an empty tag, then the startElement method will immediately
* be followed by the endElement method, with no intervening methods.
*
- * @param element The name of the element.
- * @param attributes The element attributes.
- *
- * @throws SAXException Thrown by handler to signal an error.
+ * @param element the name of the element
+ * @param attributes the element attributes
*/
public void startElement(QName element, XMLAttributes attributes) {
if (DEBUG_METHODS2) {
diff --git a/src/org/apache/xerces/impl/xs/opti/SchemaParsingConfig.java
b/src/org/apache/xerces/impl/xs/opti/SchemaParsingConfig.java
index cac274aff..781e64a3c 100644
--- a/src/org/apache/xerces/impl/xs/opti/SchemaParsingConfig.java
+++ b/src/org/apache/xerces/impl/xs/opti/SchemaParsingConfig.java
@@ -710,11 +710,6 @@ public class SchemaParsingConfig extends
BasicParserConfiguration
// Protected methods
//
- /**
- * Reset all components before parsing.
- *
- * @throws XNIException Thrown if an error occurs during initialization.
- */
public void reset() throws XNIException {
// initialize the common components
diff --git a/src/org/apache/xerces/parsers/AbstractDOMParser.java
b/src/org/apache/xerces/parsers/AbstractDOMParser.java
index fe00d598b..dd8ca72cc 100644
--- a/src/org/apache/xerces/parsers/AbstractDOMParser.java
+++ b/src/org/apache/xerces/parsers/AbstractDOMParser.java
@@ -395,11 +395,6 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
// XMLDocumentParser methods
//
- /**
- * Resets the parser state.
- *
- * @throws SAXException Thrown on initialization error.
- */
public void reset () throws XNIException {
super.reset ();
diff --git a/src/org/apache/xerces/parsers/AbstractSAXParser.java
b/src/org/apache/xerces/parsers/AbstractSAXParser.java
index 75d38cf93..ef8257931 100644
--- a/src/org/apache/xerces/parsers/AbstractSAXParser.java
+++ b/src/org/apache/xerces/parsers/AbstractSAXParser.java
@@ -1376,12 +1376,11 @@ public abstract class AbstractSAXParser
/**
* Set the locale to use for messages.
*
- * @param locale The locale object to use for localization of messages.
+ * @param locale The locale object to use for localization of messages
*
- * @exception SAXException An exception thrown if the parser does not
- * support the specified locale.
+ * @throws SAXException if the parser does not support the specified locale
*
- * @see org.xml.sax.Parser
+ * @see org.xml.sax.Parser#setLocale(Locale)
*/
public void setLocale(Locale locale) throws SAXException {
//REVISIT:this methods is not part of SAX2 interfaces, we should throw
exception
@@ -1400,9 +1399,8 @@ public abstract class AbstractSAXParser
* middle of a parse, and the SAX parser must begin using the new
* handler immediately.
*
- * @param dtdHandler The DTD handler.
+ * @param dtdHandler the DTD handler
*
-
* @see #getDTDHandler
*/
public void setDTDHandler(DTDHandler dtdHandler) {
@@ -2168,11 +2166,6 @@ public abstract class AbstractSAXParser
// XMLDocumentParser methods
//
- /**
- * Reset all components before parsing.
- *
- * @throws XNIException Thrown if an error occurs during initialization.
- */
public void reset() throws XNIException {
super.reset();
diff --git a/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
b/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
index 1eca34696..2e6238ebd 100644
--- a/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
+++ b/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
@@ -799,9 +799,6 @@ public abstract class AbstractXMLDocumentParser
// Protected methods
//
- /**
- * reset all components before parsing
- */
protected void reset() throws XNIException {
super.reset();
fInDTD = false;
diff --git a/src/org/apache/xerces/parsers/BasicParserConfiguration.java
b/src/org/apache/xerces/parsers/BasicParserConfiguration.java
index 60936e417..9f61f92a4 100644
--- a/src/org/apache/xerces/parsers/BasicParserConfiguration.java
+++ b/src/org/apache/xerces/parsers/BasicParserConfiguration.java
@@ -425,16 +425,16 @@ public abstract class BasicParserConfiguration
/**
* Set the state of a feature.
- *
+ * <p>
* Set the state of any feature in a SAX2 parser. The parser
* might not recognize the feature, and if it does recognize
* it, it might not be able to fulfill the request.
+ * </p>
*
- * @param featureId The unique identifier (URI) of the feature.
- * @param state The requested state of the feature (true or false).
+ * @param featureId the unique identifier (URI) of the feature
+ * @param state the requested state of the feature (true or false)
*
- * @exception org.apache.xerces.xni.parser.XMLConfigurationException If the
- * requested feature is not known.
+ * @throws XMLConfigurationException if the requested feature is not known
*/
public void setFeature(String featureId, boolean state)
throws XMLConfigurationException {
@@ -451,10 +451,12 @@ public abstract class BasicParserConfiguration
} // setFeature(String,boolean)
/**
- * setProperty
+ * Set the state of a property.
*
- * @param propertyId
- * @param value
+ * @param propertyId the unique identifier of the property
+ * @param value the requested value of the property
+ *
+ * @throws XMLConfigurationException if the requested property is not known
*/
public void setProperty(String propertyId, Object value)
throws XMLConfigurationException {
@@ -493,7 +495,10 @@ public abstract class BasicParserConfiguration
//
/**
- * reset all components before parsing and namespace context
+ * Reset all components before parsing and namespace context.
+ *
+ * @throws XNIException any XNI exception but likely to be
<code>XMLConfigurationException</code>
+ * @see XMLConfigurationException
*/
protected void reset() throws XNIException {
diff --git a/src/org/apache/xerces/parsers/DOMParserImpl.java
b/src/org/apache/xerces/parsers/DOMParserImpl.java
index ead0106c0..3398ebf55 100644
--- a/src/org/apache/xerces/parsers/DOMParserImpl.java
+++ b/src/org/apache/xerces/parsers/DOMParserImpl.java
@@ -286,11 +286,6 @@ public class DOMParserImpl
grammarPool);
}
- /**
- * Resets the parser state.
- *
- * @throws SAXException Thrown on initialization error.
- */
public void reset () {
super.reset();
diff --git a/src/org/apache/xerces/parsers/DTDConfiguration.java
b/src/org/apache/xerces/parsers/DTDConfiguration.java
index 76670515f..05ee37010 100644
--- a/src/org/apache/xerces/parsers/DTDConfiguration.java
+++ b/src/org/apache/xerces/parsers/DTDConfiguration.java
@@ -602,11 +602,6 @@ public class DTDConfiguration
// Protected methods
//
- /**
- * Reset all components before parsing.
- *
- * @throws XNIException Thrown if an error occurs during initialization.
- */
protected void reset() throws XNIException {
if (fValidationManager != null)
diff --git a/src/org/apache/xerces/parsers/NonValidatingConfiguration.java
b/src/org/apache/xerces/parsers/NonValidatingConfiguration.java
index 85620e220..fd25fcf87 100644
--- a/src/org/apache/xerces/parsers/NonValidatingConfiguration.java
+++ b/src/org/apache/xerces/parsers/NonValidatingConfiguration.java
@@ -581,11 +581,6 @@ public class NonValidatingConfiguration
// Protected methods
//
- /**
- * Reset all components before parsing.
- *
- * @throws XNIException Thrown if an error occurs during initialization.
- */
protected void reset() throws XNIException {
if (fValidationManager != null)
diff --git a/src/org/apache/xerces/parsers/XMLParser.java
b/src/org/apache/xerces/parsers/XMLParser.java
index f2af25ae2..40bcc5354 100644
--- a/src/org/apache/xerces/parsers/XMLParser.java
+++ b/src/org/apache/xerces/parsers/XMLParser.java
@@ -78,6 +78,8 @@ public abstract class XMLParser {
/**
* Default Constructor.
+ *
+ * @param config the parser configuration from which properties and
features can be retrieved
*/
protected XMLParser(XMLParserConfiguration config) {
@@ -94,12 +96,14 @@ public abstract class XMLParser {
//
/**
- * parse
+ * Parse an XML document.
*
- * @param inputSource
+ * @param inputSource the input source for the top-level of the XML
document
*
- * @exception XNIException
- * @exception java.io.IOException
+ * @throws XNIException any XNI exception, possibly wrapping another
exception
+ * @throws IOException if an IO error occurs while parsing the input source
+ * @see org.apache.xerces.xni.parser.XMLParseException
+ * @see org.apache.xerces.xni.parser.XMLConfigurationException
*/
public void parse(XMLInputSource inputSource)
throws XNIException, IOException {
@@ -114,7 +118,12 @@ public abstract class XMLParser {
//
/**
- * reset all components before parsing
+ * Reset all components before parsing.
+ *
+ * @throws XNIException any XNI exception but likely to be
<code>XMLConfigurationException</code> if
+ * resetting requires access to properties and features held within the
<code>XMLParserConfiguration</code>
+ * @see XMLParserConfiguration
+ * @see org.apache.xerces.xni.parser.XMLConfigurationException
*/
protected void reset() throws XNIException {
} // reset()
diff --git a/src/org/apache/xerces/util/ParserConfigurationSettings.java
b/src/org/apache/xerces/util/ParserConfigurationSettings.java
index 0fd95b31a..1854af211 100644
--- a/src/org/apache/xerces/util/ParserConfigurationSettings.java
+++ b/src/org/apache/xerces/util/ParserConfigurationSettings.java
@@ -120,16 +120,16 @@ public class ParserConfigurationSettings
/**
* Set the state of a feature.
- *
+ * <p>
* Set the state of any feature in a SAX2 parser. The parser
* might not recognize the feature, and if it does recognize
* it, it might not be able to fulfill the request.
+ * </p>
*
- * @param featureId The unique identifier (URI) of the feature.
- * @param state The requested state of the feature (true or false).
+ * @param featureId the unique identifier (URI) of the feature
+ * @param state the requested state of the feature (true or false)
*
- * @exception org.apache.xerces.xni.parser.XMLConfigurationException If the
- * requested feature is not known.
+ * @throws XMLConfigurationException if the requested feature is not known
*/
public void setFeature(String featureId, boolean state)
throws XMLConfigurationException {
@@ -161,12 +161,12 @@ public class ParserConfigurationSettings
} // addRecognizedProperties(String[])
/**
- * setProperty
- *
- * @param propertyId
- * @param value
- * @exception org.apache.xerces.xni.parser.XMLConfigurationException If the
- * requested feature is not known.
+ * Set the state of a property.
+ *
+ * @param propertyId the unique identifier of the property
+ * @param value the requested value of the property
+ *
+ * @throws XMLConfigurationException if the requested property is not known
*/
public void setProperty(String propertyId, Object value)
throws XMLConfigurationException {
diff --git a/src/org/apache/xerces/xni/parser/XMLComponent.java
b/src/org/apache/xerces/xni/parser/XMLComponent.java
index 293322282..4c6c64fc4 100644
--- a/src/org/apache/xerces/xni/parser/XMLComponent.java
+++ b/src/org/apache/xerces/xni/parser/XMLComponent.java
@@ -41,10 +41,13 @@ public interface XMLComponent {
* Resets the component. The component can query the component manager
* about any features and properties that affect the operation of the
* component.
- *
- * @param componentManager The component manager.
*
- * @throws XNIException Thrown by component on initialization error.
+ * @param componentManager the component manager
+ *
+ * @throws XMLConfigurationException if not handled when getting features
or properties from the component manager
+ *
+ * @see XMLComponentManager#getFeature(String)
+ * @see XMLComponentManager#getProperty(String)
*/
public void reset(XMLComponentManager componentManager)
throws XMLConfigurationException;
diff --git a/src/org/apache/xerces/xni/parser/XMLParserConfiguration.java
b/src/org/apache/xerces/xni/parser/XMLParserConfiguration.java
index bc7700739..469ed6f61 100644
--- a/src/org/apache/xerces/xni/parser/XMLParserConfiguration.java
+++ b/src/org/apache/xerces/xni/parser/XMLParserConfiguration.java
@@ -128,11 +128,10 @@ public interface XMLParserConfiguration
* Sets the state of a feature. This method is called by the parser
* and gets propagated to components in this parser configuration.
*
- * @param featureId The feature identifier.
- * @param state The state of the feature.
+ * @param featureId the unique identifier of the feature
+ * @param state the requested state of the feature (true or false)
*
- * @throws XMLConfigurationException Thrown if there is a configuration
- * error.
+ * @throws XMLConfigurationException if there is a configuration error
*/
public void setFeature(String featureId, boolean state)
throws XMLConfigurationException;
@@ -140,10 +139,9 @@ public interface XMLParserConfiguration
/**
* Returns the state of a feature.
*
- * @param featureId The feature identifier.
+ * @param featureId the feature identifier
*
- * @throws XMLConfigurationException Thrown if there is a configuration
- * error.
+ * @throws XMLConfigurationException if there is a configuration error
*/
public boolean getFeature(String featureId)
throws XMLConfigurationException;
@@ -158,14 +156,13 @@ public interface XMLParserConfiguration
public void addRecognizedProperties(String[] propertyIds);
/**
- * Sets the value of a property. This method is called by the parser
+ * Set the state of a property. This method is called by the parser
* and gets propagated to components in this parser configuration.
- *
- * @param propertyId The property identifier.
- * @param value The value of the property.
*
- * @throws XMLConfigurationException Thrown if there is a configuration
- * error.
+ * @param propertyId the unique identifier of the property
+ * @param value the requested value of the property
+ *
+ * @throws XMLConfigurationException if the requested property is not known
*/
public void setProperty(String propertyId, Object value)
throws XMLConfigurationException;
@@ -173,10 +170,9 @@ public interface XMLParserConfiguration
/**
* Returns the value of a property.
*
- * @param propertyId The property identifier.
+ * @param propertyId the property identifier
*
- * @throws XMLConfigurationException Thrown if there is a configuration
- * error.
+ * @throws XMLConfigurationException if there is a configuration error
*/
public Object getProperty(String propertyId)
throws XMLConfigurationException;
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
