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 7e1526358 [XERCESJ-70] Clarify meaning of the term baseSystemID (#26)
7e1526358 is described below
commit 7e15263587770eb0c79b5d2db39d82856613541d
Author: Elliotte Rusty Harold <[email protected]>
AuthorDate: Thu Jan 22 20:20:01 2026 +0000
[XERCESJ-70] Clarify meaning of the term baseSystemID (#26)
* correct Javadoc
* Clarify meaning of the term baseSystemID
* more edits
* remove
---
docs/xni-core.xml | 4 +-
samples/xni/PSVIWriter.java | 12 ++---
samples/xni/PassThroughFilter.java | 10 +---
src/org/apache/xerces/dom/DOMInputImpl.java | 56 +++++++++-------------
src/org/apache/xerces/impl/XMLEntityManager.java | 11 ++---
src/org/apache/xerces/impl/XMLEntityScanner.java | 2 +-
src/org/apache/xerces/impl/dtd/DTDGrammar.java | 8 ++--
.../apache/xerces/impl/dtd/XMLDTDProcessor.java | 10 ++--
.../impl/xs/opti/DefaultXMLDocumentHandler.java | 14 +++---
.../apache/xerces/parsers/AbstractDOMParser.java | 9 ++--
.../xerces/parsers/AbstractXMLDocumentParser.java | 9 ++--
src/org/apache/xerces/util/HTTPInputSource.java | 39 +++++++--------
.../xerces/util/XMLEntityDescriptionImpl.java | 48 +++++++++----------
.../xerces/util/XMLResourceIdentifierImpl.java | 24 ++++++----
src/org/apache/xerces/xni/XMLDTDHandler.java | 10 ++--
src/org/apache/xerces/xni/XMLLocator.java | 10 ++--
.../apache/xerces/xni/parser/XMLInputSource.java | 38 +++++++--------
.../xerces/xni/parser/XMLParseException.java | 2 +-
18 files changed, 140 insertions(+), 176 deletions(-)
diff --git a/docs/xni-core.xml b/docs/xni-core.xml
index 99a88bc72..29f3fcd16 100644
--- a/docs/xni-core.xml
+++ b/docs/xni-core.xml
@@ -496,7 +496,7 @@
which this object relates to.
</li>
<li> expandedSystemId: The value of the systemId (or
- <code>schemaLocation</code>) after being subjects to relative
+ <code>schemaLocation</code>) after relative
URI expansion. SAX programmers will be familiar with this
concept from the SAX Locator interface, for example; this
property maps to the <code>systemId</code> property of that
@@ -521,7 +521,7 @@
This interface is used to communicate the document location to
the various handler interfaces. The application can use the
methods on this interface to query the public, literal system, and
expanded system
- base system identifier as well as the line number, column number
+ identifier as well as the line number, column number
and the encoding of the entity currently being parsed.
</p>
<p>
diff --git a/samples/xni/PSVIWriter.java b/samples/xni/PSVIWriter.java
index dc38d2bf1..959650a01 100644
--- a/samples/xni/PSVIWriter.java
+++ b/samples/xni/PSVIWriter.java
@@ -315,19 +315,13 @@ public class PSVIWriter implements XMLComponent,
XMLDocumentFilter {
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
*
- * @param name The name of the entity.
- * @param publicId The public identifier of the entity if the entity
- * is external, null otherwise.
- * @param systemId The system identifier of the entity if the entity
- * is external, null otherwise.
- * @param baseSystemId The base system identifier of the entity if
- * the entity is external, null otherwise.
- * @param encoding The auto-detected IANA encoding name of the entity
+ * @param name the name of the entity
+ * @param encoding the auto-detected IANA encoding name of the entity
* stream. This value will be null in those situations
* where the entity encoding is not auto-detected (e.g.
* internal entities or a document entity that is
* parsed from a java.io.Reader).
- * @param augs Additional information that may include infoset
augmentations
+ * @param augs additional information that may include infoset
augmentations
*
* @throws XNIException Thrown by handler to signal an error.
*/
diff --git a/samples/xni/PassThroughFilter.java
b/samples/xni/PassThroughFilter.java
index 1424ff453..67df52ed4 100644
--- a/samples/xni/PassThroughFilter.java
+++ b/samples/xni/PassThroughFilter.java
@@ -220,14 +220,8 @@ public class PassThroughFilter
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
*
- * @param name The name of the entity.
- * @param publicId The public identifier of the entity if the entity
- * is external, null otherwise.
- * @param systemId The system identifier of the entity if the entity
- * is external, null otherwise.
- * @param baseSystemId The base system identifier of the entity if
- * the entity is external, null otherwise.
- * @param encoding The auto-detected IANA encoding name of the entity
+ * @param name the name of the entity.
+ * @param encoding the auto-detected IANA encoding name of the entity
* stream. This value will be null in those situations
* where the entity encoding is not auto-detected (e.g.
* internal entities or a document entity that is
diff --git a/src/org/apache/xerces/dom/DOMInputImpl.java
b/src/org/apache/xerces/dom/DOMInputImpl.java
index bb3fb6674..5aa9d98b8 100644
--- a/src/org/apache/xerces/dom/DOMInputImpl.java
+++ b/src/org/apache/xerces/dom/DOMInputImpl.java
@@ -92,15 +92,15 @@ public class DOMInputImpl implements LSInput {
* identifiers, leaving resolution of the entity and opening of
* the input stream up to the caller.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
+ * @param publicId the public identifier, if known
+ * @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
+ * @param baseSystemId the base system identifier. This value should
+ * always be set to the expanded absolute URI of the
+ * system identifier, if possible.
*/
public DOMInputImpl(String publicId, String systemId,
@@ -115,17 +115,15 @@ public class DOMInputImpl implements LSInput {
/**
* Constructs an input source from a byte stream.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
+ * @param publicId the public identifier, if known
+ * @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
- * @param byteStream The byte stream.
- * @param encoding The encoding of the byte stream, if known.
+ * @param baseSystemId the base system identifier against which the system
identifier should be resolved
+ * @param byteStream the byte stream
+ * @param encoding the encoding of the byte stream, if known
*/
public DOMInputImpl(String publicId, String systemId,
@@ -143,18 +141,16 @@ public class DOMInputImpl implements LSInput {
/**
* Constructs an input source from a character stream.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
+ * @param publicId the public identifier, if knownt
+ * @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
* should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
- * @param charStream The character stream.
- * @param encoding The original encoding of the byte stream
- * used by the reader, if known.
+ * @param baseSystemId the base system identifier against which the system
identifier should be resolved
+ * @param charStream the character stream
+ * @param encoding the original encoding of the byte stream
+ * used by the reader, if known
*/
public DOMInputImpl(String publicId, String systemId,
@@ -172,20 +168,14 @@ public class DOMInputImpl implements LSInput {
/**
* Constructs an input source from a String.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
- * always be set, if possible, and can be
- * relative or absolute. If the system identifier
- * is relative, then the base system identifier
- * should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
- * @param data The String Data.
- * @param encoding The original encoding of the byte stream
- * used by the reader, if known.
+ * @param publicId the public identifier, if known
+ * @param systemId the system identifier. This value should always be
set, if possible, and can be
+ * relative or absolute. If the system identifier is
relative, then the base system identifier
+ * should be set.
+ * @param baseSystemId the base system identifier against which the system
identifier should be resolved
+ * @param data the String data
+ * @param encoding the original encoding of the byte stream used by the
reader, if known
*/
-
public DOMInputImpl(String publicId, String systemId,
String baseSystemId, String data,
String encoding) {
diff --git a/src/org/apache/xerces/impl/XMLEntityManager.java
b/src/org/apache/xerces/impl/XMLEntityManager.java
index 872681f87..bd95720c0 100644
--- a/src/org/apache/xerces/impl/XMLEntityManager.java
+++ b/src/org/apache/xerces/impl/XMLEntityManager.java
@@ -543,12 +543,11 @@ public class XMLEntityManager
* <strong>Note:</strong> The name should be a unique symbol. The
* SymbolTable can be used for this purpose.
*
- * @param name The name of the entity.
- * @param publicId The public identifier of the entity.
- * @param literalSystemId The system identifier of the entity.
- * @param baseSystemId The base system identifier of the entity.
- * This is the system identifier of the entity
- * where <em>the entity being added</em> and
+ * @param name the name of the entity
+ * @param publicId the public identifier of the entity
+ * @param literalSystemId the system identifier of the entity
+ * @param baseSystemId the base URL of the entity. This is the URL of the
entity
+ * where <em>the entity is being added</em> and
* is used to expand the system identifier when
* the system identifier is a relative URI.
* When null the system identifier of the first
diff --git a/src/org/apache/xerces/impl/XMLEntityScanner.java
b/src/org/apache/xerces/impl/XMLEntityScanner.java
index b860d9100..c2f12032e 100644
--- a/src/org/apache/xerces/impl/XMLEntityScanner.java
+++ b/src/org/apache/xerces/impl/XMLEntityScanner.java
@@ -84,7 +84,7 @@ public class XMLEntityScanner implements XMLLocator {
//
/**
- * Returns the base system identifier of the currently scanned
+ * Returns the base URL of the currently scanned
* entity, or null if none is available.
*/
public final String getBaseSystemId() {
diff --git a/src/org/apache/xerces/impl/dtd/DTDGrammar.java
b/src/org/apache/xerces/impl/dtd/DTDGrammar.java
index 45fac547f..5b53768a3 100644
--- a/src/org/apache/xerces/impl/dtd/DTDGrammar.java
+++ b/src/org/apache/xerces/impl/dtd/DTDGrammar.java
@@ -365,12 +365,10 @@ public class DTDGrammar
* location cannot be reported during the parsing of
* the document DTD. However, it is <em>strongly</em>
* recommended that a locator be supplied that can
- * at least report the base system identifier of the
- * DTD.
+ * at least report the base URI of the DTD.
*
- * @param augs Additional information that may include infoset
- * augmentations.
- * @throws XNIException Thrown by handler to signal an error.
+ * @param augs additional information that may include infoset
augmentations
+ * @throws XNIException thrown by handler to signal an error
*/
public void startDTD(XMLLocator locator, Augmentations augs) throws
XNIException {
//Initialize stack
diff --git a/src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
b/src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
index 3c5131933..84b785fd8 100644
--- a/src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
+++ b/src/org/apache/xerces/impl/dtd/XMLDTDProcessor.java
@@ -619,16 +619,14 @@ public class XMLDTDProcessor
/**
* The start of the DTD.
*
- * @param locator The document locator, or null if the document
+ * @param locator the document locator, or null if the document
* location cannot be reported during the parsing of
* the document DTD. However, it is <em>strongly</em>
* recommended that a locator be supplied that can
- * at least report the base system identifier of the
- * DTD.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * at least report the base URI of the DTD.
+ * @param augs additional information that may include infoset
augmentations
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*/
public void startDTD(XMLLocator locator, Augmentations augs) throws
XNIException {
diff --git a/src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java
b/src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java
index e8b51d1ed..4e8dddba8 100644
--- a/src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java
+++ b/src/org/apache/xerces/impl/xs/opti/DefaultXMLDocumentHandler.java
@@ -342,16 +342,14 @@ public class DefaultXMLDocumentHandler implements
XMLDocumentHandler,
/**
* The start of the DTD.
*
- * @param locator The document locator, or null if the document
- * location cannot be reported during the parsing of
+ * @param locator the document locator, or null if the document
+ * location cannot be reported during the parsing of
* the document DTD. However, it is <em>strongly</em>
- * recommended that a locator be supplied that can
- * at least report the base system identifier of the
- * DTD.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * recommended that a locator be supplied that can
+ * at least report the base URI of the DTD.
+ * @param augmentations additional information that may include infoset
augmentations
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*/
public void startDTD(XMLLocator locator, Augmentations augmentations)
throws XNIException {
diff --git a/src/org/apache/xerces/parsers/AbstractDOMParser.java
b/src/org/apache/xerces/parsers/AbstractDOMParser.java
index ccf5577df..2752e4266 100644
--- a/src/org/apache/xerces/parsers/AbstractDOMParser.java
+++ b/src/org/apache/xerces/parsers/AbstractDOMParser.java
@@ -1801,10 +1801,11 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The start of the DTD.
*
- * @param locator the document locator, or null if the document location
cannot be
- * reported during the parsing of the document DTD.
However, it is
- * <em>strongly</em> recommended that a locator be supplied
that can
- * at least report the base system identifier of the DTD.
+ * @param locator the document locator, or null if the document
+ * location cannot be reported during the parsing of
+ * the document DTD. However, it is <em>strongly</em>
+ * recommended that a locator be supplied that can
+ * at least report the base URI of the DTD.
* @param augs additional information that may include infoset
augmentations
*
* @throws XNIException thrown by handler to signal an error
diff --git a/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
b/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
index f6fe604f3..9a817307b 100644
--- a/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
+++ b/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
@@ -364,10 +364,11 @@ public abstract class AbstractXMLDocumentParser
/**
* The start of the DTD.
*
- * @param locator the document locator, or null if the document location
cannot be
- * reported during the parsing of the document DTD.
However, it is
- * <em>strongly</em> recommended that a locator be supplied
that can
- * at least report the base system identifier of the DTD.
+ * @param locator the document locator, or null if the document
+ * location cannot be reported during the parsing of
+ * the document DTD. However, it is <em>strongly</em>
+ * recommended that a locator be supplied that can
+ * at least report the base URI of the DTD.
* @param augs additional information that may include infoset
augmentations
*
* @throws XNIException thrown by handler to signal an error
diff --git a/src/org/apache/xerces/util/HTTPInputSource.java
b/src/org/apache/xerces/util/HTTPInputSource.java
index 5224141de..94e110790 100644
--- a/src/org/apache/xerces/util/HTTPInputSource.java
+++ b/src/org/apache/xerces/util/HTTPInputSource.java
@@ -59,15 +59,14 @@ public final class HTTPInputSource extends XMLInputSource {
* identifiers, leaving resolution of the entity and opening of
* the input stream up to the caller.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
+ * @param publicId the public identifier, if known
+ * @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
- * should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
+ * should also be set.
+ * @param baseSystemId the base system identifier. This value should
+ * always be an absolute base URI applicable to the
system identifier.
*/
public HTTPInputSource(String publicId, String systemId, String
baseSystemId) {
super(publicId, systemId, baseSystemId);
@@ -87,15 +86,14 @@ public final class HTTPInputSource extends XMLInputSource {
/**
* Constructs an input source from a byte stream.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
+ * @param publicId the public identifier, if known
+ * @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
- * should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
+ * should also be set.
+ * @param baseSystemId the base system identifier. This value should
+ * always be an absolute base URI applicable to the
system identifier.
* @param byteStream The byte stream.
* @param encoding The encoding of the byte stream, if known.
*/
@@ -107,18 +105,17 @@ public final class HTTPInputSource extends XMLInputSource
{
/**
* Constructs an input source from a character stream.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
+ * @param publicId the public identifier, if known
+ * @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
* is relative, then the base system identifier
- * should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
- * @param charStream The character stream.
- * @param encoding The original encoding of the byte stream
- * used by the reader, if known.
+ * should also be set.
+ * @param baseSystemId the base system identifier. This value should
+ * always be an absolute base URI applicable to the
system identifier.
+ * @param charStream the character stream
+ * @param encoding the original encoding of the byte stream
+ * used by the reader, if known
*/
public HTTPInputSource(String publicId, String systemId,
String baseSystemId, Reader charStream, String encoding) {
diff --git a/src/org/apache/xerces/util/XMLEntityDescriptionImpl.java
b/src/org/apache/xerces/util/XMLEntityDescriptionImpl.java
index af47915c7..cf3d6d7c2 100644
--- a/src/org/apache/xerces/util/XMLEntityDescriptionImpl.java
+++ b/src/org/apache/xerces/util/XMLEntityDescriptionImpl.java
@@ -41,11 +41,11 @@ public class XMLEntityDescriptionImpl
/**
* Constructs an entity description.
*
- * @param entityName The name of the entity.
- * @param publicId The public identifier.
- * @param literalSystemId The literal system identifier.
- * @param baseSystemId The base system identifier.
- * @param expandedSystemId The expanded system identifier.
+ * @param entityName the name of the entity
+ * @param publicId the public identifier
+ * @param literalSystemId the literal system identifier
+ * @param baseSystemId the base URI against which the system identifier is
resolved
+ * @param expandedSystemId the expanded system identifier resolved against
the base system identifier
*/
public XMLEntityDescriptionImpl(String entityName, String publicId, String
literalSystemId,
String baseSystemId, String
expandedSystemId) {
@@ -55,12 +55,12 @@ public class XMLEntityDescriptionImpl
/**
* Constructs a resource identifier.
*
- * @param entityName The name of the entity.
- * @param publicId The public identifier.
- * @param literalSystemId The literal system identifier.
- * @param baseSystemId The base system identifier.
- * @param expandedSystemId The expanded system identifier.
- * @param namespace The namespace.
+ * @param entityName the name of the entity
+ * @param publicId the public identifier
+ * @param literalSystemId the literal system identifier
+ * @param baseSystemId the base URI against which the system identifier is
resolved
+ * @param expandedSystemId the expanded system identifier resolved against
the base system identifier
+ * @param namespace the namespace
*/
public XMLEntityDescriptionImpl(String entityName, String publicId, String
literalSystemId,
String baseSystemId, String
expandedSystemId, String namespace) {
@@ -98,12 +98,12 @@ public class XMLEntityDescriptionImpl
/**
* <p>Sets the values of this entity description.</p>
- *
- * @param entityName The name of the entity.
- * @param publicId The public identifier.
- * @param literalSystemId The literal system identifier.
- * @param baseSystemId The base system identifier.
- * @param expandedSystemId The expanded system identifier.
+ *
+ * @param entityName the name of the entity
+ * @param publicId the public identifier
+ * @param literalSystemId the literal system identifier
+ * @param baseSystemId the base URI against which the system identifier is
resolved
+ * @param expandedSystemId the expanded system identifier resolved against
the base system identifier
*/
public void setDescription(String entityName, String publicId, String
literalSystemId,
String baseSystemId, String expandedSystemId) {
@@ -112,13 +112,13 @@ public class XMLEntityDescriptionImpl
/**
* <p>Sets the values of this entity description.</p>
- *
- * @param entityName The name of the entity.
- * @param publicId The public identifier.
- * @param literalSystemId The literal system identifier.
- * @param baseSystemId The base system identifier.
- * @param expandedSystemId The expanded system identifier.
- * @param namespace The namespace.
+ *
+ * @param entityName the name of the entity
+ * @param publicId the public identifier
+ * @param literalSystemId the literal system identifier
+ * @param baseSystemId the base URI against which the system identifier is
resolved
+ * @param expandedSystemId the expanded system identifier resolved against
the base system identifier
+ * @param namespace the namespace
*/
public void setDescription(String entityName, String publicId, String
literalSystemId,
String baseSystemId, String expandedSystemId,
String namespace) {
diff --git a/src/org/apache/xerces/util/XMLResourceIdentifierImpl.java
b/src/org/apache/xerces/util/XMLResourceIdentifierImpl.java
index c463457b8..68c110834 100644
--- a/src/org/apache/xerces/util/XMLResourceIdentifierImpl.java
+++ b/src/org/apache/xerces/util/XMLResourceIdentifierImpl.java
@@ -60,10 +60,10 @@ public class XMLResourceIdentifierImpl
/**
* Constructs a resource identifier.
*
- * @param publicId The public identifier.
- * @param literalSystemId The literal system identifier.
- * @param baseSystemId The base system identifier.
- * @param expandedSystemId The expanded system identifier.
+ * @param publicId the public identifier
+ * @param literalSystemId the literal system identifier
+ * @param baseSystemId the URI against which the system identifier should
be resolved
+ * @param expandedSystemId the literalSystemId resolved against
baseSystemId
*/
public XMLResourceIdentifierImpl(String publicId,
String literalSystemId, String
baseSystemId,
@@ -75,11 +75,11 @@ public class XMLResourceIdentifierImpl
/**
* Constructs a resource identifier.
*
- * @param publicId The public identifier.
- * @param literalSystemId The literal system identifier.
- * @param baseSystemId The base system identifier.
- * @param expandedSystemId The expanded system identifier.
- * @param namespace The namespace.
+ * @param publicId the public identifier
+ * @param literalSystemId the literal system identifier
+ * @param baseSystemId the URI against which the system identifier should
be resolved
+ * @param expandedSystemId the literalSystemId resolved against
baseSystemId
+ * @param namespace the namespace
*/
public XMLResourceIdentifierImpl(String publicId, String literalSystemId,
String baseSystemId, String
expandedSystemId,
@@ -129,7 +129,11 @@ public class XMLResourceIdentifierImpl
fLiteralSystemId = literalSystemId;
} // setLiteralSystemId(String)
- /** Sets the base system identifier. */
+ /**
+ * Sets the base of the system identifier.
+ *
+ * @param baseSystemId the URI against which the system identifier should
be resolved
+ */
public void setBaseSystemId(String baseSystemId) {
fBaseSystemId = baseSystemId;
} // setBaseSystemId(String)
diff --git a/src/org/apache/xerces/xni/XMLDTDHandler.java
b/src/org/apache/xerces/xni/XMLDTDHandler.java
index 425340ce6..22df7bf7d 100644
--- a/src/org/apache/xerces/xni/XMLDTDHandler.java
+++ b/src/org/apache/xerces/xni/XMLDTDHandler.java
@@ -58,12 +58,12 @@ public interface XMLDTDHandler {
/**
* The start of the DTD.
*
- * @param locator the document locator, or null if the document location
cannot be
- * reported during the parsing of the document DTD.
However, it is
- * <em>strongly</em> recommended that a locator be supplied
that can
- * at least report the base system identifier of the DTD.
+ * @param locator the document locator, or null if the document
+ * location cannot be reported during the parsing of
+ * the document DTD. However, it is <em>strongly</em>
+ * recommended that a locator be supplied that can
+ * at least report the base URI of the DTD.
* @param augmentations additional information that may include infoset
augmentations
- *
* @throws XNIException thrown by handler to signal an error
*/
public void startDTD(XMLLocator locator, Augmentations augmentations)
diff --git a/src/org/apache/xerces/xni/XMLLocator.java
b/src/org/apache/xerces/xni/XMLLocator.java
index a07fc1272..641743c20 100644
--- a/src/org/apache/xerces/xni/XMLLocator.java
+++ b/src/org/apache/xerces/xni/XMLLocator.java
@@ -44,11 +44,7 @@ public interface XMLLocator {
*/
public String getLiteralSystemId();
- /**
- * Returns the base system identifier.
- *
- * @return the base system identifier or null
- */
+ /** Returns the URI against which the system identifier should be
resolved. */
public String getBaseSystemId();
/**
@@ -93,9 +89,9 @@ public interface XMLLocator {
/**
* Returns the XML version of the current entity. This will normally be the
* value from the XML or text declaration or defaulted by the parser. Note
- * that this value may be different from the version of the processing
rules
+ * that this value may be different than the version of the processing
rules
* applied to the current entity. For instance, an XML 1.1 document may
refer to
- * XML 1.0 entities. In such a case the rules of XML 1.1 are applied to
the entire
+ * XML 1.0 entities. In such a case, the rules of XML 1.1 are applied to
the entire
* document. Also note that, for a given entity, this value can only be
considered
* final once the XML or text declaration has been read or once it has been
* determined that there is no such declaration.
diff --git a/src/org/apache/xerces/xni/parser/XMLInputSource.java
b/src/org/apache/xerces/xni/parser/XMLInputSource.java
index da7a3b021..597137c14 100644
--- a/src/org/apache/xerces/xni/parser/XMLInputSource.java
+++ b/src/org/apache/xerces/xni/parser/XMLInputSource.java
@@ -103,17 +103,14 @@ public class XMLInputSource {
/**
* Constructs an input source from a byte stream.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
+ * @param publicId the public identifier, if known
+ * @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
- * is relative, then the base system identifier
- * should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
- * @param byteStream The byte stream.
- * @param encoding The encoding of the byte stream, if known.
+ * is relative, then the baseSystemId should be set.
+ * @param baseSystemId the URI against which the system identifier should
be resolved
+ * @param byteStream the byte stream
+ * @param encoding the encoding of the byte stream, if known
*/
public XMLInputSource(String publicId, String systemId,
String baseSystemId, InputStream byteStream,
@@ -128,18 +125,15 @@ public class XMLInputSource {
/**
* Constructs an input source from a character stream.
*
- * @param publicId The public identifier, if known.
- * @param systemId The system identifier. This value should
+ * @param publicId the public identifier, if known
+ * @param systemId the system identifier. This value should
* always be set, if possible, and can be
* relative or absolute. If the system identifier
- * is relative, then the base system identifier
- * should be set.
- * @param baseSystemId The base system identifier. This value should
- * always be set to the fully expanded URI of the
- * base system identifier, if possible.
- * @param charStream The character stream.
- * @param encoding The original encoding of the byte stream
- * used by the reader, if known.
+ * is relative, then the baseSystemId should be set.
+ * @param baseSystemId the URI against which the system identifier should
be resolved
+ * @param charStream the character stream
+ * @param encoding the original encoding of the byte stream
+ * used by the reader, if known
*/
public XMLInputSource(String publicId, String systemId,
String baseSystemId, Reader charStream,
@@ -184,15 +178,15 @@ public class XMLInputSource {
} // getSystemId():String
/**
- * Sets the base system identifier.
+ * Sets the URI against which the system identifier should be resolved.
*
- * @param baseSystemId The new base system identifier.
+ * @param baseSystemId the URI against which the system identifier should
be resolved
*/
public void setBaseSystemId(String baseSystemId) {
fBaseSystemId = baseSystemId;
} // setBaseSystemId(String)
- /** Returns the base system identifier. */
+ /** Returns the URI against which the system identifier should be
resolved. */
public String getBaseSystemId() {
return fBaseSystemId;
} // getBaseSystemId():String
diff --git a/src/org/apache/xerces/xni/parser/XMLParseException.java
b/src/org/apache/xerces/xni/parser/XMLParseException.java
index 37c833ac9..6cae66e35 100644
--- a/src/org/apache/xerces/xni/parser/XMLParseException.java
+++ b/src/org/apache/xerces/xni/parser/XMLParseException.java
@@ -123,7 +123,7 @@ public class XMLParseException
return fLiteralSystemId;
} // getLiteralSystemId():String
- /** Returns the base system identifier. */
+ /** Returns the URI against which the system identifier should be
resolved. */
public String getBaseSystemId() {
return fBaseSystemId;
} // getBaseSystemId():String
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
