blob: eca0972aa1d7b9d0f08d384f84651633c4486af8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>org.apache.daffodil.japi.infoset (Apache Daffodil 3.6.0 Java API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="org.apache.daffodil.japi.infoset (Apache Daffodil 3.6.0 Java API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/daffodil/japi/debugger/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/daffodil/japi/io/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/daffodil/japi/infoset/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.daffodil.japi.infoset</h1>
<div class="docSummary">
<div class="block">Defines various classes used control the representation of the infoset for
parse and unparse.</div>
</div>
<p>See:&nbsp;<a href="#package.description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html" title="class in org.apache.daffodil.japi.infoset">InfosetInputter</a></td>
<td class="colLast">
<div class="block">Abstract class used to determine how the infoset representation should be
input from a call to DataProcessor#unparse.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputterProxy.html" title="class in org.apache.daffodil.japi.infoset">InfosetInputterProxy</a></td>
<td class="colLast">
<div class="block">A proxy for InfosetInputters that are internal to Daffodil</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset">InfosetOutputter</a></td>
<td class="colLast">
<div class="block">Abstract class used to determine how the infoset representation should be
output from a call to DataProcessor#parse.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputterProxy.html" title="class in org.apache.daffodil.japi.infoset">InfosetOutputterProxy</a></td>
<td class="colLast">
<div class="block">A proxy for InfosetOutputters that are internal to Daffodil</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/JDOMInfosetInputter.html" title="class in org.apache.daffodil.japi.infoset">JDOMInfosetInputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetInputter</code></a> to read an infoset represented as an org.jdom2.Document</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/JDOMInfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset">JDOMInfosetOutputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetOutputter</code></a> to build an infoset represented as an org.jdom2.Document</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/JsonInfosetInputter.html" title="class in org.apache.daffodil.japi.infoset">JsonInfosetInputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetInputter</code></a> to read an infoset represented as JSON from a java.io.InputStream</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/JsonInfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset">JsonInfosetOutputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetOutputter</code></a> to build an infoset represented as JSON written to a java.io.OutputStream</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/NullInfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset">NullInfosetOutputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetOutputter</code></a> that does not build an infoset represention, ignoring
all <a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetOutputter</code></a> events</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/ScalaXMLInfosetInputter.html" title="class in org.apache.daffodil.japi.infoset">ScalaXMLInfosetInputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetInputter</code></a> to read an infoset represented as a scala.xml.Node</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/ScalaXMLInfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset">ScalaXMLInfosetOutputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetOutputter</code></a> to build an infoset represented as a scala.xml.Node</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/W3CDOMInfosetInputter.html" title="class in org.apache.daffodil.japi.infoset">W3CDOMInfosetInputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetInputter</code></a> to read an infoset represented as an org.w3c.dom.Document</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/W3CDOMInfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset">W3CDOMInfosetOutputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetOutputter</code></a> to build an infoset represented as an org.w3c.dom.Document</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/XMLTextInfosetInputter.html" title="class in org.apache.daffodil.japi.infoset">XMLTextInfosetInputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetInputter</code></a> to read an infoset represented as XML from a java.io.InputStream</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/XMLTextInfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset">XMLTextInfosetOutputter</a></td>
<td class="colLast">
<div class="block"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetOutputter</code></a> to build an infoset represented as XML written to a java.io.OutputStream</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Enum</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../../org/apache/daffodil/japi/infoset/XMLTextEscapeStyle.html" title="enum in org.apache.daffodil.japi.infoset">XMLTextEscapeStyle</a></td>
<td class="colLast">
<div class="block">XMLTextEscapeStyles for determining whether to wrap info in CDATA tags</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package.description">
<!-- -->
</a>
<h2 title="Package org.apache.daffodil.japi.infoset Description">Package org.apache.daffodil.japi.infoset Description</h2>
<div class="block">Defines various classes used control the representation of the infoset for
parse and unparse. Classes that extend <a href="../../../../../org/apache/daffodil/japi/infoset/InfosetOutputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetOutputter</code></a> are provided to
the <a href="../../../../../org/apache/daffodil/japi/DataProcessor.html#parse-org.apache.daffodil.japi.io.InputSourceDataInputStream-org.apache.daffodil.japi.infoset.InfosetOutputter-"><code>DataProcessor.parse(org.apache.daffodil.japi.io.InputSourceDataInputStream, org.apache.daffodil.japi.infoset.InfosetOutputter)</code></a> method to deteremine how to output an infoset.
These classes are not guaranteed to be thread-safe. Classes that extend
<a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html" title="class in org.apache.daffodil.japi.infoset"><code>InfosetInputter</code></a> are provided to the <a href="../../../../../org/apache/daffodil/japi/DataProcessor.html#unparse-org.apache.daffodil.japi.infoset.InfosetInputter-java.nio.channels.WritableByteChannel-"><code>DataProcessor.unparse(org.apache.daffodil.japi.infoset.InfosetInputter, java.nio.channels.WritableByteChannel)</code></a> method to
determine how to read in an infoset. A new InfosetOutputter is required for
each call to unparse().</div>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/daffodil/japi/debugger/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../../org/apache/daffodil/japi/io/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/daffodil/japi/infoset/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>