You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xerces.apache.org by ra...@apache.org on 2002/01/23 16:31:22 UTC
cvs commit: xml-xerces/java/src/org/apache/xerces/parsers AbstractDOMParser.java AbstractXMLDocumentParser.java
rahuls 02/01/23 07:31:22
Modified: java/src/org/apache/xerces/impl XMLDTDScannerImpl.java
XMLNamespaceBinder.java
java/src/org/apache/xerces/impl/dtd XMLDTDValidator.java
java/src/org/apache/xerces/impl/xs XMLSchemaValidator.java
java/src/org/apache/xerces/parsers AbstractDOMParser.java
AbstractXMLDocumentParser.java
Log:
Cleaning Javadoc comments related to recent XNI changes.
Revision Changes Path
1.14 +19 -8 xml-xerces/java/src/org/apache/xerces/impl/XMLDTDScannerImpl.java
Index: XMLDTDScannerImpl.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/impl/XMLDTDScannerImpl.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- XMLDTDScannerImpl.java 22 Jan 2002 16:42:25 -0000 1.13
+++ XMLDTDScannerImpl.java 23 Jan 2002 15:31:21 -0000 1.14
@@ -104,7 +104,7 @@
* @author Glenn Marcy, IBM
* @author Eric Ye, IBM
*
- * @version $Id: XMLDTDScannerImpl.java,v 1.13 2002/01/22 16:42:25 neilg Exp $
+ * @version $Id: XMLDTDScannerImpl.java,v 1.14 2002/01/23 15:31:21 rahuls Exp $
*/
public class XMLDTDScannerImpl
extends XMLScanner
@@ -441,12 +441,19 @@
//
/**
- * startEntity
+ * This method notifies of the start of an entity. The DTD has the
+ * pseudo-name of "[dtd]" parameter entity names start with '%'; and
+ * general entities are just specified by their name.
*
- * @param name
- * @param publicId
- * @param systemId
- * @param encoding
+ * @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).
+ *
+ * @throws XNIException Thrown by handler to signal an error.
*/
public void startEntity(String name,
XMLResourceIdentifier identifier,
@@ -478,9 +485,13 @@
} // startEntity(String,XMLResourceIdentifier,String)
/**
- * endEntity
+ * This method notifies the end of an entity. The DTD has the pseudo-name
+ * of "[dtd]" parameter entity names start with '%'; and general entities
+ * are just specified by their name.
*
- * @param name
+ * @param name The name of the entity.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
*/
public void endEntity(String name)
throws XNIException {
1.13 +23 -20 xml-xerces/java/src/org/apache/xerces/impl/XMLNamespaceBinder.java
Index: XMLNamespaceBinder.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/impl/XMLNamespaceBinder.java,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- XMLNamespaceBinder.java 22 Jan 2002 16:42:26 -0000 1.12
+++ XMLNamespaceBinder.java 23 Jan 2002 15:31:21 -0000 1.13
@@ -95,7 +95,7 @@
*
* @author Andy Clark, IBM
*
- * @version $Id: XMLNamespaceBinder.java,v 1.12 2002/01/22 16:42:26 neilg Exp $
+ * @version $Id: XMLNamespaceBinder.java,v 1.13 2002/01/23 15:31:21 rahuls Exp $
*/
public class XMLNamespaceBinder
implements XMLComponent, XMLDocumentFilter {
@@ -375,27 +375,21 @@
//
/**
- * This method notifies the start of an entity. General entities are just
- * specified by their name.
+ * This method notifies the start of a general entity.
* <p>
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
- *
- * @param name The name of the entity.
- * @param publicId The public identifier of the entity if the entity
- * is external, null otherwise.
- * @param systemId The system identifier of the entity if the entity
- * is external, null otherwise.
- * @param baseSystemId The base system identifier of the entity if
- * the entity is external, null otherwise.
+ *
+ * @param 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 Thrown by handler to signal an error.
+ *
+ * @exception XNIException Thrown by handler to signal an error.
*/
public void startGeneralEntity(String name,
XMLResourceIdentifier identifier,
@@ -433,6 +427,15 @@
/**
* 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 augs Additional information that may include infoset augmentations
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void startDocument(XMLLocator locator, String encoding, Augmentations augs)
@@ -703,16 +706,16 @@
} // endDocument()
/**
- * This method notifies the end of an entity. General entities are just
- * specified by their name.
+ * This method notifies the end of a general entity.
* <p>
* <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
- *
- * @throws 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.
*/
public void endGeneralEntity(String name, Augmentations augs) throws XNIException {
if (fDocumentHandler != null && !fOnlyPassPrefixMappingEvents) {
1.11 +232 -41 xml-xerces/java/src/org/apache/xerces/impl/dtd/XMLDTDValidator.java
Index: XMLDTDValidator.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/impl/dtd/XMLDTDValidator.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- XMLDTDValidator.java 22 Jan 2002 16:42:26 -0000 1.10
+++ XMLDTDValidator.java 23 Jan 2002 15:31:22 -0000 1.11
@@ -124,7 +124,7 @@
* @author Andy Clark, IBM
* @author Jeffrey Rodriguez IBM
*
- * @version $Id: XMLDTDValidator.java,v 1.10 2002/01/22 16:42:26 neilg Exp $
+ * @version $Id: XMLDTDValidator.java,v 1.11 2002/01/23 15:31:22 rahuls Exp $
*/
public class XMLDTDValidator
implements XMLComponent,
@@ -679,7 +679,7 @@
/**
* The start of the document.
*
- * @param systemId The system identifier of the entity if the entity
+ * @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
@@ -687,6 +687,7 @@
* 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 Thrown by handler to signal an error.
*/
public void startDocument(XMLLocator locator, String encoding, Augmentations augs)
@@ -759,6 +760,7 @@
* @param prefix The namespace prefix.
* @param uri The URI bound to the prefix.
* @param augs Additional information that may include infoset augmentations
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void startPrefixMapping(String prefix, String uri, Augmentations augs)
@@ -821,6 +823,7 @@
* @param text The content.
*
* @param augs Additional information that may include infoset augmentations
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void characters(XMLString text, Augmentations augs) throws XNIException {
@@ -885,8 +888,8 @@
* content model.
*
* @param text The ignorable whitespace.
- *
* @param augs Additional information that may include infoset augmentations
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void ignorableWhitespace(XMLString text, Augmentations augs) throws XNIException {
@@ -984,17 +987,47 @@
// XMLDocumentHandler and XMLDTDHandler methods
//
- /** Start external subset. */
+ /**
+ * The start of the DTD external subset.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void startExternalSubset(Augmentations augs) throws XNIException {
fDTDGrammar.startExternalSubset(augs);
}
- /** End external subset. */
+ /**
+ * The end of the DTD external subset.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void endExternalSubset(Augmentations augs) throws XNIException {
fDTDGrammar.startExternalSubset(augs);
}
- /** Start general entity. */
+ /**
+ * This method notifies the start of a general entity.
+ * <p>
+ * <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
+ *
+ * @exception XNIException Thrown by handler to signal an error.
+ */
public void startGeneralEntity(String name,
XMLResourceIdentifier identifier,
String encoding,
@@ -1005,7 +1038,13 @@
}
}
- /** Check standalone entity reference. */
+ /**
+ * Check standalone entity reference.
+ *
+ * @param name
+ *
+ * @throws XNIException Thrown by application to signal an error.
+ */
protected void checkStandaloneEntityRef(String name) throws XNIException {
// check VC: Standalone Document Declartion, entities references appear in the document.
if (fPerformValidation && fDTDGrammar != null) {
@@ -1027,8 +1066,8 @@
* A comment.
*
* @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.
*/
public void comment(XMLString text, Augmentations augs) throws XNIException {
@@ -1084,7 +1123,18 @@
} // processingInstruction(String,XMLString)
- /** End general entity. */
+ /**
+ * This method notifies the end of a general entity.
+ * <p>
+ * <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.
+ */
public void endGeneralEntity(String name, Augmentations augs) throws XNIException {
// call handlers
if (fDocumentHandler != null) {
@@ -1099,6 +1149,15 @@
/**
* 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.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void startDTD(XMLLocator locator, Augmentations augs) throws XNIException {
@@ -1124,9 +1183,11 @@
} // startDTD(XMLLocator)
/**
- * Character content.
- *
- * @param text The content.
+ * Characters within an IGNORE conditional section.
+ *
+ * @param text The ignored text.
+ * @param augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -1140,13 +1201,15 @@
/**
* Notifies of the presence of a TextDecl line in an entity. If present,
- * this method will be called immediately following the startEntity call.
+ * this method will be called immediately following the startParameterEntity call.
* <p>
* <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 augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -1167,20 +1230,17 @@
}
/**
- * This method notifies of the start of an entity. The DTD has the
- * pseudo-name of "[dtd]" and parameter entity names start with '%'.
+ * This method notifies of the start of a parameter entity. The parameter
+ * entity name start with a '%' character.
*
- * @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 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.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -1196,11 +1256,14 @@
fDTDHandler.startParameterEntity(name, identifier, encoding, augs);
}
}
+
/**
- * This method notifies the end of an entity. The DTD has the pseudo-name
- * of "[dtd]" and parameter entity names start with '%'.
+ * This method notifies the end of a parameter entity. Parameter entity
+ * names begin with a '%' character.
*
- * @param name The name of the entity.
+ * @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.
*/
@@ -1218,6 +1281,8 @@
*
* @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.
*/
@@ -1250,6 +1315,8 @@
*
* @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.
*/
@@ -1274,14 +1341,16 @@
* the following: "CDATA", "ENTITY", "ENTITIES",
* "ENUMERATION", "ID", "IDREF", "IDREFS",
* "NMTOKEN", "NMTOKENS", or "NOTATION".
- * @param enumeration If the type has the value "ENUMERATION", this
- * array holds the allowed attribute values;
- * otherwise, this array is null.
+ * @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 augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -1434,6 +1503,9 @@
/**
* The end of an attribute list.
*
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endAttlist(Augmentations augs) throws XNIException {
@@ -1457,6 +1529,8 @@
* 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.
*/
@@ -1472,6 +1546,7 @@
} // internalEntityDecl(String,XMLString,XMLString)
+
/**
* An external entity declaration.
*
@@ -1481,8 +1556,10 @@
* @param publicId The public identifier of the entity or null if the
* the entity was specified with SYSTEM.
* @param systemId The system identifier of the entity.
- * @param baseSystemId The base system identifier of where the entity
+ * @param baseSystemId The base system identifier where this entity
* is declared.
+ * @param augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -1509,6 +1586,8 @@
* @param systemId The system identifier of the entity, or null if not
* specified.
* @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.
*/
@@ -1538,6 +1617,8 @@
* specified.
* @param systemId The system identifier of the notation, or null if not
* specified.
+ * @param augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -1557,11 +1638,13 @@
*
* @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.
*
- * @see XMLDTDHandler#CONDITIONAL_INCLUDE
- * @see XMLDTDHandler#CONDITIONAL_IGNORE
+ * @see #CONDITIONAL_INCLUDE
+ * @see #CONDITIONAL_IGNORE
*/
public void startConditional(short type, Augmentations augs) throws XNIException {
@@ -1579,6 +1662,9 @@
/**
* The end of a conditional section.
*
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endConditional(Augmentations augs) throws XNIException {
@@ -1597,6 +1683,9 @@
/**
* The end of the DTD.
*
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endDTD(Augmentations augs) throws XNIException {
@@ -1654,7 +1743,17 @@
// XMLDTDContentModelHandler methods
//
- /** Start content model. */
+ /**
+ * 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.
+ */
public void startContentModel(String elementName, Augmentations augs)
throws XNIException {
@@ -1671,7 +1770,17 @@
} // startContentModel(String)
- /** ANY. */
+ /**
+ * A content model of ANY.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #empty
+ * @see #startGroup
+ */
public void any(Augmentations augs) throws XNIException {
fDTDGrammar.any(augs);
if (fDTDContentModelHandler != null) {
@@ -1679,7 +1788,17 @@
}
} // any()
- /** EMPTY. */
+ /**
+ * A content model of EMPTY.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #any
+ * @see #startGroup
+ */
public void empty(Augmentations augs) throws XNIException {
fDTDGrammar.empty(augs);
if (fDTDContentModelHandler != null) {
@@ -1687,7 +1806,20 @@
}
} // empty()
- /** Start group. */
+ /**
+ * 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.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #any
+ * @see #empty
+ */
public void startGroup(Augmentations augs) throws XNIException {
fMixed = false;
@@ -1699,7 +1831,18 @@
} // startGroup()
- /** #PCDATA. */
+ /**
+ * 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>.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #startGroup
+ */
public void pcdata(Augmentations augs) {
fMixed = true;
fDTDGrammar.pcdata(augs);
@@ -1708,7 +1851,15 @@
}
} // pcdata()
- /** Element. */
+ /**
+ * 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
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void element(String elementName, Augmentations augs) throws XNIException {
// check VC: No duplicate Types, in a single mixed-content declaration
@@ -1732,7 +1883,19 @@
} // childrenElement(String)
- /** Separator. */
+ /**
+ * The separator between choices or sequences of a mixed or children
+ * content model.
+ *
+ * @param separator The type of children separator.
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #SEPARATOR_CHOICE
+ * @see #SEPARATOR_SEQUENCE
+ */
public void separator(short separator, Augmentations augs)
throws XNIException {
@@ -1744,7 +1907,21 @@
} // separator(short)
- /** Occurrence. */
+ /**
+ * The occurrence count for a child in a children content model or
+ * for the mixed content model group.
+ *
+ * @param occurrence The occurrence count for the last element
+ * or group.
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #OCCURS_ZERO_OR_ONE
+ * @see #OCCURS_ZERO_OR_MORE
+ * @see #OCCURS_ONE_OR_MORE
+ */
public void occurrence(short occurrence, Augmentations augs)
throws XNIException {
@@ -1756,7 +1933,14 @@
} // occurrence(short)
- /** End group. */
+ /**
+ * The end of a group for mixed or children content models.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void endGroup(Augmentations augs) throws XNIException {
// call handlers
@@ -1767,7 +1951,14 @@
} // endGroup()
- /** End content model. */
+ /**
+ * The end of a content model.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void endContentModel(Augmentations augs) throws XNIException {
// call handlers
1.36 +37 -23 xml-xerces/java/src/org/apache/xerces/impl/xs/XMLSchemaValidator.java
Index: XMLSchemaValidator.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/impl/xs/XMLSchemaValidator.java,v
retrieving revision 1.35
retrieving revision 1.36
diff -u -r1.35 -r1.36
--- XMLSchemaValidator.java 22 Jan 2002 23:37:26 -0000 1.35
+++ XMLSchemaValidator.java 23 Jan 2002 15:31:22 -0000 1.36
@@ -128,7 +128,7 @@
* @author Elena Litani IBM
* @author Andy Clark IBM
* @author Neeraj Bajaj, Sun Microsystems, inc.
- * @version $Id: XMLSchemaValidator.java,v 1.35 2002/01/22 23:37:26 sandygao Exp $
+ * @version $Id: XMLSchemaValidator.java,v 1.36 2002/01/23 15:31:22 rahuls Exp $
*/
public class XMLSchemaValidator
implements XMLComponent, XMLDocumentFilter, FieldActivator {
@@ -415,13 +415,14 @@
/**
* The start of the document.
*
- * @param systemId The system identifier of the entity if the entity
+ * @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 augs Additional information that may include infoset augmentations
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -445,6 +446,7 @@
* @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.
*/
@@ -466,6 +468,7 @@
* 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.
*/
@@ -486,6 +489,7 @@
*
* @param prefix The namespace prefix.
* @param uri The URI bound to the prefix.
+ * @param augs Additional information that may include infoset augmentations
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -505,6 +509,7 @@
*
* @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.
*/
@@ -524,6 +529,7 @@
*
* @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.
*/
@@ -557,6 +563,7 @@
* Character content.
*
* @param text The content.
+ * @param augs Additional information that may include infoset augmentations
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -579,6 +586,7 @@
* content model.
*
* @param text The ignorable whitespace.
+ * @param augs Additional information that may include infoset augmentations
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -596,6 +604,7 @@
* The end of an element.
*
* @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.
*/
@@ -619,6 +628,7 @@
* called when namespace processing is enabled.
*
* @param prefix The namespace prefix.
+ * @param augs Additional information that may include infoset augmentations
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -634,6 +644,8 @@
/**
* The start of a CDATA section.
*
+ * @param augs Additional information that may include infoset augmentations
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void startCDATA(Augmentations augs) throws XNIException {
@@ -648,6 +660,8 @@
/**
* The end of a CDATA section.
*
+ * @param augs Additional information that may include infoset augmentations
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endCDATA(Augmentations augs) throws XNIException {
@@ -662,6 +676,8 @@
/**
* The end of the document.
*
+ * @param augs Additional information that may include infoset augmentations
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endDocument(Augmentations augs) throws XNIException {
@@ -679,26 +695,21 @@
//
/**
- * This method notifies of the start of an entity. The DTD has the
- * pseudo-name of "[dtd]" parameter entity names start with '%'; and
- * general entity names are just the entity name.
+ * This method notifies the start of a general entity.
* <p>
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
- *
- * @param name The name of the entity.
- * @param publicId The public identifier of the entity if the entity
- * is external, null otherwise.
- * @param systemId The system identifier of the entity if the entity
- * is external, null otherwise.
- * @param baseSystemId The base system identifier of the entity if
- * the entity is external, null otherwise.
+ *
+ * @param 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 parameter entities).
- *
- * @throws XNIException Thrown by handler to signal an error.
+ * internal entities or a document entity that is
+ * parsed from a java.io.Reader).
+ * @param augs Additional information that may include infoset augmentations
+ *
+ * @exception XNIException Thrown by handler to signal an error.
*/
public void startGeneralEntity(String name,
XMLResourceIdentifier identifier,
@@ -725,6 +736,7 @@
*
* @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.
*/
@@ -741,6 +753,7 @@
* A comment.
*
* @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.
*/
@@ -769,6 +782,7 @@
*
* @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.
*/
@@ -786,16 +800,16 @@
} // processingInstruction(String,XMLString)
/**
- * This method notifies the end of an entity. The DTD has the pseudo-name
- * of "[dtd]" parameter entity names start with '%'; and general entity
- * names are just the entity name.
+ * This method notifies the end of a general entity.
* <p>
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
- *
- * @param name The name of the entity.
- *
- * @throws 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.
*/
public void endGeneralEntity(String name, Augmentations augs) throws XNIException {
1.28 +60 -24 xml-xerces/java/src/org/apache/xerces/parsers/AbstractDOMParser.java
Index: AbstractDOMParser.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/parsers/AbstractDOMParser.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- AbstractDOMParser.java 22 Jan 2002 16:42:27 -0000 1.27
+++ AbstractDOMParser.java 23 Jan 2002 15:31:22 -0000 1.28
@@ -103,7 +103,7 @@
* @author Andy Clark, IBM
* @author Elena Litani, IBM
*
- * @version $Id: AbstractDOMParser.java,v 1.27 2002/01/22 16:42:27 neilg Exp $
+ * @version $Id: AbstractDOMParser.java,v 1.28 2002/01/23 15:31:22 rahuls Exp $
*/
public abstract class AbstractDOMParser
extends AbstractXMLDocumentParser {
@@ -371,24 +371,21 @@
//
/**
- * This method notifies of the start of an entity. The DTD has the
- * pseudo-name of "[dtd]" parameter entity names start with '%'; and
- * general entity names are just the entity name.
+ * This method notifies the start of a general entity.
* <p>
* <strong>Note:</strong> This method is not called for entity references
* appearing as part of attribute values.
- *
- * @param name The name of the entity.
- * @param publicId The public identifier of the entity if the entity
- * is external, null otherwise.
- * @param systemId The system identifier of the entity if the entity
- * is external, null otherwise.
+ *
+ * @param 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 parameter entities).
- *
- * @throws XNIException Thrown by handler to signal an error.
+ * internal entities or a document entity that is
+ * parsed from a java.io.Reader).
+ * @param augs Additional information that may include infoset augmentations
+ *
+ * @exception XNIException Thrown by handler to signal an error.
*/
public void startGeneralEntity(String name,
XMLResourceIdentifier identifier,
@@ -478,6 +475,7 @@
* A comment.
*
* @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.
*/
@@ -511,6 +509,7 @@
*
* @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.
*/
@@ -533,7 +532,7 @@
/**
* The start of the document.
*
- * @param systemId The system identifier of the entity if the entity
+ * @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
@@ -941,17 +940,16 @@
} // endDocument()
/**
- * This method notifies the end of an entity. The DTD has the pseudo-name
- * of "[dtd]" parameter entity names start with '%'; and general entity
- * names are just the entity name.
+ * This method notifies the end of a general entity.
* <p>
* <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
- *
- * @throws 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.
*/
public void endGeneralEntity(String name, Augmentations augs) throws XNIException {
@@ -1017,6 +1015,15 @@
/**
* 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.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void startDTD(XMLLocator locator, Augmentations augs) throws XNIException {
@@ -1029,6 +1036,9 @@
/**
* The end of the DTD.
*
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endDTD(Augmentations augs) throws XNIException {
@@ -1047,12 +1057,26 @@
}
} // endDTD()
- /** Start external subset. */
+ /**
+ * The start of the DTD external subset.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void startExternalSubset(Augmentations augs) throws XNIException {
fInDTDExternalSubset = true;
} // startExternalSubset(Augmentations)
- /** End external subset. */
+ /**
+ * The end of the DTD external subset.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void endExternalSubset(Augmentations augs) throws XNIException {
fInDTDExternalSubset = false;
} // endExternalSubset(Augmentations)
@@ -1068,6 +1092,8 @@
* 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.
*/
@@ -1146,6 +1172,8 @@
* @param systemId The system identifier of the entity.
* @param baseSystemId The base system identifier where this entity
* is declared.
+ * @param augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -1229,6 +1257,8 @@
* @param systemId The system identifier of the entity, or null if not
* specified.
* @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.
*/
@@ -1308,6 +1338,8 @@
* specified.
* @param systemId The system identifier of the notation, or null if not
* specified.
+ * @param augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -1376,6 +1408,8 @@
*
* @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.
*/
@@ -1411,6 +1445,8 @@
* "#REQUIRED", or null.
* @param defaultValue The attribute default value, 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.
*/
1.7 +160 -24 xml-xerces/java/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java
Index: AbstractXMLDocumentParser.java
===================================================================
RCS file: /home/cvs/xml-xerces/java/src/org/apache/xerces/parsers/AbstractXMLDocumentParser.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- AbstractXMLDocumentParser.java 22 Jan 2002 16:42:27 -0000 1.6
+++ AbstractXMLDocumentParser.java 23 Jan 2002 15:31:22 -0000 1.7
@@ -85,7 +85,7 @@
* @author Arnaud Le Hors, IBM
* @author Andy Clark, IBM
*
- * @version $Id: AbstractXMLDocumentParser.java,v 1.6 2002/01/22 16:42:27 neilg Exp $
+ * @version $Id: AbstractXMLDocumentParser.java,v 1.7 2002/01/23 15:31:22 rahuls Exp $
*/
public abstract class AbstractXMLDocumentParser
extends XMLParser
@@ -125,7 +125,7 @@
/**
* The start of the document.
*
- * @param systemId The system identifier of the entity if the entity
+ * @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
@@ -399,6 +399,15 @@
/**
* 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.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void startDTD(XMLLocator locator, Augmentations augs) throws XNIException {
@@ -470,13 +479,13 @@
} // endParameterEntity(String,Augmentations)
/**
- * Character content.
- *
- * @param text The content.
- * @param augs Additional information that may include infoset augmentations
- *
- * @exception XNIException
- * Thrown by handler to signal an error.
+ * Characters within an IGNORE conditional section.
+ *
+ * @param text The ignored text.
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
*/
public void ignoredCharacters(XMLString text, Augmentations augs) throws XNIException {}
@@ -485,6 +494,8 @@
*
* @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.
*/
@@ -497,6 +508,8 @@
*
* @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.
*/
@@ -513,14 +526,16 @@
* the following: "CDATA", "ENTITY", "ENTITIES",
* "ENUMERATION", "ID", "IDREF", "IDREFS",
* "NMTOKEN", "NMTOKENS", or "NOTATION".
- * @param enumeration If the type has the value "ENUMERATION", this
- * array holds the allowed attribute values;
- * otherwise, this array is null.
+ * @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 augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -533,6 +548,9 @@
/**
* The end of an attribute list.
*
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endAttlist(Augmentations augs) throws XNIException {
@@ -549,6 +567,8 @@
* 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.
*/
@@ -568,6 +588,8 @@
* @param systemId The system identifier of the entity.
* @param baseSystemId The base system identifier where this entity
* is declared.
+ * @param augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -585,6 +607,8 @@
* @param systemId The system identifier of the entity, or null if not
* specified.
* @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.
*/
@@ -601,6 +625,8 @@
* specified.
* @param systemId The system identifier of the notation, or null if not
* specified.
+ * @param augs Additional information that may include infoset
+ * augmentations.
*
* @throws XNIException Thrown by handler to signal an error.
*/
@@ -613,11 +639,13 @@
*
* @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.
*
- * @see XMLDTDHandler#CONDITIONAL_INCLUDE
- * @see XMLDTDHandler#CONDITIONAL_IGNORE
+ * @see #CONDITIONAL_INCLUDE
+ * @see #CONDITIONAL_IGNORE
*/
public void startConditional(short type, Augmentations augs) throws XNIException {
} // startConditional(short)
@@ -625,6 +653,9 @@
/**
* The end of a conditional section.
*
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endConditional(Augmentations augs) throws XNIException {
@@ -633,6 +664,9 @@
/**
* The end of the DTD.
*
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
* @throws XNIException Thrown by handler to signal an error.
*/
public void endDTD(Augmentations augs) throws XNIException {
@@ -643,34 +677,136 @@
// XMLDTDContentModelHandler methods
//
- /** Start content model. */
+ /**
+ * 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.
+ */
public void startContentModel(String elementName, Augmentations augs) throws XNIException {}
- /** ANY. */
+ /**
+ * A content model of ANY.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #empty
+ * @see #startGroup
+ */
public void any(Augmentations augs) throws XNIException {}
- /** EMPTY. */
+ /**
+ * A content model of EMPTY.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #any
+ * @see #startGroup
+ */
public void empty(Augmentations augs) throws XNIException {}
- /** Start group. */
+ /**
+ * 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.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #any
+ * @see #empty
+ */
public void startGroup(Augmentations augs) throws XNIException {}
- /** #PCDATA. */
+ /**
+ * 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>.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #startGroup
+ */
public void pcdata(Augmentations augs) throws XNIException {}
- /** Element. */
+ /**
+ * 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
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void element(String elementName, Augmentations augs) throws XNIException {}
- /** Separator. */
+ /**
+ * The separator between choices or sequences of a mixed or children
+ * content model.
+ *
+ * @param separator The type of children separator.
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #SEPARATOR_CHOICE
+ * @see #SEPARATOR_SEQUENCE
+ */
public void separator(short separator, Augmentations augs) throws XNIException {}
- /** Occurrence. */
+ /**
+ * The occurrence count for a child in a children content model or
+ * for the mixed content model group.
+ *
+ * @param occurrence The occurrence count for the last element
+ * or group.
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ *
+ * @see #OCCURS_ZERO_OR_ONE
+ * @see #OCCURS_ZERO_OR_MORE
+ * @see #OCCURS_ONE_OR_MORE
+ */
public void occurrence(short occurrence, Augmentations augs) throws XNIException {}
- /** End group. */
+ /**
+ * The end of a group for mixed or children content models.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void endGroup(Augmentations augs) throws XNIException {}
- /** End content model. */
+ /**
+ * The end of a content model.
+ *
+ * @param augs Additional information that may include infoset
+ * augmentations.
+ *
+ * @throws XNIException Thrown by handler to signal an error.
+ */
public void endContentModel(Augmentations augs) throws XNIException {}
//
---------------------------------------------------------------------
To unsubscribe, e-mail: xerces-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: xerces-cvs-help@xml.apache.org