https://beanio.github.io/api/index.html

1<!DOCTYPE HTML>
2<!-- NewPage -->
3<html lang="en">
4<head>
5<!-- Generated by javadoc -->
6<title>Overview (beanio 3.2.0 API)</title>
7<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
8<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
9<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
10<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">

11<script type="text/javascript" src="script.js"></script>

11

12<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>

12

13<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>

13
14<!--[if IE]>

15<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>

15
16<![endif]-->

17<script type="text/javascript" src="jquery/jquery-3.7.1.min.js"></script>

17

18<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>

18
19</head>
20<body>

21<script type="text/javascript"><!--
22    try {
23        if (location.href.indexOf('is-external=true') == -1) {
24            parent.document.title="Overview (beanio 3.2.0 API)";
25        }
26    }
27    catch(err) {
28    }
29//-->
30var pathtoroot = "./";
31var useModuleDirectories = true;
32loadScripts(document, 'script');</script>

32
33<noscript>
34<div>JavaScript is disabled on your browser.</div>
35</noscript>
36<header role="banner">
37<nav role="navigation">
38<div class="fixedNav">
39<!-- ========= START OF TOP NAVBAR ======= -->
40<div class="topNav"><a id="navbar.top">
41<!--   -->
42</a>
43<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
44<a id="navbar.top.firstrow">
45<!--   -->
46</a>
47<ul class="navList" title="Navigation">
48<li class="navBarCell1Rev">Overview</li>
49<li>Package</li>
50<li>Class</li>
51<li><a href="overview-tree.html">Tree</a></li>
52<li><a href="deprecated-list.html">Deprecated</a></li>
53<li><a href="index-all.html">Index</a></li>
54<li><a href="help-doc.html">Help</a></li>
55</ul>
56<div class="aboutLanguage">BeanIO 3.2.0</div>
57</div>
58<div class="subNav">
59<ul class="navList" id="allclasses_navbar_top">
60<li><a href="allclasses.html">All&nbsp;Classes</a></li>
61</ul>
62<ul class="navListSearch">
63<li><label for="search">SEARCH:</label>
64<input type="text" id="search" value="search" disabled="disabled">
65<input type="reset" id="reset" value="reset" disabled="disabled">
66</li>
67</ul>
68<div>

69<script type="text/javascript"><!--
70  allClassesLink = document.getElementById("allclasses_navbar_top");
71  if(window==top) {
72    allClassesLink.style.display = "block";
73  }
74  else {
75    allClassesLink.style.display = "none";
76  }
77  //-->
78</script>

78
79<noscript>
80<div>JavaScript is disabled on your browser.</div>
81</noscript>
82</div>
83<a id="skip.navbar.top">
84<!--   -->
85</a></div>
86<!-- ========= END OF TOP NAVBAR ========= -->
87</div>
88<div class="navPadding">&nbsp;</div>

89<script type="text/javascript"><!--
90$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
91//-->
92</script>

