mbeckerle commented on code in PR #1572:
URL: https://github.com/apache/daffodil/pull/1572#discussion_r2429382199
##########
daffodil-core/src/main/java/org/apache/daffodil/api/package-info.java:
##########
@@ -250,41 +250,43 @@
* data ought to be written to. Any XMLReader implementation is permissible,
as long as they have
* XML Namespace support.
*
- * <pre>
- * {@code
- * ByteArrayInputStream is = new ByteArrayInputStream(data);
- * ByteArrayOutputStream os = new ByteArrayOutputStream();
- * WritableByteChannel wbc = java.nio.channels.Channels.newChannel(os);
- * DaffodilUnparseContentHandler unparseContentHandler =
dp.newContentHandlerInstance(wbc);
- * try {
- * XMLReader xmlReader =
SAXParserFactory.newInstance().newSAXParser().getXMLReader();
- * xmlReader.setContentHandler(unparseContentHandler)
- * xmlReader.parse(is)
- * } catch (ParserConfigurationException | SAXException e) {
- * ...
- * } catch (DaffodilUnparseErrorSAXException | DaffodilUnhandledSAXException
e) {
- * ...
- * }
- * }
- * </pre>
- *
* The call to the XMLReader.parse method must be wrapped in a try/catch, as
* {@link org.apache.daffodil.api.DaffodilUnparseContentHandler} relies on
throwing an exception to
* end processing in the case of any errors/failures.
* There are two kinds of errors to expect
* {@link
org.apache.daffodil.api.exceptions.DaffodilUnparseErrorSAXException}, for the
case when the
* {@link org.apache.daffodil.api.UnparseResult#isError()} is true, and
- * {@link org.apache.daffodil.api.exceptions.DaffodilUnhandledSAXException},
for any other errors.
+ * {@link org.apache.daffodil.api.exceptions.DaffodilUnhandledSAXException},
for any other errors,
+ * which generally indicate a bug in Daffodil
*
- * In the case of an {@link
org.apache.daffodil.api.exceptions.DaffodilUnhandledSAXException},
+ * In the case of a {@link
org.apache.daffodil.api.exceptions.DaffodilUnhandledSAXException},
* {@link
org.apache.daffodil.api.DaffodilUnparseContentHandler#getUnparseResult()} will
return null.
*
+ * After the XMLReader parse has completed, either successfully or via a
thrown exception, the
+ * {@link org.apache.daffodil.api.DaffodilUnparseContentHandler#finish()}
method should be called--this
+ * allows content handler state to be cleaned up and ensures the
+ * {@link
org.apache.daffodil.api.DaffodilUnparseContentHandler#getUnparseResult()}
returns an
+ * {@link org.apache.daffodil.api.UnparseResult} even in cases where the
XMLReader runs into an error.
+ *
* <pre>
* {@code
+ * InputSource input = ...
+ * OutputStream output = ...
+ * WritableByteChannel wbc = Channels.newChannel(output);
+ * DaffodilUnparseContentHandler unparseContentHandler =
dp.newContentHandlerInstance(wbc);
+ *
+ * XMLReader xmlReader = ...
+ * xmlReader.setContentHandler(unparseContentHandler)
* try {
- * xmlReader.parse(new InputSource(is));
- * } catch (DaffodilUnparseErrorSAXException | DaffodilUnhandledSAXException
e) {
+ * xmlReader.parse(input);
+ * } catch (DaffodilUnparseErrorSAXException e)
+ * // generally can be ignored, use getUnparseResult() instead
+ * } catch (DaffodilUnhandledSAXException e) {
+ * // should never happen, indicates a bug in daffodil
Review Comment:
Explain why you are bothering to illustrate a catch for it then. Shouldn't
it just be allowed to propagate if it is a daffodil bug? If so, then why catch
it at all?
##########
daffodil-core/src/main/scala/org/apache/daffodil/runtime1/infoset/SAXInfosetInputter.scala:
##########
@@ -126,9 +126,14 @@ class SAXInfosetInputter(
}
override def hasNext(): Boolean = {
- // If we haven't reached an EndDocument event yet, there must be more
- // events on their way, even if we don't know for sure yet.
- currentEvent.eventType.get ne EndDocument
+ // If we haven't reached an EndDocument event yet, there must be more
events on their way,
Review Comment:
Is there an issue with an XML Comment that appears after the end document
element? The XML Spec says after the end of the root element you can have
whitespace, processing-instructions, or comments. Or are we disregarding those
elsewhere? I can imagine if an XML infoset was crafted by hand as a test case
that the author might want to put comments at the end.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
