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.
schemaLocation) after being subjects to relative
+ schemaLocation) after relative
URI expansion. SAX programmers will be familiar with this
concept from the SAX Locator interface, for example; this
property maps to the systemId 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.
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 XMLDocumentSource getDocumentSource() {
* Note: 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 void endElement(QName element, Augmentations augs)
* Note: 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 DOMInputImpl() {}
* 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 DOMInputImpl(String publicId, String systemId,
/**
* 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 DOMInputImpl(String publicId, String systemId,
/**
* 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 DOMInputImpl(String publicId, String systemId,
/**
* 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 int getParamEntityRefCount(String entityName) {
* Note: 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 the entity being added 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 the entity is being added 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 XMLEntityScanner() {
//
/**
- * 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 int getAttributeDeclIndex(int elementDeclIndex, String attributeDeclName)
* location cannot be reported during the parsing of
* the document DTD. However, it is strongly
* 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 void processingInstruction(String target, XMLString data, Augmentations a
/**
* 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 strongly
* 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 void endDocument(Augmentations augs) throws XNIException {
/**
* 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 strongly
- * 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 @@ else if (nodeType == Node.PROCESSING_INSTRUCTION_NODE) {
/**
* 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
- * strongly 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 strongly
+ * 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 XMLDocumentSource getDocumentSource (){
/**
* 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
- * strongly 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 strongly
+ * 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 HTTPInputSource(XMLResourceIdentifier resourceIdentifier) {
/**
* 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 HTTPInputSource(String publicId, String systemId,
/**
* 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 XMLEntityDescriptionImpl() {} // Sets the values of this entity description. Sets the values of this entity description.