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 6b0756474 [XERCESJ-1781] Javadoc changes for abstract Parsers &
Handler interfaces (#72)
6b0756474 is described below
commit 6b0756474b63bf8cd2c51ee3b3a25e09eefe7248
Author: Samael <[email protected]>
AuthorDate: Tue Dec 2 12:36:15 2025 +0000
[XERCESJ-1781] Javadoc changes for abstract Parsers & Handler interfaces
(#72)
* [XERCESJ-1781] Javadoc changes for abstract Parsers & Handler interfaces
* [XERCESJ-1781] Javadoc changes for abstract Parsers & Handler interfaces
* [XERCESJ-1781] Javadoc changes for abstract DOM parser
---
.../apache/xerces/parsers/AbstractDOMParser.java | 414 +++++++++++----------
.../xerces/parsers/AbstractXMLDocumentParser.java | 389 ++++++++++---------
.../xerces/xni/XMLDTDContentModelHandler.java | 89 ++---
src/org/apache/xerces/xni/XMLDTDHandler.java | 230 +++++-------
4 files changed, 568 insertions(+), 554 deletions(-)
diff --git a/src/org/apache/xerces/parsers/AbstractDOMParser.java
b/src/org/apache/xerces/parsers/AbstractDOMParser.java
index dd8ca72cc..ccf5577df 100644
--- a/src/org/apache/xerces/parsers/AbstractDOMParser.java
+++ b/src/org/apache/xerces/parsers/AbstractDOMParser.java
@@ -132,6 +132,7 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
protected static final String DOCUMENT_CLASS_NAME =
Constants.XERCES_PROPERTY_PREFIX + Constants.DOCUMENT_CLASS_NAME_PROPERTY;
+ /** Current element node. */
protected static final String CURRENT_ELEMENT_NODE=
Constants.XERCES_PROPERTY_PREFIX + Constants.CURRENT_ELEMENT_NODE_PROPERTY;
@@ -150,9 +151,11 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
protected static final String DEFAULT_DOCUMENT_CLASS_NAME =
"org.apache.xerces.dom.DocumentImpl";
+ /** Full class name for {@link CoreDocumentImpl} */
protected static final String CORE_DOCUMENT_CLASS_NAME =
"org.apache.xerces.dom.CoreDocumentImpl";
+ /** Full class name for {@link PSVIDocumentImpl} */
protected static final String PSVI_DOCUMENT_CLASS_NAME =
"org.apache.xerces.dom.PSVIDocumentImpl";
@@ -163,6 +166,7 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
private static final long serialVersionUID = 1687848994976808490L;
static final Abort INSTANCE = new Abort();
private Abort() {}
+ @Override
public Throwable fillInStackTrace() {
return this;
}
@@ -216,8 +220,14 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/** Current node. */
protected Node fCurrentNode;
+
+ /** Current CDATA section. */
protected CDATASection fCurrentCDATASection;
+
+ /** Current entity declaration. */
protected EntityImpl fCurrentEntityDecl;
+
+ /** Deferred entity declaration. */
protected int fDeferredEntityDecl;
/** Character buffer */
@@ -285,7 +295,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
// Constructors
//
- /** Default constructor. */
+ /**
+ * Default constructor.
+ * <p>Constructs a DOM parser using default features.</p>
+ *
+ * @param config a parser configuration from which properties and features
can be retrieved
+ */
protected AbstractDOMParser (XMLParserConfiguration config) {
super (config);
@@ -311,7 +326,9 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
} // <init>(XMLParserConfiguration)
/**
- * This method retreives the name of current document class.
+ * This method retrieves the name of current document class.
+ *
+ * @return the name of current document class
*/
protected String getDocumentClassName () {
return fDocumentClassName;
@@ -324,9 +341,8 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* a document class other than the default will lose the ability
* to defer node expansion on the DOM tree produced.
*
- * @param documentClassName The fully qualified class name of the
- * document factory to use when constructing
- * the DOM tree.
+ * @param documentClassName the fully qualified class name of the document
factory to
+ * use when constructing the DOM tree
*
* @see #getDocumentClassName
* @see #DEFAULT_DOCUMENT_CLASS_NAME
@@ -372,7 +388,11 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
// Public methods
//
- /** Returns the DOM document object. */
+ /**
+ * Returns the DOM document object.
+ *
+ * @return the DOM document object
+ */
public Document getDocument () {
return fDocument;
} // getDocument():Document
@@ -395,6 +415,7 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
// XMLDocumentParser methods
//
+ @Override
public void reset () throws XNIException {
super.reset ();
@@ -466,17 +487,16 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
*
- * @param name The name of the general entity.
- * @param identifier The resource identifier.
- * @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 name the name of the general entity
+ * @param identifier the resource identifier
+ * @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
*
* @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}.
*/
+ @Override
public void startGeneralEntity (String name,
XMLResourceIdentifier identifier,
String encoding, Augmentations augs)
@@ -561,12 +581,13 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
*
- * @param version The XML version, or null if not specified.
- * @param encoding The IANA encoding name of the entity.
- * @param augs Additional information that may include infoset
augmentations
+ * @param version the XML version, or null if not specified
+ * @param encoding the IANA encoding name of the entity
+ * @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
*/
+ @Override
public void textDecl (String version, String encoding, Augmentations augs)
throws XNIException {
if (fInDTD){
return;
@@ -588,11 +609,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* A comment.
*
- * @param text The text in the comment.
- * @param augs Additional information that may include infoset
augmentations
+ * @param text the text in the comment
+ * @param augs additional information that may include infoset
augmentations
*
* @throws XNIException Thrown by application to signal an error.
*/
+ @Override
public void comment (XMLString text, Augmentations augs) throws
XNIException {
if (fInDTD) {
if (fInternalSubset != null && !fInDTDExternalSubset) {
@@ -660,12 +682,13 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* to the application as anything other than text. The application is
* responsible for parsing the data.
*
- * @param target The target.
- * @param data The data or null if none specified.
- * @param augs Additional information that may include infoset
augmentations
+ * @param target the target
+ * @param data the data or null if none specified
+ * @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
*/
+ @Override
public void processingInstruction (String target, XMLString data,
Augmentations augs)
throws XNIException {
@@ -728,25 +751,19 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The start of the document.
*
- * @param locator The system identifier of the entity if the entity
- * is external, null otherwise.
- * @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 namespaceContext
- * The namespace context in effect at the
- * start of this document.
- * This object represents the current context.
- * Implementors of this class are responsible
- * for copying the namespace bindings from the
- * the current context (and its parent contexts)
- * if that information is important.
- * @param augs Additional information that may include infoset
augmentations
- *
- * @throws XNIException Thrown by handler to signal an error.
+ * @param locator the system identifier of the entity if the entity is
external, otherwise null
+ * @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 namespaceContext the namespace context in effect at the start of
this document.
+ * This object represents the current context. Implementors of this
class are
+ * responsible for copying the namespace bindings from the current
context
+ * (and its parent contexts) if that information is important
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void startDocument (XMLLocator locator, String encoding,
NamespaceContext namespaceContext, Augmentations augs)
throws XNIException {
@@ -846,14 +863,14 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* present, this method will be called immediately following the
* startDocument call.
*
- * @param version The XML version.
- * @param encoding The IANA encoding name of the document, or null if
- * not specified.
- * @param standalone The standalone value, or null if not specified.
- * @param augs Additional information that may include infoset
augmentations
+ * @param version the XML version
+ * @param encoding the IANA encoding name of the document, or null if not
specified
+ * @param standalone the standalone value, or null if not specified
+ * @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
*/
+ @Override
public void xmlDecl (String version, String encoding, String standalone,
Augmentations augs)
throws XNIException {
@@ -878,15 +895,15 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* Notifies of the presence of the DOCTYPE line in the document.
*
- * @param rootElement The name of the root element.
- * @param publicId The public identifier if an external DTD or null
- * if the external DTD is specified using SYSTEM.
- * @param systemId The system identifier if an external DTD, null
- * otherwise.
- * @param augs Additional information that may include infoset
augmentations
+ * @param rootElement the name of the root element
+ * @param publicId the public identifier if an external DTD or null
+ * if the external DTD is specified using SYSTEM
+ * @param systemId the system identifier if an external DTD, null otherwise
+ * @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
*/
+ @Override
public void doctypeDecl (String rootElement,
String publicId, String systemId, Augmentations augs)
throws XNIException {
@@ -911,12 +928,13 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* 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.
- * @param augs Additional information that may include infoset
augmentations
+ * @param element the name of the element
+ * @param attributes the element attributes
+ * @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
*/
+ @Override
public void startElement (QName element, XMLAttributes attributes,
Augmentations augs)
throws XNIException {
if (DEBUG_EVENTS) {
@@ -1122,12 +1140,13 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* An empty element.
*
- * @param element The name of the element.
- * @param attributes The element attributes.
- * @param augs Additional information that may include infoset
augmentations
+ * @param element the name of the element
+ * @param attributes the element attributes
+ * @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
*/
+ @Override
public void emptyElement (QName element, XMLAttributes attributes,
Augmentations augs)
throws XNIException {
@@ -1139,11 +1158,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* Character content.
*
- * @param text The content.
- * @param augs Additional information that may include infoset
augmentations
+ * @param text the content
+ * @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
*/
+ @Override
public void characters (XMLString text, Augmentations augs) throws
XNIException {
if (DEBUG_EVENTS) {
@@ -1238,11 +1258,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* characters in the document are ignorable based on the element
* content model.
*
- * @param text The ignorable whitespace.
- * @param augs Additional information that may include infoset
augmentations
+ * @param text the ignorable whitespace
+ * @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
*/
+ @Override
public void ignorableWhitespace (XMLString text, Augmentations augs)
throws XNIException {
if (!fIncludeIgnorableWhitespace || fFilterReject) {
@@ -1276,11 +1297,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The end of an element.
*
- * @param element The name of the element.
- * @param augs Additional information that may include infoset
augmentations
+ * @param element the name of the element
+ * @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
*/
+ @Override
public void endElement (QName element, Augmentations augs) throws
XNIException {
if (DEBUG_EVENTS) {
System.out.println ("==>endElement ("+element.rawname+")");
@@ -1390,10 +1412,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The start of a CDATA section.
- * @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
*/
+ @Override
public void startCDATA (Augmentations augs) throws XNIException {
fInCDATASection = true;
@@ -1409,10 +1433,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The end of a CDATA section.
- * @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
*/
+ @Override
public void endCDATA (Augmentations augs) throws XNIException {
fInCDATASection = false;
@@ -1463,10 +1489,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The end of the document.
- * @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
*/
+ @Override
public void endDocument (Augmentations augs) throws XNIException {
if (!fDeferNodeExpansion) {
@@ -1497,12 +1525,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* <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 augs Additional information that may include infoset
augmentations
+ * @param name the name of the entity
+ * @param augs additional information that may include infoset
augmentations
*
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @exception XNIException thrown by handler to signal an error
*/
+ @Override
public void endGeneralEntity (String name, Augmentations augs) throws
XNIException {
if (DEBUG_EVENTS) {
System.out.println ("==>endGeneralEntity: ("+name+")");
@@ -1676,10 +1704,9 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* Record baseURI information for the Element (by adding xml:base
attribute)
- * or for the ProcessingInstruction (by setting a baseURI field)
- * Non deferred DOM.
+ * or for the ProcessingInstruction (by setting a baseURI field)
Non-deferred DOM.
*
- * @param node
+ * @param node the Node on which to set the <code>xml:base</code>
attribute, if required
*/
protected final void handleBaseURI (Node node){
if (fDocumentImpl != null) {
@@ -1699,7 +1726,7 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
} else if (((Element)node).getAttributeNode ("xml:base") !=
null) {
return;
}
- // retrive the baseURI from the entity reference
+ // retrieve the baseURI from the entity reference
baseURI = ((EntityReferenceImpl)fCurrentNode).getBaseURI ();
if (baseURI !=null && !baseURI.equals
(fDocumentImpl.getDocumentURI ())) {
if (fNamespaceAware) {
@@ -1724,12 +1751,10 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
}
/**
- *
* Record baseURI information for the Element (by adding xml:base
attribute)
- * or for the ProcessingInstruction (by setting a baseURI field)
- * Deferred DOM.
+ * or for the ProcessingInstruction (by setting a baseURI field) Deferred
DOM.
*
- * @param node
+ * @param node the index of the Node on which to set the
<code>xml:base</code> attribute, if required
*/
protected final void handleBaseURI (int node){
short nodeType = fDeferredDocumentImpl.getNodeType (node, false);
@@ -1776,17 +1801,15 @@ 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 augs Additional information that may include infoset
- * augmentations.
+ * @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
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void startDTD (XMLLocator locator, Augmentations augs) throws
XNIException {
if (DEBUG_EVENTS) {
System.out.println ("==>startDTD");
@@ -1809,11 +1832,11 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The end of the DTD.
*
- * @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.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void endDTD (Augmentations augs) throws XNIException {
if (DEBUG_EVENTS) {
System.out.println ("==>endDTD()");
@@ -1839,27 +1862,27 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The start of a conditional section.
*
- * @param type The type of the conditional section. This value will
- * either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param type the type of the conditional section. This value will either
be
+ * CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE
+ * @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
*
- * @see #CONDITIONAL_INCLUDE
- * @see #CONDITIONAL_IGNORE
+ * @see org.apache.xerces.xni.XMLDTDHandler#CONDITIONAL_INCLUDE
+ * @see org.apache.xerces.xni.XMLDTDHandler#CONDITIONAL_IGNORE
*/
+ @Override
public void startConditional (short type, Augmentations augs) throws
XNIException {
} // startConditional(short)
/**
* The end of a conditional section.
*
- * @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.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void endConditional (Augmentations augs) throws XNIException {
} // endConditional()
@@ -1867,11 +1890,11 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The start of the DTD external subset.
*
- * @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.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void startExternalSubset (XMLResourceIdentifier identifier,
Augmentations augs) throws XNIException {
if (DEBUG_EVENTS) {
@@ -1888,11 +1911,11 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The end of the DTD external subset.
*
- * @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.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void endExternalSubset (Augmentations augs) throws XNIException {
fInDTDExternalSubset = false;
fBaseURIStack.pop ();
@@ -1901,19 +1924,17 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* An internal entity declaration.
*
- * @param name The name of the entity. Parameter entity names start with
- * '%', whereas the name of a general entity is just the
- * entity name.
- * @param text The value of the entity.
- * @param nonNormalizedText The non-normalized value of the entity. This
- * value contains the same sequence of characters that was in
- * the internal entity declaration, without any entity
- * references expanded.
- * @param augs Additional information that may include infoset
- * augmentations.
- *
- * @throws XNIException Thrown by handler to signal an error.
+ * @param name the name of the entity. Parameter entity names start with
'%', whereas
+ * the name of a general entity is just the entity name.
+ * @param text the value of the entity
+ * @param nonNormalizedText The non-normalized value of the entity. This
value contains
+ * the same sequence of characters that was in the internal
entity declaration,
+ * without any entity references expanded.
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void internalEntityDecl (String name, XMLString text,
XMLString nonNormalizedText,
Augmentations augs) throws XNIException {
@@ -1988,16 +2009,14 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* An external entity declaration.
*
- * @param name The name of the entity. Parameter entity names start
- * with '%', whereas the name of a general entity is just
- * the entity name.
- * @param identifier An object containing all location information
- * pertinent to this notation.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param name the name of the entity. Parameter entity names start with
'%', whereas the
+ * name of a general entity is just the entity name
+ * @param identifier an object containing all location information
pertinent to this notation
+ * @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
*/
+ @Override
public void externalEntityDecl (String name, XMLResourceIdentifier
identifier,
Augmentations augs) throws XNIException {
@@ -2083,17 +2102,17 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* This method notifies of the start of a parameter entity. The parameter
* entity name start with a '%' character.
*
- * @param name The name of the parameter entity.
- * @param identifier The resource identifier.
+ * @param name the name of the parameter entity
+ * @param identifier the resource identifier
* @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 parameter entities).
- * @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.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void startParameterEntity (String name,
XMLResourceIdentifier identifier,
String encoding,
@@ -2118,12 +2137,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* This method notifies the end of a parameter entity. Parameter entity
* names begin with a '%' character.
*
- * @param name The name of the parameter entity.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param name the name of the parameter entity
+ * @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
*/
+ @Override
public void endParameterEntity (String name, Augmentations augs) throws
XNIException {
if (DEBUG_EVENTS) {
@@ -2135,15 +2154,14 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* An unparsed entity declaration.
*
- * @param name The name of the entity.
- * @param identifier An object containing all location information
- * pertinent to this entity.
- * @param notation The name of the notation.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param name the name of the entity
+ * @param identifier an object containing all location information
pertinent to this entity
+ * @param notation the name of the notation
+ * @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
*/
+ @Override
public void unparsedEntityDecl (String name, XMLResourceIdentifier
identifier,
String notation, Augmentations augs)
throws XNIException {
@@ -2222,16 +2240,15 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
} // unparsedEntityDecl(String,XMLResourceIdentifier, String,
Augmentations)
/**
- * A notation declaration
+ * A notation declaration.
*
- * @param name The name of the notation.
- * @param identifier An object containing all location information
- * pertinent to this notation.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param name the name of the notation
+ * @param identifier an object containing all location information
pertinent to this notation
+ * @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
*/
+ @Override
public void notationDecl (String name, XMLResourceIdentifier identifier,
Augmentations augs) throws XNIException {
@@ -2299,12 +2316,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* Characters within an IGNORE conditional section.
*
- * @param text The ignored text.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param text the ignored text
+ * @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
*/
+ @Override
public void ignoredCharacters (XMLString text, Augmentations augs) throws
XNIException {
} // ignoredCharacters(XMLString, Augmentations)
@@ -2312,13 +2329,13 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* An element declaration.
*
- * @param name The name of the element.
- * @param contentModel The element content model.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param name the name of the element
+ * @param contentModel the element content model
+ * @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
*/
+ @Override
public void elementDecl (String name, String contentModel, Augmentations
augs)
throws XNIException {
@@ -2350,14 +2367,14 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
* one of the following: "#FIXED", "#IMPLIED",
* "#REQUIRED", or null.
* @param defaultValue The attribute default value, or null if no
- * default value is specified.
- * @param nonNormalizedDefaultValue The attribute default value with no
normalization
- * performed, or null if no default value is
specified.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * default value is specified
+ * @param nonNormalizedDefaultValue The attribute default value with no
normalization
+ * performed, or null if no default value is specified
+ * @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
*/
+ @Override
public void attributeDecl (String elementName, String attributeName,
String type, String[] enumeration,
String defaultType, XMLString defaultValue,
@@ -2505,13 +2522,12 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The start of an attribute list.
*
- * @param elementName The name of the element that this attribute
- * list is associated with.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param elementName the name of the element that this attribute list is
associated with
+ * @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
*/
+ @Override
public void startAttlist (String elementName, Augmentations augs) throws
XNIException {
} // startAttlist(String)
@@ -2519,11 +2535,11 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
* The end of an attribute list.
*
- * @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.
+ * @throws XNIException Thrown by handler to signal an error
*/
+ @Override
public void endAttlist (Augmentations augs) throws XNIException {
} // endAttlist()
@@ -2551,8 +2567,13 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
return el;
}
- // method to create an attribute node.
- // subclasses can override this method to create attribute nodes in other
ways.
+ /**
+ * Create an attribute node.
+ * <p>subclasses can override this method to create attribute nodes in
other ways.</p>
+ *
+ * @param attrQName qualified name for the attribute
+ * @return a new attribute node
+ */
protected Attr createAttrNode (QName attrQName) {
Attr attr = null;
@@ -2576,20 +2597,21 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
return attr;
}
- /*
- * When the first characters() call is received, the data is stored in
+ /**
+ * When the first {@link #characters(XMLString, Augmentations)} call is
received, the data is stored in
* a new Text node. If right after the first characters() we receive
another chunk of data,
* the data from the Text node, following the new characters are appended
- * to the fStringBuffer and the text node data is set to empty.
+ * to the {@link #fStringBuffer} and the text node data is set to empty.
*
- * This function is called when the state is changed and the
- * data must be appended to the current node.
+ * <p>This function is called when the state is changed and the data must
be appended
+ * to the current node.</p>
*
- * Note: if DOMFilter is set, you must make sure that if Node is skipped,
- * or removed fFistChunk must be set to true, otherwise some data can be
lost.
+ * <p><em>Note</em>: if DOMFilter is set, you must make sure that if Node
is skipped, or removed
+ * {@link #fFirstChunk} must be set to true, otherwise some data can be
lost.</p>
*
+ * @param sawChars sets the value of {@link #fFirstChunk}
*/
- protected void setCharacterData (boolean sawChars){
+ protected void setCharacterData (boolean sawChars) {
// handle character data
fFirstChunk = sawChars;
@@ -2641,6 +2663,10 @@ public class AbstractDOMParser extends
AbstractXMLDocumentParser {
/**
+ * Called when the user stops the parer.
+ * The default behaviour is to throw an {@link Abort} exception.
+ *
+ * @see Abort#INSTANCE
* @see org.w3c.dom.ls.LSParser#abort()
*/
public void abort () {
diff --git a/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
b/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
index 2e6238ebd..f6fe604f3 100644
--- a/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
+++ b/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
@@ -72,8 +72,9 @@ public abstract class AbstractXMLDocumentParser
//
/**
- * Constructs a document parser using the default symbol table
- * and grammar pool.
+ * Constructs a document parser using the default symbol table and grammar
pool.
+ *
+ * @param config a parser configuration from which properties and features
can be retrieved
*/
protected AbstractXMLDocumentParser(XMLParserConfiguration config) {
super(config);
@@ -92,26 +93,19 @@ public abstract class AbstractXMLDocumentParser
/**
* The start of the document.
*
- * @param locator The system identifier of the entity if the entity
- * is external, null otherwise.
- * @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 namespaceContext
- * The namespace context in effect at the
- * start of this document.
- * This object represents the current context.
- * Implementors of this class are responsible
- * for copying the namespace bindings from the
- * the current context (and its parent contexts)
- * if that information is important.
- * @param augs Additional information that may include infoset
augmentations
+ * @param locator the system identifier of the entity if the entity is
external, otherwise null
+ * @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 namespaceContext the namespace context in effect at the start of
this document.
+ * This object represents the current context. Implementors of this
class are
+ * responsible for copying the namespace bindings from the current
context
+ * (and its parent contexts) if that information is important
+ * @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
*/
-
+ @Override
public void startDocument(XMLLocator locator, String encoding,
NamespaceContext namespaceContext, Augmentations
augs)
throws XNIException {
@@ -122,14 +116,14 @@ public abstract class AbstractXMLDocumentParser
* present, this method will be called immediately following the
* startDocument call.
*
- * @param version The XML version.
- * @param encoding The IANA encoding name of the document, or null if
- * not specified.
- * @param standalone The standalone value, or null if not specified.
- * @param augs Additional information that may include infoset
augmentations
+ * @param version the XML version
+ * @param encoding the IANA encoding name of the document, or null if not
specified
+ * @param standalone the standalone value, or null if not specified
+ * @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
*/
+ @Override
public void xmlDecl(String version, String encoding, String standalone,
Augmentations augs)
throws XNIException {
} // xmlDecl(String,String,String)
@@ -137,15 +131,15 @@ public abstract class AbstractXMLDocumentParser
/**
* Notifies of the presence of the DOCTYPE line in the document.
*
- * @param rootElement The name of the root element.
- * @param publicId The public identifier if an external DTD or null
- * if the external DTD is specified using SYSTEM.
- * @param systemId The system identifier if an external DTD, null
- * @param augs Additional information that may include infoset
augmentations
- * otherwise.
+ * @param rootElement the name of the root element
+ * @param publicId the public identifier if an external DTD or null if the
external DTD
+ * is specified using SYSTEM
+ * @param systemId the system identifier if an external DTD, null
+ * @param augs additional information that may include infoset
augmentations otherwise
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void doctypeDecl(String rootElement, String publicId, String
systemId, Augmentations augs)
throws XNIException {
} // doctypeDecl(String,String,String)
@@ -155,11 +149,11 @@ public abstract class AbstractXMLDocumentParser
* 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.
- * @param augs Additional information that may include infoset
augmentations
+ * @param element the name of the element
+ * @param attributes the element attributes
+ * @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 startElement(QName element, XMLAttributes attributes,
Augmentations augs)
throws XNIException {
@@ -168,12 +162,13 @@ public abstract class AbstractXMLDocumentParser
/**
* An empty element.
*
- * @param element The name of the element.
- * @param attributes The element attributes.
- * @param augs Additional information that may include infoset
augmentations
+ * @param element the name of the element
+ * @param attributes the element attributes
+ * @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
*/
+ @Override
public void emptyElement(QName element, XMLAttributes attributes,
Augmentations augs)
throws XNIException {
@@ -185,11 +180,12 @@ public abstract class AbstractXMLDocumentParser
/**
* Character content.
*
- * @param text The content.
- * @param augs Additional information that may include infoset
augmentations
+ * @param text the content
+ * @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
*/
+ @Override
public void characters(XMLString text, Augmentations augs) throws
XNIException {
} // characters(XMLString)
@@ -201,49 +197,57 @@ public abstract class AbstractXMLDocumentParser
* characters in the document are ignorable based on the element
* content model.
*
- * @param text The ignorable whitespace.
- * @param augs Additional information that may include infoset
augmentations
+ * @param text the ignorable whitespace
+ * @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
*/
+ @Override
public void ignorableWhitespace(XMLString text, Augmentations augs) throws
XNIException {
} // ignorableWhitespace(XMLString)
/**
* The end of an element.
*
- * @param element The name of the element.
- * @param augs Additional information that may include infoset
augmentations
+ * @param element yhe name of the element
+ * @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
*/
+ @Override
public void endElement(QName element, Augmentations augs) throws
XNIException {
} // endElement(QName)
/**
- * The start of a CDATA section.
- * @param augs Additional information that may include infoset
augmentations
+ * The start of a CDATA section.
*
- * @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
*/
+ @Override
public void startCDATA(Augmentations augs) throws XNIException {
} // startCDATA()
/**
* The end of a CDATA section.
- * @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
*/
+ @Override
public void endCDATA(Augmentations augs) throws XNIException {
} // endCDATA()
/**
* The end of the document.
- * @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
*/
+ @Override
public void endDocument(Augmentations augs) throws XNIException {
} // endDocument()
@@ -254,17 +258,16 @@ public abstract class AbstractXMLDocumentParser
* <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 identifier The resource identifier.
- * @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 name the name of the entity
+ * @param identifier the resource identifier
+ * @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
*
* @throws XNIException if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}.
*/
+ @Override
public void startGeneralEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
@@ -281,14 +284,14 @@ public abstract class AbstractXMLDocumentParser
* <p>
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
- *
- * @param version The XML version, or null if not specified.
- * @param encoding The IANA encoding name of the entity.
- * @param augs Additional information that may include infoset
augmentations
- *
- * @exception XNIException
- * Thrown by handler to signal an error.
+ *
+ * @param version the XML version, or null if not specified
+ * @param encoding the IANA encoding name of the entity
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void textDecl(String version, String encoding, Augmentations augs)
throws XNIException {
} // textDecl(String, String, Augmentations)
@@ -298,25 +301,25 @@ public abstract class AbstractXMLDocumentParser
* <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 augs Additional information that may include infoset
augmentations
- *
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @param name the name of the entity
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @exception XNIException thrown by handler to signal an error
*/
+ @Override
public void endGeneralEntity(String name, Augmentations augs)
throws XNIException {
} // endGeneralEntity(String,Augmentations)
-
+
/**
* A comment.
- *
- * @param text The text in the comment.
- * @param augs Additional information that may include infoset
augmentations
- *
- * @exception XNIException
- * Thrown by application to signal an error.
+ *
+ * @param text the text in the comment
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by application to signal an error
*/
+ @Override
public void comment(XMLString text, Augmentations augs) throws
XNIException {
} // comment (XMLString, Augmentations)
@@ -330,46 +333,46 @@ public abstract class AbstractXMLDocumentParser
* element attributes but are <strong>not</strong> parsed or presented
* to the application as anything other than text. The application is
* responsible for parsing the data.
- *
- * @param target The target.
- * @param data The data or null if none specified.
- * @param augs Additional information that may include infoset
augmentations
- *
- * @exception XNIException
- * Thrown by handler to signal an error.
+ *
+ * @param target the target
+ * @param data the data or null if none specified
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void processingInstruction(String target, XMLString data,
Augmentations augs)
throws XNIException {
} // processingInstruction(String, XMLString, Augmentations)
/** Sets the document source */
+ @Override
public void setDocumentSource(XMLDocumentSource source){
fDocumentSource = source;
} // setDocumentSource
/** Returns the document source */
+ @Override
public XMLDocumentSource getDocumentSource (){
return fDocumentSource;
} // getDocumentSource
//
// XMLDTDHandler methods
//
-
+
/**
* 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 augs Additional information that may include infoset
- * augmentations.
+ * @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
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void startDTD(XMLLocator locator, Augmentations augs) throws
XNIException {
fInDTD = true;
} // startDTD(XMLLocator)
@@ -378,11 +381,12 @@ public abstract class AbstractXMLDocumentParser
/**
* The start of the DTD external subset.
*
- * @param augmentations Additional information that may include infoset
+ * @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
*/
+ @Override
public void startExternalSubset(XMLResourceIdentifier identifier,
Augmentations augmentations)
throws XNIException {
} // startExternalSubset(Augmentations)
@@ -390,11 +394,12 @@ public abstract class AbstractXMLDocumentParser
/**
* The end of the DTD external subset.
*
- * @param augmentations Additional information that may include infoset
+ * @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
*/
+ @Override
public void endExternalSubset(Augmentations augmentations)
throws XNIException {
} // endExternalSubset(Augmentations)
@@ -412,10 +417,11 @@ public abstract class AbstractXMLDocumentParser
* 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 if an error occurs. This should be handled by
implementations of {@link org.apache.xerces.xni.XMLDocumentHandler}.
*/
+ @Override
public void startParameterEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
@@ -429,11 +435,12 @@ public abstract class AbstractXMLDocumentParser
* appearing as part of attribute values.
*
* @param name The name of the entity.
- * @param augs Additional information that may include infoset
augmentations
+ * @param augs additional information that may include infoset
augmentations
*
* @exception XNIException
* Thrown by handler to signal an error.
*/
+ @Override
public void endParameterEntity(String name, Augmentations augs)
throws XNIException {
} // endParameterEntity(String,Augmentations)
@@ -442,24 +449,26 @@ public abstract class AbstractXMLDocumentParser
* Characters within an IGNORE conditional section.
*
* @param text The ignored text.
- * @param augs Additional information that may include infoset
+ * @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 ignoredCharacters(XMLString text, Augmentations augs) throws
XNIException {
- } // ignoredCharacters(XMLString, Augmentations)
+ @Override
+ public void ignoredCharacters(XMLString text, Augmentations augs) throws
XNIException {
+ } // ignoredCharacters(XMLString, Augmentations)
/**
* An element declaration.
*
* @param name The name of the element.
* @param contentModel The element content model.
- * @param augs Additional information that may include infoset
+ * @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
*/
+ @Override
public void elementDecl(String name, String contentModel, Augmentations
augs)
throws XNIException {
} // elementDecl(String,String)
@@ -469,11 +478,12 @@ public abstract class AbstractXMLDocumentParser
*
* @param elementName The name of the element that this attribute
* list is associated with.
- * @param augs Additional information that may include infoset
+ * @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
*/
+ @Override
public void startAttlist(String elementName, Augmentations augs) throws
XNIException {
} // startAttlist(String)
@@ -497,11 +507,12 @@ public abstract class AbstractXMLDocumentParser
* default value is specified.
* @param nonNormalizedDefaultValue The attribute default value with no
normalization
* performed, or null if no default value is
specified.
- * @param augs Additional information that may include infoset
+ * @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
*/
+ @Override
public void attributeDecl(String elementName, String attributeName,
String type, String[] enumeration,
String defaultType, XMLString defaultValue,
@@ -512,11 +523,12 @@ public abstract class AbstractXMLDocumentParser
/**
* The end of an attribute list.
*
- * @param augs Additional information that may include infoset
+ * @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
*/
+ @Override
public void endAttlist(Augmentations augs) throws XNIException {
} // endAttlist()
@@ -531,11 +543,12 @@ public abstract class AbstractXMLDocumentParser
* value contains the same sequence of characters that was in
* the internal entity declaration, without any entity
* references expanded.
- * @param augs Additional information that may include infoset
+ * @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
*/
+ @Override
public void internalEntityDecl(String name, XMLString text,
XMLString nonNormalizedText, Augmentations
augs)
throws XNIException {
@@ -543,48 +556,46 @@ public abstract class AbstractXMLDocumentParser
/**
* An external entity declaration.
- *
- * @param name The name of the entity. Parameter entity names start
- * with '%', whereas the name of a general entity is just
- * the entity name.
- * @param identifier An object containing all location information
- * pertinent to this entity.
- * @param augs Additional information that may include infoset
- * augmentations.
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @param name the name of the entity. Parameter entity names start with
'%', whereas
+ * the name of a general entity is just the entity name
+ * @param identifier an object containing all location information
pertinent to this
+ * external entity
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void externalEntityDecl(String name, XMLResourceIdentifier
identifier,
Augmentations augs) throws XNIException {
} // externalEntityDecl(String,XMLResourceIdentifier, Augmentations)
/**
* An unparsed entity declaration.
- *
- * @param name The name of the entity.
- * @param identifier An object containing all location information
- * pertinent to this entity.
- * @param notation The name of the notation.
- * @param augs Additional information that may include infoset
- * augmentations.
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @param name the name of the entity
+ * @param identifier an object containing all location information
pertinent to this
+ * unparsed entity declaration
+ * @param notation the name of the notation
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void unparsedEntityDecl(String name, XMLResourceIdentifier
identifier,
String notation, Augmentations augs) throws
XNIException {
} // unparsedEntityDecl(String,XMLResourceIdentifier, String,
Augmentations)
/**
* A notation declaration
- *
- * @param name The name of the notation.
- * @param identifier An object containing all location information
- * pertinent to this notation.
- * @param augs Additional information that may include infoset
- * augmentations.
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @param name the name of the notation
+ * @param identifier an object containing all location information
pertinent to this notation
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void notationDecl(String name, XMLResourceIdentifier identifier,
Augmentations augs)
throws XNIException {
@@ -593,48 +604,48 @@ public abstract class AbstractXMLDocumentParser
/**
* The start of a conditional section.
*
- * @param type The type of the conditional section. This value will
- * either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.
- * @param augs Additional information that may include infoset
- * augmentations.
+ * @param type the type of the conditional section. This value will either
be
+ * CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE
+ * @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
*
- * @see #CONDITIONAL_INCLUDE
- * @see #CONDITIONAL_IGNORE
+ * @see org.apache.xerces.xni.XMLDTDHandler#CONDITIONAL_INCLUDE
+ * @see org.apache.xerces.xni.XMLDTDHandler#CONDITIONAL_IGNORE
*/
+ @Override
public void startConditional(short type, Augmentations augs) throws
XNIException {
} // startConditional(short)
/**
* The end of a conditional section.
*
- * @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.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void endConditional(Augmentations augs) throws XNIException {
} // endConditional()
/**
* The end of the DTD.
*
- * @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.
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void endDTD(Augmentations augs) throws XNIException {
fInDTD = false;
} // endDTD()
- // set the source of this handler
+ @Override
public void setDTDSource(XMLDTDSource source) {
fDTDSource = source;
}
- // return the source from which this handler derives its events
+ @Override
public XMLDTDSource getDTDSource() {
return fDTDSource;
}
@@ -647,41 +658,43 @@ public abstract class AbstractXMLDocumentParser
* The start of a content model. Depending on the type of the content
* model, specific methods may be called between the call to the
* startContentModel method and the call to the endContentModel method.
- *
- * @param elementName The name of the element.
- * @param augs Additional information that may include infoset
- * augmentations.
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @param elementName the name of the element
+ * @param augs additional information that may include infoset
augmentations
+ *
+ * @throws XNIException thrown by handler to signal an error
*/
+ @Override
public void startContentModel(String elementName, Augmentations augs)
throws XNIException {
} // startContentModel(String, Augmentations)
/**
* A content model of ANY.
*
- * @param augs Additional information that may include infoset
+ * @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
*
* @see #empty
* @see #startGroup
*/
+ @Override
public void any(Augmentations augs) throws XNIException {
} // any(Augmentations)
/**
* A content model of EMPTY.
*
- * @param augs Additional information that may include infoset
+ * @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
*
* @see #any
* @see #startGroup
*/
+ @Override
public void empty(Augmentations augs) throws XNIException {
} // empty(Augmentations)
@@ -691,14 +704,15 @@ public abstract class AbstractXMLDocumentParser
* <code>pcdata()</code> method. A children content model will
* contain additional groups and/or elements.
*
- * @param augs Additional information that may include infoset
+ * @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
*
* @see #any
* @see #empty
*/
+ @Override
public void startGroup(Augmentations augs) throws XNIException {
} // stargGroup(Augmentations)
@@ -707,13 +721,14 @@ public abstract class AbstractXMLDocumentParser
* mixed content model. This method will be the first called
* following the content model's <code>startGroup()</code>.
*
- * @param augs Additional information that may include infoset
+ * @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
*
* @see #startGroup
*/
+ @Override
public void pcdata(Augmentations augs) throws XNIException {
} // pcdata(Augmentations)
@@ -721,11 +736,12 @@ public abstract class AbstractXMLDocumentParser
* A referenced element in a mixed or children content model.
*
* @param elementName The name of the referenced element.
- * @param augs Additional information that may include infoset
+ * @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
*/
+ @Override
public void element(String elementName, Augmentations augs) throws
XNIException {
} // element(String, Augmentations)
@@ -734,14 +750,15 @@ public abstract class AbstractXMLDocumentParser
* content model.
*
* @param separator The type of children separator.
- * @param augs Additional information that may include infoset
+ * @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
*
* @see #SEPARATOR_CHOICE
* @see #SEPARATOR_SEQUENCE
*/
+ @Override
public void separator(short separator, Augmentations augs) throws
XNIException {
} // separator(short, Augmentations)
@@ -751,46 +768,51 @@ public abstract class AbstractXMLDocumentParser
*
* @param occurrence The occurrence count for the last element
* or group.
- * @param augs Additional information that may include infoset
+ * @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
*
* @see #OCCURS_ZERO_OR_ONE
* @see #OCCURS_ZERO_OR_MORE
* @see #OCCURS_ONE_OR_MORE
*/
+ @Override
public void occurrence(short occurrence, Augmentations augs) throws
XNIException {
} // occurence(short, Augmentations)
/**
* The end of a group for mixed or children content models.
*
- * @param augs Additional information that may include infoset
+ * @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
*/
+ @Override
public void endGroup(Augmentations augs) throws XNIException {
} // endGroup(Augmentations)
/**
* The end of a content model.
*
- * @param augs Additional information that may include infoset
+ * @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
*/
+ @Override
public void endContentModel(Augmentations augs) throws XNIException {
} // endContentModel(Augmentations)
// set content model source
+ @Override
public void setDTDContentModelSource(XMLDTDContentModelSource source) {
fDTDContentModelSource = source;
}
// get content model source
+ @Override
public XMLDTDContentModelSource getDTDContentModelSource() {
return fDTDContentModelSource;
}
@@ -799,6 +821,7 @@ public abstract class AbstractXMLDocumentParser
// Protected methods
//
+ @Override
protected void reset() throws XNIException {
super.reset();
fInDTD = false;
diff --git a/src/org/apache/xerces/xni/XMLDTDContentModelHandler.java
b/src/org/apache/xerces/xni/XMLDTDContentModelHandler.java
index ca20e17c0..19619e75a 100644
--- a/src/org/apache/xerces/xni/XMLDTDContentModelHandler.java
+++ b/src/org/apache/xerces/xni/XMLDTDContentModelHandler.java
@@ -51,7 +51,7 @@ public interface XMLDTDContentModelHandler {
* <!ELEMENT elem (#PCDATA|foo|bar)*>
* </pre>
*
- * @see #SEPARATOR_SEQUENCE
+ * @see XMLDTDContentModelHandler#SEPARATOR_SEQUENCE
*/
public static final short SEPARATOR_CHOICE = 0;
@@ -64,7 +64,7 @@ public interface XMLDTDContentModelHandler {
* <!ELEMENT elem (foo,bar,baz)>
* </pre>
*
- * @see #SEPARATOR_CHOICE
+ * @see XMLDTDContentModelHandler#SEPARATOR_CHOICE
*/
public static final short SEPARATOR_SEQUENCE = 1;
@@ -78,8 +78,8 @@ public interface XMLDTDContentModelHandler {
* <!ELEMENT elem (foo?)>
* </pre>
*
- * @see #OCCURS_ZERO_OR_MORE
- * @see #OCCURS_ONE_OR_MORE
+ * @see XMLDTDContentModelHandler#OCCURS_ZERO_OR_MORE
+ * @see XMLDTDContentModelHandler#OCCURS_ONE_OR_MORE
*/
public static final short OCCURS_ZERO_OR_ONE = 2;
@@ -93,8 +93,8 @@ public interface XMLDTDContentModelHandler {
* <!ELEMENT elem (#PCDATA|foo|bar)*>
* </pre>
*
- * @see #OCCURS_ZERO_OR_ONE
- * @see #OCCURS_ONE_OR_MORE
+ * @see XMLDTDContentModelHandler#OCCURS_ZERO_OR_ONE
+ * @see XMLDTDContentModelHandler#OCCURS_ONE_OR_MORE
*/
public static final short OCCURS_ZERO_OR_MORE = 3;
@@ -107,8 +107,8 @@ public interface XMLDTDContentModelHandler {
* <!ELEMENT elem (foo+)>
* </pre>
*
- * @see #OCCURS_ZERO_OR_ONE
- * @see #OCCURS_ZERO_OR_MORE
+ * @see XMLDTDContentModelHandler#OCCURS_ZERO_OR_ONE
+ * @see XMLDTDContentModelHandler#OCCURS_ZERO_OR_MORE
*/
public static final short OCCURS_ONE_OR_MORE = 4;
@@ -121,11 +121,10 @@ public interface XMLDTDContentModelHandler {
* model, specific methods may be called between the call to the
* startContentModel method and the call to the endContentModel method.
*
- * @param elementName The name of the element.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param elementName the name of the element
+ * @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 startContentModel(String elementName, Augmentations
augmentations)
throws XNIException;
@@ -133,56 +132,50 @@ public interface XMLDTDContentModelHandler {
/**
* A content model of ANY.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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
*
- * @see #empty
- * @see #startGroup
+ * @see XMLDTDContentModelHandler#empty
+ * @see XMLDTDContentModelHandler#startGroup
*/
public void any(Augmentations augmentations) throws XNIException;
/**
* A content model of EMPTY.
*
- * @throws XNIException Thrown by handler to signal an error.
+ * @throws XNIException thrown by handler to signal an error
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param augmentations additional information that may include infoset
augmentations
*
- * @see #any
- * @see #startGroup
+ * @see XMLDTDContentModelHandler#any
+ * @see XMLDTDContentModelHandler#startGroup
*/
public void empty(Augmentations augmentations) throws XNIException;
/**
- * A start of either a mixed or children content model. A mixed
- * content model will immediately be followed by a call to the
- * <code>pcdata()</code> method. A children content model will
- * contain additional groups and/or elements.
+ * A start of either a mixed or children content model. A mixed content
model will
+ * immediately be followed by a call to the {@link #pcdata(Augmentations)}
method.
+ * A children content model will contain additional groups and/or elements.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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
*
- * @see #any
- * @see #empty
+ * @see XMLDTDContentModelHandler#any
+ * @see XMLDTDContentModelHandler#empty
*/
public void startGroup(Augmentations augmentations) throws XNIException;
/**
- * The appearance of "#PCDATA" within a group signifying a
- * mixed content model. This method will be the first called
- * following the content model's <code>startGroup()</code>.
+ * The appearance of "#PCDATA" within a group signifying a mixed content
model.
+ * This method will be the first called following the content model's
{@link #startGroup(Augmentations)}.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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
*
- * @see #startGroup
+ * @see XMLDTDContentModelHandler#startGroup
*/
public void pcdata(Augmentations augmentations) throws XNIException;
@@ -206,8 +199,8 @@ public interface XMLDTDContentModelHandler {
*
* @throws XNIException thrown by handler to signal an error
*
- * @see #SEPARATOR_CHOICE
- * @see #SEPARATOR_SEQUENCE
+ * @see XMLDTDContentModelHandler#SEPARATOR_CHOICE
+ * @see XMLDTDContentModelHandler#SEPARATOR_SEQUENCE
*/
public void separator(short separator, Augmentations augmentations)
throws XNIException;
@@ -221,9 +214,9 @@ public interface XMLDTDContentModelHandler {
*
* @throws XNIException thrown by handler to signal an error
*
- * @see #OCCURS_ZERO_OR_ONE
- * @see #OCCURS_ZERO_OR_MORE
- * @see #OCCURS_ONE_OR_MORE
+ * @see XMLDTDContentModelHandler#OCCURS_ZERO_OR_ONE
+ * @see XMLDTDContentModelHandler#OCCURS_ZERO_OR_MORE
+ * @see XMLDTDContentModelHandler#OCCURS_ONE_OR_MORE
*/
public void occurrence(short occurrence, Augmentations augmentations)
throws XNIException;
@@ -231,20 +224,18 @@ public interface XMLDTDContentModelHandler {
/**
* The end of a group for mixed or children content models.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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 endGroup(Augmentations augmentations) throws XNIException;
/**
* The end of a content model.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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 endContentModel(Augmentations augmentations) throws
XNIException;
diff --git a/src/org/apache/xerces/xni/XMLDTDHandler.java
b/src/org/apache/xerces/xni/XMLDTDHandler.java
index 59cec6e75..425340ce6 100644
--- a/src/org/apache/xerces/xni/XMLDTDHandler.java
+++ b/src/org/apache/xerces/xni/XMLDTDHandler.java
@@ -40,14 +40,14 @@ public interface XMLDTDHandler {
/**
* Conditional section: INCLUDE.
*
- * @see #CONDITIONAL_IGNORE
+ * @see XMLDTDHandler#CONDITIONAL_IGNORE
*/
public static final short CONDITIONAL_INCLUDE = 0;
/**
* Conditional section: IGNORE.
*
- * @see #CONDITIONAL_INCLUDE
+ * @see XMLDTDHandler#CONDITIONAL_INCLUDE
*/
public static final short CONDITIONAL_IGNORE = 1;
@@ -58,16 +58,13 @@ 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 augmentations Additional information that may include infoset
- * augmentations.
+ * @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
*
- * @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;
@@ -76,16 +73,14 @@ public interface XMLDTDHandler {
* This method notifies of the start of a parameter entity. The parameter
* entity name start with a '%' character.
*
- * @param name The name of the parameter entity.
- * @param identifier The resource identifier.
- * @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 parameter entities).
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param name the name of the parameter entity
+ * @param identifier the resource identifier
+ * @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 parameter entities).
+ * @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 startParameterEntity(String name,
XMLResourceIdentifier identifier,
@@ -99,12 +94,11 @@ public interface XMLDTDHandler {
* <strong>Note:</strong> This method is only called for external
* parameter entities referenced in the DTD.
*
- * @param version The XML version, or null if not specified.
- * @param encoding The IANA encoding name of the entity.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param version the XML version, or null if not specified
+ * @param encoding the IANA encoding name of the entity
+ * @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 textDecl(String version, String encoding,
Augmentations augmentations) throws XNIException;
@@ -113,11 +107,10 @@ public interface XMLDTDHandler {
* This method notifies the end of a parameter entity. Parameter entity
* names begin with a '%' character.
*
- * @param name The name of the parameter entity.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param name the name of the parameter entity
+ * @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 endParameterEntity(String name, Augmentations augmentations)
throws XNIException;
@@ -125,12 +118,9 @@ public interface XMLDTDHandler {
/**
* The start of the DTD external subset.
*
- * @param identifier The resource identifier.
- * @param augmentations
- * Additional information that may include infoset
- * augmentations.
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * @param identifier the resource identifier
+ * @param augmentations additional information that may include infoset
augmentations
+ * @throws XNIException thrown by handler to signal an error
*/
public void startExternalSubset(XMLResourceIdentifier identifier,
Augmentations augmentations)
@@ -139,10 +129,9 @@ public interface XMLDTDHandler {
/**
* The end of the DTD external subset.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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 endExternalSubset(Augmentations augmentations)
throws XNIException;
@@ -150,11 +139,10 @@ public interface XMLDTDHandler {
/**
* A comment.
*
- * @param text The text in the comment.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param text the text in the comment
+ * @param augmentations additional information that may include infoset
augmentations
*
- * @throws XNIException Thrown by application to signal an error.
+ * @throws XNIException thrown by application to signal an error
*/
public void comment(XMLString text, Augmentations augmentations)
throws XNIException;
@@ -170,12 +158,11 @@ public interface XMLDTDHandler {
* to the application as anything other than text. The application is
* responsible for parsing the data.
*
- * @param target The target.
- * @param data The data or null if none specified.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param target the target
+ * @param data the data or null if none specified
+ * @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 processingInstruction(String target, XMLString data,
Augmentations augmentations)
@@ -184,12 +171,11 @@ public interface XMLDTDHandler {
/**
* An element declaration.
*
- * @param name The name of the element.
- * @param contentModel The element content model.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param name the name of the element
+ * @param contentModel the element content model
+ * @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 elementDecl(String name, String contentModel,
Augmentations augmentations)
@@ -198,12 +184,10 @@ public interface XMLDTDHandler {
/**
* The start of an attribute list.
*
- * @param elementName The name of the element that this attribute
- * list is associated with.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param elementName the name of the element that this attribute list is
associated with
+ * @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 startAttlist(String elementName,
Augmentations augmentations) throws XNIException;
@@ -211,27 +195,21 @@ public interface XMLDTDHandler {
/**
* An attribute declaration.
*
- * @param elementName The name of the element that this attribute
- * is associated with.
- * @param attributeName The name of the attribute.
- * @param type The attribute type. This value will be one of
- * the following: "CDATA", "ENTITY", "ENTITIES",
- * "ENUMERATION", "ID", "IDREF", "IDREFS",
- * "NMTOKEN", "NMTOKENS", or "NOTATION".
- * @param enumeration If the type has the value "ENUMERATION" or
- * "NOTATION", this array holds the allowed attribute
- * values; otherwise, this array is null.
- * @param defaultType The attribute default type. This value will be
- * one of the following: "#FIXED", "#IMPLIED",
- * "#REQUIRED", or null.
- * @param defaultValue The attribute default value, or null if no
- * default value is specified.
- * @param nonNormalizedDefaultValue The attribute default value with no
normalization
- * performed, or null if no default value is
specified.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param elementName the name of the element that this attribute is
associated with
+ * @param attributeName the name of the attribute
+ * @param type the attribute type. This value will be one of the following:
+ * "CDATA", "ENTITY", "ENTITIES", "ENUMERATION", "ID",
"IDREF", "IDREFS",
+ * "NMTOKEN", "NMTOKENS", or "NOTATION"
+ * @param enumeration if the type has the value "ENUMERATION" or
"NOTATION", this array
+ * holds the allowed attribute values; otherwise, this
array is null
+ * @param defaultType the attribute default type. This value will be one
of the following:
+ * "#FIXED", "#IMPLIED", "#REQUIRED", or null
+ * @param defaultValue the attribute default value, or null if no default
value is specified
+ * @param nonNormalizedDefaultValue the attribute default value with no
normalization
+ * performed, or null if no default value
is specified
+ * @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 attributeDecl(String elementName, String attributeName,
String type, String[] enumeration,
@@ -242,28 +220,25 @@ public interface XMLDTDHandler {
/**
* The end of an attribute list.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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 endAttlist(Augmentations augmentations) throws XNIException;
/**
* An internal entity declaration.
*
- * @param name The name of the entity. Parameter entity names start with
- * '%', whereas the name of a general entity is just the
- * entity name.
- * @param text The value of the entity.
- * @param nonNormalizedText The non-normalized value of the entity. This
+ * @param name the name of the entity. Parameter entity names start with
'%', whereas
+ * the name of a general entity is just the entity name
+ * @param text the value of the entity
+ * @param nonNormalizedText the non-normalized value of the entity. This
* value contains the same sequence of characters that was in
* the internal entity declaration, without any entity
* references expanded.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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 internalEntityDecl(String name, XMLString text,
XMLString nonNormalizedText,
@@ -273,15 +248,13 @@ public interface XMLDTDHandler {
/**
* An external entity declaration.
*
- * @param name The name of the entity. Parameter entity names start
- * with '%', whereas the name of a general entity is just
- * the entity name.
- * @param identifier An object containing all location information
- * pertinent to this external entity.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param name the name of the entity. Parameter entity names start with
'%', whereas
+ * the name of a general entity is just the entity name
+ * @param identifier an object containing all location information
pertinent to this
+ * external entity
+ * @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 externalEntityDecl(String name,
XMLResourceIdentifier identifier,
@@ -291,14 +264,13 @@ public interface XMLDTDHandler {
/**
* An unparsed entity declaration.
*
- * @param name The name of the entity.
- * @param identifier An object containing all location information
- * pertinent to this unparsed entity declaration.
- * @param notation The name of the notation.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param name the name of the entity
+ * @param identifier an object containing all location information
pertinent to this
+ * unparsed entity declaration
+ * @param notation the name of the notation
+ * @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 unparsedEntityDecl(String name,
XMLResourceIdentifier identifier,
@@ -308,13 +280,11 @@ public interface XMLDTDHandler {
/**
* A notation declaration
*
- * @param name The name of the notation.
- * @param identifier An object containing all location information
- * pertinent to this notation.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param name the name of the notation
+ * @param identifier an object containing all location information
pertinent to this notation
+ * @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 notationDecl(String name, XMLResourceIdentifier identifier,
Augmentations augmentations) throws XNIException;
@@ -322,15 +292,14 @@ public interface XMLDTDHandler {
/**
* The start of a conditional section.
*
- * @param type The type of the conditional section. This value will
- * either be CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param type the type of the conditional section. This value will either
be
+ * CONDITIONAL_INCLUDE or CONDITIONAL_IGNORE
+ * @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
*
- * @see #CONDITIONAL_INCLUDE
- * @see #CONDITIONAL_IGNORE
+ * @see XMLDTDHandler#CONDITIONAL_INCLUDE
+ * @see XMLDTDHandler#CONDITIONAL_IGNORE
*/
public void startConditional(short type, Augmentations augmentations)
throws XNIException;
@@ -338,11 +307,10 @@ public interface XMLDTDHandler {
/**
* Characters within an IGNORE conditional section.
*
- * @param text The ignored text.
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @param text the ignored text
+ * @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 ignoredCharacters(XMLString text, Augmentations augmentations)
throws XNIException;
@@ -350,27 +318,33 @@ public interface XMLDTDHandler {
/**
* The end of a conditional section.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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 endConditional(Augmentations augmentations) throws
XNIException;
/**
* The end of the DTD.
*
- * @param augmentations Additional information that may include infoset
- * augmentations.
+ * @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 endDTD(Augmentations augmentations) throws XNIException;
- // set the source of this handler
+ /**
+ * Sets the source of this handler.
+ *
+ * @param source the source of this handler
+ */
public void setDTDSource(XMLDTDSource source);
- // return the source from which this handler derives its events
+ /**
+ * Returns the source from which this handler derives its events.
+ *
+ * @return the source from which this handler derives its events
+ */
public XMLDTDSource getDTDSource();
} // interface XMLDTDHandler
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
