1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
|
<!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 (version 1.7.0_67) on Tue Dec 30 21:45:32 PST 2014 -->
<title>StAXReaderWrapper (JiBX Java data binding to XML - Version 1.2.6)</title>
<meta name="date" content="2014-12-30">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StAXReaderWrapper (JiBX Java data binding to XML - Version 1.2.6)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/jibx/runtime/impl/StAXReaderFactory.html" title="class in org.jibx.runtime.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/jibx/runtime/impl/StAXWriter.html" title="class in org.jibx.runtime.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jibx/runtime/impl/StAXReaderWrapper.html" target="_top">Frames</a></li>
<li><a href="StAXReaderWrapper.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jibx.runtime.impl</div>
<h2 title="Class StAXReaderWrapper" class="title">Class StAXReaderWrapper</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jibx.runtime.impl.StAXReaderWrapper</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">StAXReaderWrapper</span>
extends java.lang.Object
implements <a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></pre>
<div class="block">Wrapper for a StAX parser implementation. This delegates most calls
more or less directly, only adding the required namespace functionality
on top of the StAX API.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.jibx.runtime.IXMLReader">
<!-- -->
</a>
<h3>Fields inherited from interface org.jibx.runtime.<a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></h3>
<code><a href="../../../../org/jibx/runtime/IXMLReader.html#CDSECT">CDSECT</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#COMMENT">COMMENT</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#DOCDECL">DOCDECL</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#END_DOCUMENT">END_DOCUMENT</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#END_TAG">END_TAG</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#ENTITY_REF">ENTITY_REF</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#IGNORABLE_WHITESPACE">IGNORABLE_WHITESPACE</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#PROCESSING_INSTRUCTION">PROCESSING_INSTRUCTION</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#START_DOCUMENT">START_DOCUMENT</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#START_TAG">START_TAG</a>, <a href="../../../../org/jibx/runtime/IXMLReader.html#TEXT">TEXT</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#StAXReaderWrapper(javax.xml.stream.XMLStreamReader,%20java.lang.String,%20boolean)">StAXReaderWrapper</a></strong>(javax.xml.stream.XMLStreamReader rdr,
java.lang.String name,
boolean nsa)</code>
<div class="block">Constructor used by factory.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#buildPositionString()">buildPositionString</a></strong>()</code>
<div class="block">Build current parse input position description.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getAttributeCount()">getAttributeCount</a></strong>()</code>
<div class="block">Get the number of attributes of the current start tag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getAttributeName(int)">getAttributeName</a></strong>(int index)</code>
<div class="block">Get an attribute name from the current start tag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getAttributeNamespace(int)">getAttributeNamespace</a></strong>(int index)</code>
<div class="block">Get an attribute namespace from the current start tag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getAttributePrefix(int)">getAttributePrefix</a></strong>(int index)</code>
<div class="block">Get an attribute prefix from the current start tag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getAttributeValue(int)">getAttributeValue</a></strong>(int index)</code>
<div class="block">Get an attribute value from the current start tag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getAttributeValue(java.lang.String,%20java.lang.String)">getAttributeValue</a></strong>(java.lang.String ns,
java.lang.String name)</code>
<div class="block">Get an attribute value from the current start tag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getColumnNumber()">getColumnNumber</a></strong>()</code>
<div class="block">Get current source column number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getDocumentName()">getDocumentName</a></strong>()</code>
<div class="block">Get document name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getEventType()">getEventType</a></strong>()</code>
<div class="block">Gets the current parse event type, without changing the current parse
state.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getInputEncoding()">getInputEncoding</a></strong>()</code>
<div class="block">Return the input encoding, if known.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getLineNumber()">getLineNumber</a></strong>()</code>
<div class="block">Get current source line number.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getName()">getName</a></strong>()</code>
<div class="block">Get element name from the current start or end tag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getNamespace()">getNamespace</a></strong>()</code>
<div class="block">Get element namespace from the current start or end tag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getNamespace(java.lang.String)">getNamespace</a></strong>(java.lang.String prefix)</code>
<div class="block">Get namespace URI associated with prefix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getNamespaceCount(int)">getNamespaceCount</a></strong>(int depth)</code>
<div class="block">Get number of namespace declarations active at depth.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getNamespacePrefix(int)">getNamespacePrefix</a></strong>(int index)</code>
<div class="block">Get namespace prefix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getNamespaceUri(int)">getNamespaceUri</a></strong>(int index)</code>
<div class="block">Get namespace URI.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getNestingDepth()">getNestingDepth</a></strong>()</code>
<div class="block">Get current element nesting depth.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getPrefix()">getPrefix</a></strong>()</code>
<div class="block">Get element prefix from the current start or end tag.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#getText()">getText</a></strong>()</code>
<div class="block">Get current text.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#init()">init</a></strong>()</code>
<div class="block">Initialize reader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#isNamespaceAware()">isNamespaceAware</a></strong>()</code>
<div class="block">Return namespace processing flag.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#next()">next</a></strong>()</code>
<div class="block">Advance to next binding component of input document.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jibx/runtime/impl/StAXReaderWrapper.html#nextToken()">nextToken</a></strong>()</code>
<div class="block">Advance to next parse event of input document.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StAXReaderWrapper(javax.xml.stream.XMLStreamReader, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StAXReaderWrapper</h4>
<pre>public StAXReaderWrapper(javax.xml.stream.XMLStreamReader rdr,
java.lang.String name,
boolean nsa)</pre>
<div class="block">Constructor used by factory. This checks the parser state, and if
positioned at a start tag it initializes the namespace information for
that start tag.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>rdr</code> - event reader</dd><dd><code>name</code> - document name</dd><dd><code>nsa</code> - namespace aware flag</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="init()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public void init()</pre>
<div class="block">Initialize reader.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#init()">init</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
</dl>
</li>
</ul>
<a name="buildPositionString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buildPositionString</h4>
<pre>public java.lang.String buildPositionString()</pre>
<div class="block">Build current parse input position description.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#buildPositionString()">buildPositionString</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>text description of current parse position</dd></dl>
</li>
</ul>
<a name="nextToken()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>nextToken</h4>
<pre>public int nextToken()
throws <a href="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#nextToken()">IXMLReader</a></code></strong></div>
<div class="block">Advance to next parse event of input document.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#nextToken()">nextToken</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>parse event type code</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</a></code> - if error reading or parsing document</dd></dl>
</li>
</ul>
<a name="next()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public int next()
throws <a href="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#next()">IXMLReader</a></code></strong></div>
<div class="block">Advance to next binding component of input document. This is a
higher-level operation than <a href="../../../../org/jibx/runtime/IXMLReader.html#nextToken()"><code>IXMLReader.nextToken()</code></a>, which consolidates text
content and ignores parse events for components such as comments and PIs.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#next()">next</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>parse event type code</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</a></code> - if error reading or parsing document</dd></dl>
</li>
</ul>
<a name="getEventType()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventType</h4>
<pre>public int getEventType()
throws <a href="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</a></pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getEventType()">IXMLReader</a></code></strong></div>
<div class="block">Gets the current parse event type, without changing the current parse
state.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getEventType()">getEventType</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>parse event type code</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../org/jibx/runtime/JiBXException.html" title="class in org.jibx.runtime">JiBXException</a></code> - if error parsing document</dd></dl>
</li>
</ul>
<a name="getName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getName()">IXMLReader</a></code></strong></div>
<div class="block">Get element name from the current start or end tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getName()">getName</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>local name if namespace handling enabled, full name if namespace
handling disabled</dd></dl>
</li>
</ul>
<a name="getNamespace()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespace</h4>
<pre>public java.lang.String getNamespace()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespace()">IXMLReader</a></code></strong></div>
<div class="block">Get element namespace from the current start or end tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespace()">getNamespace</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>namespace URI if namespace handling enabled and element is in a
namespace, empty string otherwise</dd></dl>
</li>
</ul>
<a name="getPrefix()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPrefix</h4>
<pre>public java.lang.String getPrefix()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getPrefix()">IXMLReader</a></code></strong></div>
<div class="block">Get element prefix from the current start or end tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getPrefix()">getPrefix</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>prefix text (<code>null</code> if no prefix)</dd></dl>
</li>
</ul>
<a name="getAttributeCount()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeCount</h4>
<pre>public int getAttributeCount()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeCount()">IXMLReader</a></code></strong></div>
<div class="block">Get the number of attributes of the current start tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeCount()">getAttributeCount</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>number of attributes</dd></dl>
</li>
</ul>
<a name="getAttributeName(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeName</h4>
<pre>public java.lang.String getAttributeName(int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeName(int)">IXMLReader</a></code></strong></div>
<div class="block">Get an attribute name from the current start tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeName(int)">getAttributeName</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - attribute index</dd>
<dt><span class="strong">Returns:</span></dt><dd>local name if namespace handling enabled, full name if namespace
handling disabled</dd></dl>
</li>
</ul>
<a name="getAttributeNamespace(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeNamespace</h4>
<pre>public java.lang.String getAttributeNamespace(int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeNamespace(int)">IXMLReader</a></code></strong></div>
<div class="block">Get an attribute namespace from the current start tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeNamespace(int)">getAttributeNamespace</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - attribute index</dd>
<dt><span class="strong">Returns:</span></dt><dd>namespace URI if namespace handling enabled and attribute is in a
namespace, empty string otherwise</dd></dl>
</li>
</ul>
<a name="getAttributePrefix(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributePrefix</h4>
<pre>public java.lang.String getAttributePrefix(int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributePrefix(int)">IXMLReader</a></code></strong></div>
<div class="block">Get an attribute prefix from the current start tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributePrefix(int)">getAttributePrefix</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - attribute index</dd>
<dt><span class="strong">Returns:</span></dt><dd>prefix for attribute (<code>null</code> if no prefix present)</dd></dl>
</li>
</ul>
<a name="getAttributeValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeValue</h4>
<pre>public java.lang.String getAttributeValue(int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeValue(int)">IXMLReader</a></code></strong></div>
<div class="block">Get an attribute value from the current start tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeValue(int)">getAttributeValue</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - attribute index</dd>
<dt><span class="strong">Returns:</span></dt><dd>value text</dd></dl>
</li>
</ul>
<a name="getAttributeValue(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAttributeValue</h4>
<pre>public java.lang.String getAttributeValue(java.lang.String ns,
java.lang.String name)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeValue(java.lang.String,%20java.lang.String)">IXMLReader</a></code></strong></div>
<div class="block">Get an attribute value from the current start tag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getAttributeValue(java.lang.String,%20java.lang.String)">getAttributeValue</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>ns</code> - namespace URI for expected attribute (may be <code>null</code>
or the empty string for the empty namespace)</dd><dd><code>name</code> - attribute name expected</dd>
<dt><span class="strong">Returns:</span></dt><dd>attribute value text, or <code>null</code> if missing</dd></dl>
</li>
</ul>
<a name="getText()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre>public java.lang.String getText()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getText()">IXMLReader</a></code></strong></div>
<div class="block">Get current text. When positioned on a TEXT event this returns the actual
text; for CDSECT it returns the text inside the CDATA section; for
COMMENT, DOCDECL, or PROCESSING_INSTRUCTION it returns the text inside
the structure.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getText()">getText</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>text for current event</dd></dl>
</li>
</ul>
<a name="getNestingDepth()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNestingDepth</h4>
<pre>public int getNestingDepth()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNestingDepth()">IXMLReader</a></code></strong></div>
<div class="block">Get current element nesting depth. The returned depth always includes the
current start or end tag (if positioned on a start or end tag).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNestingDepth()">getNestingDepth</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>element nesting depth</dd></dl>
</li>
</ul>
<a name="getNamespaceCount(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespaceCount</h4>
<pre>public int getNamespaceCount(int depth)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespaceCount(int)">IXMLReader</a></code></strong></div>
<div class="block">Get number of namespace declarations active at depth.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespaceCount(int)">getNamespaceCount</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>depth</code> - element nesting depth</dd>
<dt><span class="strong">Returns:</span></dt><dd>number of namespaces active at depth</dd></dl>
</li>
</ul>
<a name="getNamespaceUri(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespaceUri</h4>
<pre>public java.lang.String getNamespaceUri(int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespaceUri(int)">IXMLReader</a></code></strong></div>
<div class="block">Get namespace URI.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespaceUri(int)">getNamespaceUri</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - declaration index</dd>
<dt><span class="strong">Returns:</span></dt><dd>namespace URI</dd></dl>
</li>
</ul>
<a name="getNamespacePrefix(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespacePrefix</h4>
<pre>public java.lang.String getNamespacePrefix(int index)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespacePrefix(int)">IXMLReader</a></code></strong></div>
<div class="block">Get namespace prefix.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespacePrefix(int)">getNamespacePrefix</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - declaration index</dd>
<dt><span class="strong">Returns:</span></dt><dd>namespace prefix, <code>null</code> if a default namespace</dd></dl>
</li>
</ul>
<a name="getDocumentName()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDocumentName</h4>
<pre>public java.lang.String getDocumentName()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getDocumentName()">IXMLReader</a></code></strong></div>
<div class="block">Get document name.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getDocumentName()">getDocumentName</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>document name, <code>null</code> if not known</dd></dl>
</li>
</ul>
<a name="getLineNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLineNumber</h4>
<pre>public int getLineNumber()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getLineNumber()">IXMLReader</a></code></strong></div>
<div class="block">Get current source line number.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getLineNumber()">getLineNumber</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>line number from source document, <code>-1</code> if line number
information not available</dd></dl>
</li>
</ul>
<a name="getColumnNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getColumnNumber</h4>
<pre>public int getColumnNumber()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getColumnNumber()">IXMLReader</a></code></strong></div>
<div class="block">Get current source column number.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getColumnNumber()">getColumnNumber</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>column number from source document, <code>-1</code> if column
number information not available</dd></dl>
</li>
</ul>
<a name="getNamespace(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespace</h4>
<pre>public java.lang.String getNamespace(java.lang.String prefix)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespace(java.lang.String)">IXMLReader</a></code></strong></div>
<div class="block">Get namespace URI associated with prefix.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getNamespace(java.lang.String)">getNamespace</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - namespace prefix to be matched (<code>null</code> for
default namespace)</dd>
<dt><span class="strong">Returns:</span></dt><dd>associated URI (<code>null</code> if prefix not defined)</dd></dl>
</li>
</ul>
<a name="getInputEncoding()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputEncoding</h4>
<pre>public java.lang.String getInputEncoding()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#getInputEncoding()">IXMLReader</a></code></strong></div>
<div class="block">Return the input encoding, if known. This is only valid after parsing of
a document has been started.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#getInputEncoding()">getInputEncoding</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>input encoding (<code>null</code> if unknown)</dd></dl>
</li>
</ul>
<a name="isNamespaceAware()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isNamespaceAware</h4>
<pre>public boolean isNamespaceAware()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jibx/runtime/IXMLReader.html#isNamespaceAware()">IXMLReader</a></code></strong></div>
<div class="block">Return namespace processing flag.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jibx/runtime/IXMLReader.html#isNamespaceAware()">isNamespaceAware</a></code> in interface <code><a href="../../../../org/jibx/runtime/IXMLReader.html" title="interface in org.jibx.runtime">IXMLReader</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>namespace processing flag (<code>true</code> if namespaces are
processed by reader, <code>false</code> if not)</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/jibx/runtime/impl/StAXReaderFactory.html" title="class in org.jibx.runtime.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/jibx/runtime/impl/StAXWriter.html" title="class in org.jibx.runtime.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jibx/runtime/impl/StAXReaderWrapper.html" target="_top">Frames</a></li>
<li><a href="StAXReaderWrapper.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width='80%%'><tr><td width='50%%'><p align='center'><a href='http://www.jibx.org/' target='_top'><font size='3'><b>Project Web Site</b></font></a></td><td width='50%%'><p align='center'></td></tr></table></small></p>
</body>
</html>
|