92
93</nav>
94</header>
95<main role="main">
96<div class="header">
97<h1 class="title"><h2>BeanIO 3 API</h2></h1>
98</div>
99<div class="contentContainer">
100<table class="overviewSummary">
101<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
102<tr>
103<th class="colFirst" scope="col">Package</th>
104<th class="colLast" scope="col">Description</th>
105</tr>
106<tbody>
107<tr class="altColor" id="i0">
108<th class="colFirst" scope="row"><a href="org/beanio/package-summary.html">org.beanio</a></th>
109<td class="colLast">
110<div class="block">Core BeanIO API.</div>
111</td>
112</tr>
113<tr class="rowColor" id="i1">
114<th class="colFirst" scope="row"><a href="org/beanio/annotation/package-summary.html">org.beanio.annotation</a></th>
115<td class="colLast">
116<div class="block">Stream builder annotations.</div>
117</td>
118</tr>
119<tr class="altColor" id="i2">
120<th class="colFirst" scope="row"><a href="org/beanio/builder/package-summary.html">org.beanio.builder</a></th>
121<td class="colLast">
122<div class="block">Stream builder API.</div>
123</td>
124</tr>
125<tr class="rowColor" id="i3">
126<th class="colFirst" scope="row"><a href="org/beanio/internal/package-summary.html">org.beanio.internal</a></th>
127<td class="colLast">
128<div class="block">Internal BeanIO implementation classes.</div>
129</td>
130</tr>
131<tr class="altColor" id="i4">
132<th class="colFirst" scope="row"><a href="org/beanio/internal/compiler/package-summary.html">org.beanio.internal.compiler</a></th>
133<td class="colLast">
134<div class="block">Classes to "compile" a stream configuration into a Stream parser.</div>
135</td>
136</tr>
137<tr class="rowColor" id="i5">
138<th class="colFirst" scope="row"><a href="org/beanio/internal/compiler/accessor/package-summary.html">org.beanio.internal.compiler.accessor</a></th>
139<td class="colLast">&nbsp;</td>
140</tr>
141<tr class="altColor" id="i6">
142<th class="colFirst" scope="row"><a href="org/beanio/internal/compiler/csv/package-summary.html">org.beanio.internal.compiler.csv</a></th>
143<td class="colLast">
144<div class="block"><code>ParserFactory</code> implementation for the CSV stream format.</div>
145</td>
146</tr>
147<tr class="rowColor" id="i7">
148<th class="colFirst" scope="row"><a href="org/beanio/internal/compiler/delimited/package-summary.html">org.beanio.internal.compiler.delimited</a></th>
149<td class="colLast">
150<div class="block"><code>ParserFactory</code> implementation for the delimited stream format.</div>
151</td>
152</tr>
153<tr class="altColor" id="i8">
154<th class="colFirst" scope="row"><a href="org/beanio/internal/compiler/fixedlength/package-summary.html">org.beanio.internal.compiler.fixedlength</a></th>
155<td class="colLast">
156<div class="block"><code>ParserFactory</code> implementation for the fixed length stream format.</div>
157</td>
158</tr>
159<tr class="rowColor" id="i9">
160<th class="colFirst" scope="row"><a href="org/beanio/internal/compiler/flat/package-summary.html">org.beanio.internal.compiler.flat</a></th>
161<td class="colLast">
162<div class="block">Base <code>ParserFactory</code> implementation for flat stream formats (CSV, delimited and fixed length).</div>
163</td>
164</tr>
165<tr class="altColor" id="i10">
166<th class="colFirst" scope="row"><a href="org/beanio/internal/compiler/json/package-summary.html">org.beanio.internal.compiler.json</a></th>
167<td class="colLast">
168<div class="block"><code>ParserFactory</code> implementation for the JSON stream format.</div>
169</td>
170</tr>
171<tr class="rowColor" id="i11">
172<th class="colFirst" scope="row"><a href="org/beanio/internal/compiler/xml/package-summary.html">org.beanio.internal.compiler.xml</a></th>
173<td class="colLast">
174<div class="block"><code>ParserFactory</code> implementation for the XML stream format.</div>
175</td>
176</tr>
177<tr class="altColor" id="i12">
178<th class="colFirst" scope="row"><a href="org/beanio/internal/config/package-summary.html">org.beanio.internal.config</a></th>
179<td class="colLast">
180<div class="block">Mapping file configuration counterparts.</div>
181</td>
182</tr>
183<tr class="rowColor" id="i13">
184<th class="colFirst" scope="row"><a href="org/beanio/internal/config/annotation/package-summary.html">org.beanio.internal.config.annotation</a></th>
185<td class="colLast">
186<div class="block">Annotation based mapping loader.</div>
187</td>
188</tr>
189<tr class="altColor" id="i14">
190<th class="colFirst" scope="row"><a href="org/beanio/internal/config/xml/package-summary.html">org.beanio.internal.config.xml</a></th>
191<td class="colLast">
192<div class="block">XML based mapping loader.</div>
193</td>
194</tr>
195<tr class="rowColor" id="i15">
196<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/package-summary.html">org.beanio.internal.parser</a></th>
197<td class="colLast">
198<div class="block"><code>BeanReader</code> and <code>BeanWriter</code> implementation classes.</div>
199</td>
200</tr>
201<tr class="altColor" id="i16">
202<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/accessor/package-summary.html">org.beanio.internal.parser.accessor</a></th>
203<td class="colLast">
204<div class="block"><code>PropertyAccessor</code> implementation classes.</div>
205</td>
206</tr>
207<tr class="rowColor" id="i17">
208<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/format/package-summary.html">org.beanio.internal.parser.format</a></th>
209<td class="colLast">
210<div class="block">Format specific parser implementation classes.</div>
211</td>
212</tr>
213<tr class="altColor" id="i18">
214<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/format/csv/package-summary.html">org.beanio.internal.parser.format.csv</a></th>
215<td class="colLast">
216<div class="block">Parser implementation for the CSV stream format.</div>
217</td>
218</tr>
219<tr class="rowColor" id="i19">
220<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/format/delimited/package-summary.html">org.beanio.internal.parser.format.delimited</a></th>
221<td class="colLast">
222<div class="block">Parser implementation for the delimited stream format.</div>
223</td>
224</tr>
225<tr class="altColor" id="i20">
226<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/format/fixedlength/package-summary.html">org.beanio.internal.parser.format.fixedlength</a></th>
227<td class="colLast">
228<div class="block">Parser implementation for the fixed length stream format.</div>
229</td>
230</tr>
231<tr class="rowColor" id="i21">
232<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/format/flat/package-summary.html">org.beanio.internal.parser.format.flat</a></th>
233<td class="colLast">
234<div class="block">Base parser implementation for flat stream formats (CSV, delimited and fixed length).</div>
235</td>
236</tr>
237<tr class="altColor" id="i22">
238<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/format/json/package-summary.html">org.beanio.internal.parser.format.json</a></th>
239<td class="colLast">
240<div class="block">Parser implementation for the JSON stream format.</div>
241</td>
242</tr>
243<tr class="rowColor" id="i23">
244<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/format/xml/package-summary.html">org.beanio.internal.parser.format.xml</a></th>
245<td class="colLast">
246<div class="block">Parser implementation for the XML stream format.</div>
247</td>
248</tr>
249<tr class="altColor" id="i24">
250<th class="colFirst" scope="row"><a href="org/beanio/internal/parser/message/package-summary.html">org.beanio.internal.parser.message</a></th>
251<td class="colLast">
252<div class="block"><code>MessageFactory</code> implementation classes.</div>
253</td>
254</tr>
255<tr class="rowColor" id="i25">
256<th class="colFirst" scope="row"><a href="org/beanio/internal/util/package-summary.html">org.beanio.internal.util</a></th>
257<td class="colLast">
258<div class="block">Internal utility classes.</div>
259</td>
260</tr>
261<tr class="altColor" id="i26">
262<th class="colFirst" scope="row"><a href="org/beanio/stream/package-summary.html">org.beanio.stream</a></th>
263<td class="colLast">
264<div class="block">Record parsing API.</div>
265</td>
266</tr>
267<tr class="rowColor" id="i27">
268<th class="colFirst" scope="row"><a href="org/beanio/stream/csv/package-summary.html">org.beanio.stream.csv</a></th>
269<td class="colLast">
270<div class="block">CSV record parser implementation.</div>
271</td>
272</tr>
273<tr class="altColor" id="i28">
274<th class="colFirst" scope="row"><a href="org/beanio/stream/delimited/package-summary.html">org.beanio.stream.delimited</a></th>
275<td class="colLast">
276<div class="block">Delimited record parser implementation.</div>
277</td>
278</tr>
279<tr class="rowColor" id="i29">
280<th class="colFirst" scope="row"><a href="org/beanio/stream/fixedlength/package-summary.html">org.beanio.stream.fixedlength</a></th>
281<td class="colLast">
282<div class="block">Fixed length record parser implementation.</div>
283</td>
284</tr>
285<tr class="altColor" id="i30">
286<th class="colFirst" scope="row"><a href="org/beanio/stream/json/package-summary.html">org.beanio.stream.json</a></th>
287<td class="colLast">
288<div class="block">JSON record parser implementation.</div>
289</td>
290</tr>
291<tr class="rowColor" id="i31">
292<th class="colFirst" scope="row"><a href="org/beanio/stream/util/package-summary.html">org.beanio.stream.util</a></th>
293<td class="colLast">
294<div class="block">Utility classes for record reader and writer implementations.</div>
295</td>
296</tr>
297<tr class="altColor" id="i32">
298<th class="colFirst" scope="row"><a href="org/beanio/stream/xml/package-summary.html">org.beanio.stream.xml</a></th>
299<td class="colLast">
300<div class="block">XML record parser implementation.</div>
301</td>
302</tr>
303<tr class="rowColor" id="i33">
304<th class="colFirst" scope="row"><a href="org/beanio/types/package-summary.html">org.beanio.types</a></th>
305<td class="colLast">
306<div class="block">Type handler API and default implementations for BeanIO supported types.</div>
307</td>
308</tr>
309<tr class="altColor" id="i34">
310<th class="colFirst" scope="row"><a href="org/beanio/types/xml/package-summary.html">org.beanio.types.xml</a></th>
311<td class="colLast">
312<div class="block">Default type handler implementations specific to XML formatted streams.</div>
313</td>
314</tr>
315</tbody>
316</table>
317</div>
318</main>
319<footer role="contentinfo">
320<nav role="navigation">
321<!-- ======= START OF BOTTOM NAVBAR ====== -->
322<div class="bottomNav"><a id="navbar.bottom">
323<!--   -->
324</a>
325<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
326<a id="navbar.bottom.firstrow">
327<!--   -->
328</a>
329<ul class="navList" title="Navigation">
330<li class="navBarCell1Rev">Overview</li>
331<li>Package</li>
332<li>Class</li>
333<li><a href="overview-tree.html">Tree</a></li>
334<li><a href="deprecated-list.html">Deprecated</a></li>
335<li><a href="index-all.html">Index</a></li>
336<li><a href="help-doc.html">Help</a></li>
337</ul>
338<div class="aboutLanguage"><i>

338Copyright &copy; 2010-2024 Kevin Seim and BeanIO contributors</i></div>
339</div>
340<div class="subNav">
341<ul class="navList" id="allclasses_navbar_bottom">
342<li><a href="allclasses.html">All&nbsp;Classes</a></li>
343</ul>
344<div>

345<script type="text/javascript"><!--
346  allClassesLink = document.getElementById("allclasses_navbar_bottom");
347  if(window==top) {
348    allClassesLink.style.display = "block";
349  }
350  else {
351    allClassesLink.style.display = "none";
352  }
353  //-->
354</script>

354
355<noscript>
356<div>JavaScript is disabled on your browser.</div>
357</noscript>
358</div>
359<a id="skip.navbar.bottom">
360<!--   -->
361</a></div>
362<!-- ======== END OF BOTTOM NAVBAR ======= -->
363</nav>
364</footer>
365</body>
366</html>