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
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<!--
Copyright 2001-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!-- $Id$ -->
<!-- Created by htmlize-0.67 in css mode. -->
<html>
<head>
<title>SyncedFoXmlEventsBuffer.java</title>
<style type="text/css">
<!--
body {
color: #000000;
background-color: #faf0e6;
} /* default */
.reference {
color: #cd0000;
background-color: #faf0e6;
} /* font-lock-reference-face */
.comment {
color: #00008b;
background-color: #faf0e6;
} /* font-lock-comment-face */
.jde-java-font-lock-package {
color: #0000cd;
background-color: #faf0e6;
} /* jde-java-font-lock-package-face */
.jde-java-font-lock-constant {
color: #5f9ea0;
background-color: #faf0e6;
} /* jde-java-font-lock-constant-face */
.function-name {
color: #8b2323;
background-color: #faf0e6;
} /* font-lock-function-name-face */
.variable-name {
color: #8b008b;
background-color: #faf0e6;
} /* font-lock-variable-name-face */
.jde-java-font-lock-bold {
background-color: #faf0e6;
font-weight: bold;
} /* jde-java-font-lock-bold-face */
.jde-java-font-lock-doc-tag {
color: #008b00;
background-color: #faf0e6;
} /* jde-java-font-lock-doc-tag-face */
.keyword {
color: #8b0000;
background-color: #faf0e6;
} /* font-lock-keyword-face */
.jde-java-font-lock-number {
color: #bc8f8f;
background-color: #faf0e6;
} /* jde-java-font-lock-number-face */
.jde-java-font-lock-code {
background-color: #faf0e6;
} /* jde-java-font-lock-code-face */
.jde-java-font-lock-italic {
background-color: #faf0e6;
font-style: italic;
} /* jde-java-font-lock-italic-face */
.jde-java-font-lock-modifier {
color: #da70d6;
background-color: #faf0e6;
} /* jde-java-font-lock-modifier-face */
.string {
color: #008b00;
background-color: #faf0e6;
} /* font-lock-string-face */
.type {
color: #4682b4;
background-color: #faf0e6;
} /* font-lock-type-face */
a {
color: inherit;
background-color: inherit;
font: inherit;
text-decoration: inherit;
}
a:hover {
text-decoration: underline;
}
-->
</style>
</head>
<body>
<pre>
<span class="comment">/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/</span>
<span class="keyword">package</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">xml</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">datastructs</span>.<span class="type">SyncedCircularBuffer</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">apps</span>.<span class="type">FOPException</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">fo</span>.<span class="type">FObjectNames</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">fo</span>.<span class="type">FObjectSets</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">org</span>.<span class="jde-java-font-lock-package">apache</span>.<span class="jde-java-font-lock-package">fop</span>.<span class="jde-java-font-lock-package">xml</span>.<span class="type">FoXMLEventPool</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">NoSuchElementException</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">LinkedList</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">Iterator</span>;
<span class="keyword">import</span> <span class="jde-java-font-lock-package">java</span>.<span class="jde-java-font-lock-package">util</span>.<span class="type">BitSet</span>;
<span class="comment">/**
* A synchronized circular buffer for FoXMLEvents.
* </span><span class="jde-java-font-lock-doc-tag">@see</span><span class="comment"> </span><span class="jde-java-font-lock-code">org.apache.fop.datastructs.SyncedCircularBuffer</span><span class="comment">
* @author <a href="mailto:pbwest@powerup.com.au">Peter B. West</a>
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="keyword">class</span> <span class="function-name" id="SyncedFoXmlEventsBufferClass">SyncedFoXmlEventsBuffer</span> <span class="keyword">extends</span> <span class="type">SyncedCircularBuffer</span> {
<span class="comment">/**
* Constant for <i></span><span class="jde-java-font-lock-italic">discardEvent</span><span class="comment"></i> field of
* <i>getEndElement(boolean discardEvent, FoXMLEvent(, boolean)).
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="jde-java-font-lock-modifier">static</span> <span class="jde-java-font-lock-modifier">final</span> <span class="type">boolean</span> <span class="variable-name" id="DISCARD_EV">DISCARD_EV</span> = <span class="jde-java-font-lock-constant" id="true">true</span>,
<span class="jde-java-font-lock-constant" id="RETAIN_EV">RETAIN_EV</span> = <span class="jde-java-font-lock-constant">false</span>;
<span class="comment">/**
* Maintains an index of namespace URIs. These can then be referred to
* by an <tt>int</tt> index.
*/</span>
<span class="jde-java-font-lock-modifier">private</span> <span class="type">XMLNamespaces</span> <span class="variable-name" id="namespaces">namespaces</span>;
<span class="comment">/**
* The FoXMLEventPool for this buffer.
*/</span>
<span class="jde-java-font-lock-modifier">private</span> <span class="type">FoXMLEventPool</span> <span class="variable-name" id="pool">pool</span>;
<span class="comment">/**
* No-argument constructor sets up a buffer with the default number of
* elements.
* The producer and consumer <tt>Thread</tt>s default to the current
* thread at the time of instantiation.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="function-name" id="SyncedFoXmlEventsBuffer">SyncedFoXmlEventsBuffer</span>()
<span class="keyword">throws</span> <span class="type">IllegalArgumentException</span>
{
<span class="keyword">super</span>();
namespaces = <span class="keyword">new</span> <span class="type">XMLNamespaces</span>();
pool = <span class="keyword">new</span> <span class="type">FoXMLEventPool</span>(namespaces, <span class="jde-java-font-lock-constant" id="DEFAULTBUFSIZE">DEFAULTBUFSIZE</span>);
}
<span class="comment">/**
* Constructor taking one argument; the size of the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="size">size</span><span class="comment"> the size of the buffer. Must be > 1.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="function-name">SyncedFoXmlEventsBuffer</span>(<span class="type">int</span> <span class="variable-name">size</span>)
<span class="keyword">throws</span> <span class="type">IllegalArgumentException</span>
{
<span class="keyword">super</span>(size);
namespaces = <span class="keyword">new</span> <span class="type">XMLNamespaces</span>();
pool = <span class="keyword">new</span> <span class="type">FoXMLEventPool</span>(namespaces);
}
<span class="comment">/**
* Get the <tt>XMLNamespaces</tt> from this buffer.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> - the namespaces object.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">XMLNamespaces</span> <span class="function-name" id="getNamespaces">getNamespaces</span>() { <span class="keyword">return</span> namespaces; }
<span class="comment">/**
* Get the <tt>FoXMLEventPool</tt> from this buffer.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> - the pool object.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEventPool</span> <span class="function-name" id="getPool">getPool</span>() { <span class="keyword">return</span> pool; }
<span class="comment">/**
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> next event from the SyncedCircularBuffer
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException.</span><span class="comment"> The purpose of this method is to catch
* and transform any InterruptedException exceptions thrown by the
* <tt>SyncedCircularBuffer</tt>.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="getEvent">getEvent</span>() <span class="keyword">throws</span> <span class="type">FOPException</span> {
<span class="type">FoXMLEvent</span> <span class="variable-name" id="ev">ev</span>;
<span class="keyword">try</span> {
ev = (<span class="type">FoXMLEvent</span>)get();
<span class="comment">//System.out.println("getEvent: " + ev);
</span> <span class="keyword">return</span> ev;
} <span class="keyword">catch</span> (<span class="type">InterruptedException</span> <span class="variable-name" id="e">e</span>) {
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">FOPException</span>(e);
}
}
<span class="comment">/**
* Get the next event of the given type from the buffer. Discard
* intervening events.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="eventType">eventType</span><span class="comment"> - the <tt>int</tt> event type.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an event of the given type.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="getTypedEvent">getTypedEvent</span>(<span class="type">int</span> <span class="variable-name">eventType</span>) <span class="keyword">throws</span> <span class="type">FOPException</span> {
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant" id="null">null</span> && ev.type != eventType) {
ev = getEvent();
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>) {
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
(XMLEvent.eventTypeName(eventType) + "<span class="string"> not found.</span>");
}
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Get the next event of the given type and with the given <tt>QName</tt>
* from the buffer. Discard intervening events.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">eventType</span><span class="comment"> - the <tt>int</tt> event type.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="qName">qName</span><span class="comment"> a <tt>String</tt> with the <tt>QName</tt> of the
* required element.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an event of the given type.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getTypedEvent</span>(<span class="type">int</span> <span class="variable-name">eventType</span>, <span class="type">String</span> <span class="variable-name">qName</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span> &&
! (ev.type == eventType && ev.qName.equals(qName))) {
ev = getEvent();
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>) {
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
(XMLEvent.eventTypeName(eventType) + "<span class="string"> </span>" + qName + "<span class="string"> not found.</span>");
}
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Get the next event of the given type, and with the given URI index and
* local name, from the buffer. Discard intervening events.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">eventType</span><span class="comment"> - the <tt>int</tt> event type.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="uriIndex">uriIndex</span><span class="comment"> - the <tt>int</tt> URI index maintained in the
* <tt>XMLNamespaces</tt> object.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="localName">localName</span><span class="comment"> a <tt>String</tt> with the local name of the
* required element.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an event of the given type.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">getTypedEvent</span>
(<span class="type">int</span> <span class="variable-name">eventType</span>, <span class="type">int</span> <span class="variable-name">uriIndex</span>, <span class="type">String</span> <span class="variable-name">localName</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span> &&
! (ev.type == eventType
&& ev.uriIndex == uriIndex
&& ev.localName.equals(localName))) {
pool.surrenderEvent(ev);
ev = getEvent();
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
(XMLEvent.eventTypeName(eventType)
+ namespaces.getIndexURI(uriIndex)
+ "<span class="string">:</span>" + localName + "<span class="string"> not found.</span>");
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Get the next event of the given type, from the fo: namespace, with
* the given FO type. Discard intervening events.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">eventType</span><span class="comment"> - the <tt>int</tt> event type.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="foType">foType</span><span class="comment"> - the <tt>int</tt> FO type.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an event of the given type.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getTypedEvent</span>(<span class="type">int</span> <span class="variable-name">eventType</span>, <span class="type">int</span> <span class="variable-name">foType</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span> &&
! (ev.type == eventType && ev.foType == foType)) {
pool.surrenderEvent(ev);
ev = getEvent();
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
(XMLEvent.eventTypeName(eventType)
+ "<span class="string"> FO type </span>" + foType + "<span class="string"> not found.</span>");
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Return the next element if it is of the required type. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">eventType</span><span class="comment"> - the <tt>int</tt> event type.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="discardWhiteSpace">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an event of the required type. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the buffer is empty.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name" id="expectTypedEvent">expectTypedEvent</span>
(<span class="type">int</span> <span class="variable-name">eventType</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">if</span> (discardWhiteSpace) {
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type == <span class="reference">XMLEvent</span>.<span class="type">CHARACTERS</span>
&& ev.chars.trim().equals("")) {
pool.surrenderEvent(ev);
ev = getEvent();
}
}
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type == eventType) {
<span class="keyword">return</span> ev;
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
(XMLEvent.eventTypeName(eventType)
+ "<span class="string"> not found: end of buffer.</span>");
pushBack(ev);
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
<span class="comment">/**
* Return the next element if it is of the required type and has the
* required <tt>QName</tt>. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">eventType</span><span class="comment"> - the <tt>int</tt> event type.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">qName</span><span class="comment"> a <tt>String</tt> with the <tt>QName</tt> of the
* required element.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an event of the required type. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectTypedEvent</span>
(<span class="type">int</span> <span class="variable-name">eventType</span>, <span class="type">String</span> <span class="variable-name">qName</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">if</span> (discardWhiteSpace) {
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type == <span class="reference">XMLEvent</span>.<span class="type">CHARACTERS</span>
&& ev.chars.trim().equals("")) {
pool.surrenderEvent(ev);
ev = getEvent();
}
}
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type == eventType && ev.qName.equals(qName)) {
<span class="keyword">return</span> ev;
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
(XMLEvent.eventTypeName(eventType)
+ "<span class="string"> not found: end of buffer.</span>");
pushBack(ev);
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
<span class="comment">/**
* Return the next element if it is of the required type and has the
* required URI index and local name. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">eventType</span><span class="comment"> - the <tt>int</tt> event type.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">uriIndex</span><span class="comment"> - the <tt>int</tt> URI index.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">localName</span><span class="comment"> a <tt>String</tt> with the local name of the
* required element.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an event of the required type. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectTypedEvent</span>
(<span class="type">int</span> <span class="variable-name">eventType</span>, <span class="type">int</span> <span class="variable-name">uriIndex</span>,
<span class="type">String</span> <span class="variable-name">localName</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">if</span> (discardWhiteSpace) {
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type == <span class="reference">XMLEvent</span>.<span class="type">CHARACTERS</span>
&& ev.chars.trim().equals("")) {
pool.surrenderEvent(ev);
ev = getEvent();
}
}
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>
&& ev.type == eventType
&& ev.uriIndex == uriIndex
&& ev.localName.equals(localName)) {
<span class="keyword">return</span> ev;
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
(XMLEvent.eventTypeName(eventType)
+ "<span class="string"> not found: end of buffer.</span>");
pushBack(ev);
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
<span class="comment">/**
* Return the next element if it is of the required type and has the
* required FO type. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">eventType</span><span class="comment"> - the <tt>int</tt> event type.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">foType</span><span class="comment"> - the <tt>int</tt> FO type.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an event of the required type. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectTypedEvent</span>
(<span class="type">int</span> <span class="variable-name">eventType</span>, <span class="type">int</span> <span class="variable-name">foType</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">if</span> (discardWhiteSpace) {
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type == <span class="reference">XMLEvent</span>.<span class="type">CHARACTERS</span>
&& ev.chars.trim().equals("")) {
pool.surrenderEvent(ev);
ev = getEvent();
}
}
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type == eventType && ev.foType == foType) {
<span class="keyword">return</span> ev;
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
(XMLEvent.eventTypeName(eventType)
+ "<span class="string"> not found: end of buffer.</span>");
pushBack(ev);
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
<span class="comment">/**
* Get the next ENDDOCUMENT event from the buffer. Discard any other
* events preceding the ENDDOCUMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an ENDDOCUMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="getEndDocument">getEndDocument</span>() <span class="keyword">throws</span> <span class="type">FOPException</span> {
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant" id="ENDDOCUMENT">ENDDOCUMENT</span>);
}
<span class="comment">/**
* Return the next element if it is an ENDDOCUMENT. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an ENDDOCUMENT event. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectEndDocument">expectEndDocument</span>(<span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">ENDDOCUMENT</span>, discardWhiteSpace);
}
<span class="comment">/**
* Get the next STARTELEMENT event from the buffer. Discard any other
* events preceding the STARTELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a STARTELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="getStartElement">getStartElement</span>() <span class="keyword">throws</span> <span class="type">FOPException</span> {
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant" id="STARTELEMENT">STARTELEMENT</span>);
}
<span class="comment">/**
* Return the next element if it is a STARTELEMENT. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a STARTELEMENT event. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectStartElement">expectStartElement</span>(<span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">STARTELEMENT</span>, discardWhiteSpace);
}
<span class="comment">/**
* Get the next STARTELEMENT event with the given <tt>QName</tt>
* from the buffer. Discard any other events preceding the
* STARTELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">qName</span><span class="comment"> a <tt>String</tt> with the <tt>QName</tt> of the
* required STARTELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a STARTELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getStartElement</span>(<span class="type">String</span> <span class="variable-name">qName</span>) <span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">STARTELEMENT</span>, qName);
}
<span class="comment">/**
* Return the next element if it is a STARTELEMENT with the given
* <tt>QName</tt>. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">qName</span><span class="comment"> a <tt>String</tt> with the <tt>QName</tt> of the
* required STARTELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a STARTELEMENT event. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectStartElement</span>
(<span class="type">String</span> <span class="variable-name">qName</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">STARTELEMENT</span>, qName, discardWhiteSpace);
}
<span class="comment">/**
* Get the next STARTELEMENT event with the given URI index and local name
* from the buffer. Discard any other events preceding the
* STARTELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">uriIndex</span><span class="comment"> an <tt>int</tt> with the index of the URI of the
* required URI
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">localName</span><span class="comment"> a <tt>String</tt> with the local name of the
* required STARTELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a STARTELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getStartElement</span>(<span class="type">int</span> <span class="variable-name">uriIndex</span>, <span class="type">String</span> <span class="variable-name">localName</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">STARTELEMENT</span>, uriIndex, localName);
}
<span class="comment">/**
* Return the next element if it is a STARTELEMENT with the given
* URI index and local name. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">uriIndex</span><span class="comment"> an <tt>int</tt> URI index.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">localName</span><span class="comment"> a <tt>String</tt> with the local name of the
* required STARTELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a STARTELEMENT event. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectStartElement</span>
(<span class="type">int</span> <span class="variable-name">uriIndex</span>, <span class="type">String</span> <span class="variable-name">localName</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">STARTELEMENT</span>, uriIndex, localName, discardWhiteSpace);
}
<span class="comment">/**
* From the buffer get the next STARTELEMENT event from the fo: namespace
* with the given FO object type.
* Discard any other events preceding the
* STARTELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">foType</span><span class="comment"> - the <tt>int</tt> FO object type, as defined in
* <tt>FObjectNames</tt>.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a matching STARTELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getStartElement</span>(<span class="type">int</span> <span class="variable-name">foType</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">STARTELEMENT</span>, foType);
}
<span class="comment">/**
* From the buffer return the next STARTELEMENT event from the fo:
* namespace with the given FO object type. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">foType</span><span class="comment"> - the <tt>int</tt> FO object type, as defined in
* <tt>FObjectNames</tt>.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a matching STARTELEMENT event. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectStartElement</span>
(<span class="type">int</span> <span class="variable-name">foType</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">STARTELEMENT</span>, foType, discardWhiteSpace);
}
<span class="comment">/**
* Get one of a list of possible STARTELEMENT events.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="list">list</span><span class="comment"> a <tt>LinkedList</tt> containing either <tt>String</tt>s
* with the <tt>QName</tt>, or <tt>UriLocalName</tt>
* objects with the URI index and local name of one of the required
* STARTELEMENT events.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a STARTELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">getStartElement</span>
(<span class="type">LinkedList</span> <span class="variable-name">list</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">do</span> {
ev = expectStartElement(list, discardWhiteSpace);
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
<span class="comment">// The non-matching event has been pushed back.
</span> <span class="comment">// Get it and discard. Note that if the first attempt to
</span> <span class="comment">// getEvent() returns null, the expectStartElement() calls
</span> <span class="comment">// return null.
</span> ev = getEvent();
pool.surrenderEvent(ev);
} <span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span>);
<span class="comment">// Exit from this while loop is only by discovery of null event
</span> <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
("<span class="string">StartElement from list not found.</span>");
}
<span class="comment">/**
* Get one of a list of possible STARTELEMENT events.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">list</span><span class="comment"> a <tt>LinkedList</tt> containing either <tt>String</tt>s
* with the <tt>QName</tt>, or <tt>UriLocalName</tt>
* objects with the URI index and local name of one of the required
* STARTELEMENT events.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a STARTELEMENT event. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectStartElement</span>
(<span class="type">LinkedList</span> <span class="variable-name">list</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="type">Iterator</span> <span class="variable-name" id="elements">elements</span> = list.iterator();
<span class="keyword">while</span> (elements.hasNext()) {
<span class="type">Object</span> <span class="variable-name" id="o">o</span> = elements.next();
<span class="keyword">if</span> (o <span class="keyword">instanceof</span> <span class="type">String</span>) {
ev = expectStartElement((<span class="type">String</span>) o, discardWhiteSpace);
<span class="comment">// Found it!
</span> <span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
} <span class="keyword">else</span> <span class="keyword">if</span> (o <span class="keyword">instanceof</span> <span class="type">UriLocalName</span>) {
ev = expectStartElement
(((<span class="type">UriLocalName</span>) o).uriIndex,
((<span class="type">UriLocalName</span>) o).localName,
discardWhiteSpace);
<span class="comment">// Found it!
</span> <span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
} <span class="keyword">else</span> <span class="keyword">if</span> (o <span class="keyword">instanceof</span> <span class="type">Integer</span>) {
ev = expectStartElement(((<span class="type">Integer</span>)o).intValue(),
discardWhiteSpace);
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
} <span class="keyword">else</span>
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">FOPException</span>
("<span class="string">Invalid list elements for getStartElement</span>");
}
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
<span class="comment">/**
* Get one of a array of possible STARTELEMENT events. Scan and discard
* events until a STARTELEMENT event is found whose URI index and
* local name matches one of those in the argument
* <tt>UriLocalName[]</tt> array.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">list</span><span class="comment"> an array containing <tt>UriLocalName</tt>
* objects with the URI index and local name of
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* STARTELEMENT events, one of which is required.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the next matching STARTELEMENT event from the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">getStartElement</span>
(<span class="type">UriLocalName</span>[] <span class="variable-name">list</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">do</span> {
ev = expectStartElement(list, discardWhiteSpace);
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
<span class="comment">// The non-matching event has been pushed back.
</span> <span class="comment">// Get it and discard. Note that if the first attempt to
</span> <span class="comment">// getEvent() returns null, the expectStartElement() calls
</span> <span class="comment">// will throw a NoSuchElementException
</span> ev = getEvent();
pool.surrenderEvent(ev);
} <span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span>);
<span class="comment">// Exit from this while loop is only by discovery of null event
</span> <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
("<span class="string">StartElement from list not found.</span>");
}
<span class="comment">/**
* Expect one of an array of possible STARTELEMENT events. The next
* STARTELEMENT must have a URI index and local name which match
* an element of the argument <tt>UriLocalName[]</tt> list.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">list</span><span class="comment"> an <tt>UriLocalName[]</tt> array containing the
* namespace Uri index and LocalName
* of possible events, one of which must be the next returned.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the matching STARTELEMENT event. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectStartElement</span>
(<span class="type">UriLocalName</span>[] <span class="variable-name">list</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">for</span> (<span class="type">int</span> <span class="variable-name" id="i">i</span> = <span class="jde-java-font-lock-number">0</span>; i < list.length; i++) {
ev = expectStartElement(list[i].uriIndex,
list[i].localName,
discardWhiteSpace);
<span class="comment">// Found it!
</span> <span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
}
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
<span class="comment">/**
* Get one of a array of possible STARTELEMENT events. Scan and discard
* events until a STARTELEMENT event is found whose <tt>QName</tt>
* matches one of those in the argument <tt>String[]</tt> array.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">list</span><span class="comment"> a <tt>String[]</tt> array containing <tt>QName</tt>s,
* one of which is required.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the next matching STARTELEMENT event from the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getStartElement</span>(<span class="type">String</span>[] <span class="variable-name">list</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">do</span> {
ev = expectStartElement(list, discardWhiteSpace);
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
<span class="comment">// The non-matching event has been pushed back.
</span> <span class="comment">// Get it and discard. Note that if the first attempt to
</span> <span class="comment">// getEvent() returns null, the expectStartElement() calls
</span> <span class="comment">// will throw a NoSuchElementException
</span> ev = getEvent();
pool.surrenderEvent(ev);
} <span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span>);
<span class="comment">// Exit from this while loop is only by discovery of null event
</span> <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
("<span class="string">StartElement from array not found.</span>");
}
<span class="comment">/**
* Expect one of an array of possible STARTELEMENT events. The next
* STARTELEMENT must have a <tt>QName</tt> which matches an element
* of the argument <tt>String[]</tt> list.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">list</span><span class="comment"> a <tt>String[]</tt> array containing <tt>QName</tt>s
* of possible events, one of which must be the next returned.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the matching STARTELEMENT event.If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectStartElement</span>
(<span class="type">String</span>[] <span class="variable-name">list</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">for</span> (<span class="type">int</span> <span class="variable-name">i</span> = <span class="jde-java-font-lock-number">0</span>; i < list.length; i++) {
ev = expectStartElement(list[i], discardWhiteSpace);
<span class="comment">// Found it!
</span> <span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
}
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
<span class="comment">/**
* Get one of a array of possible STARTELEMENT events. Scan and discard
* events until a STARTELEMENT event is found which is in the fo:
* namespace and whose FO type matches one of those in the argument
* <tt>int</tt> array.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">list</span><span class="comment"> an <tt>int[]</tt> array containing FO types
* one of which is required.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the next matching STARTELEMENT event from the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getStartElement</span>(<span class="type">int</span>[] <span class="variable-name">list</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">do</span> {
ev = expectStartElement(list, discardWhiteSpace);
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
<span class="comment">// The non-matching event has been pushed back.
</span> <span class="comment">// Get it and discard. Note that if the first attempt to
</span> <span class="comment">// getEvent() returns null, the expectStartElement() calls
</span> <span class="comment">// will throw a NoSuchElementException
</span> ev = getEvent();
pool.surrenderEvent(ev);
} <span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span>);
<span class="comment">// Exit from this while loop is only by discovery of null event
</span> <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
("<span class="string">StartElement from array not found.</span>");
}
<span class="comment">/**
* Expect one of an array of possible STARTELEMENT events. The next
* STARTELEMENT must be in the fo: namespace, and must have an FO type
* which matches one of those in the argument <tt>int[]</tt> list.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">list</span><span class="comment"> a <tt>int[]</tt> array containing the FO types
* of possible events, one of which must be the next returned.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the matching STARTELEMENT event.If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectStartElement</span>
(<span class="type">int</span>[] <span class="variable-name">list</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">for</span> (<span class="type">int</span> <span class="variable-name">i</span> = <span class="jde-java-font-lock-number">0</span>; i < list.length; i++) {
ev = expectStartElement(list[i], discardWhiteSpace);
<span class="comment">// Found it!
</span> <span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
}
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
<span class="comment">/**
* Get one of a <tt>BitSet</tt> of possible STARTELEMENT events. Scan
* and discard events until a STARTELEMENT event is found which is in
* the fo: namespace and whose FO type matches one of those in the
* argument <tt>BitSet</tt>.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="set">set</span><span class="comment"> a <tt>BitSet</tt> containing FO types one of which is
* required.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the next matching STARTELEMENT event from the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getStartElement</span>(<span class="type">BitSet</span> <span class="variable-name">set</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">do</span> {
<span class="keyword">try</span> {
ev = expectStartElement(set, discardWhiteSpace);
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
<span class="comment">// The non-matching event has been pushed back.
</span> <span class="comment">// Get it and discard. Note that if the first attempt to
</span> <span class="comment">// getEvent() returns null, the expectStartElement() calls
</span> <span class="comment">// will throw a NoSuchElementException
</span> ev = getEvent();
pool.surrenderEvent(ev);
} <span class="keyword">catch</span>(<span class="type">UnexpectedStartElementException</span> <span class="variable-name">e</span>) {
ev = getEvent();
pool.surrenderEvent(ev);
}
} <span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span>);
<span class="comment">// Exit from this while loop is only by discovery of null event
</span> <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>
("<span class="string">StartElement from BitSet not found.</span>");
}
<span class="comment">/**
* Expect one of an <tt>BitSet</tt> of possible STARTELEMENT events.
* The next STARTELEMENT must be in the fo: namespace, and must have an
* FO type which matches one of those in the argument <tt>BitSet</tt>.
* <p>TODO:<br>
* This method should be retro-fitted to list and array versions.
*
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">set</span><span class="comment"> a <tt>BitSet</tt> containing the FO types
* of possible events, one of which must be the next returned.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the matching STARTELEMENT event.If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectStartElement</span>
(<span class="type">BitSet</span> <span class="variable-name">set</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>, <span class="type">UnexpectedStartElementException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
ev = expectTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">STARTELEMENT</span>, discardWhiteSpace);
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>) <span class="keyword">return</span> ev;
<span class="keyword">for</span> (<span class="type">int</span> <span class="variable-name">i</span> = set.nextSetBit(<span class="jde-java-font-lock-number">0</span>); i >= <span class="jde-java-font-lock-number">0</span>; i = set.nextSetBit(++i)) {
<span class="keyword">if</span> (ev.foType == i)
<span class="keyword">return</span> ev; <span class="comment">// Found it!
</span> }
<span class="comment">// Not found - push the STARTELEMENT event back and throw an
</span> <span class="comment">// UnexpectedStartElementException
</span> pushBack(ev);
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">UnexpectedStartElementException</span>
("<span class="string">Unexpected START element: </span>" + ev.getQName());
}
<span class="comment">/**
* Expect that the next element will be a STARTELEMENT for one of the
* flow objects which are members of %block; from
* <b></span><span class="jde-java-font-lock-bold">6.2 Formatting Object Content</span><span class="comment"></b>, including out-of-line flow
* objects which may occur except as descendents of out-of-line formatting
* objects. White space is discarded.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the <tt>FoXMLEvent found. If any other events are encountered
* return <tt>null</tt>.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectBlock">expectBlock</span>()
<span class="keyword">throws</span> <span class="type">FOPException</span>, <span class="type">UnexpectedStartElementException</span>
{
<span class="keyword">return</span> expectStartElement
(FObjectSets.blockEntity, XMLEvent.<span class="jde-java-font-lock-constant" id="DISCARD_W_SPACE">DISCARD_W_SPACE</span>);
}
<span class="comment">/**
* Expect that the next element will be a STARTELEMENT for one of the
* flow objects which are members of %block; from
* <b></span><span class="jde-java-font-lock-bold">6.2 Formatting Object Content</span><span class="comment"></b>, excluding out-of-line flow
* objects which may not occur as descendents of out-of-line formatting
* objects. White space is discarded.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the <tt>FoXMLEvent found. If any other events are encountered
* return <tt>null</tt>.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectOutOfLineBlock">expectOutOfLineBlock</span>()
<span class="keyword">throws</span> <span class="type">FOPException</span>, <span class="type">UnexpectedStartElementException</span>
{
<span class="keyword">return</span> expectStartElement
(FObjectSets.outOfLineBlockSet, XMLEvent.<span class="jde-java-font-lock-constant">DISCARD_W_SPACE</span>);
}
<span class="comment">/**
* Expect that the next element will be a STARTELEMENT for one of the
* flow objects which are members of (#PCDATA|%inline;) from
* <b></span><span class="jde-java-font-lock-bold">6.2 Formatting Object Content</span><span class="comment"></b>, including out-of-line flow
* objects which may occur except as descendents of out-of-line
* formatting objects. White space is retained, and
* will appear as #PCDATA, i.e, as an instance of FoCharacters.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the <tt>FoXMLEvent found. If any other events are encountered
* return <tt>null</tt>.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectPcdataOrInline">expectPcdataOrInline</span>()
<span class="keyword">throws</span> <span class="type">FOPException</span>, <span class="type">UnexpectedStartElementException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = expectStartElement
(FObjectSets.normalPcdataInlineSet, XMLEvent.<span class="jde-java-font-lock-constant" id="RETAIN_W_SPACE">RETAIN_W_SPACE</span>);
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
ev = expectCharacters();
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Expect that the next element will be a STARTELEMENT for one of the
* flow objects which are members of (#PCDATA|%inline;) from
* <b></span><span class="jde-java-font-lock-bold">6.2 Formatting Object Content</span><span class="comment"></b>, excluding out-of-line flow
* objects which may not occur as descendents of out-of-line formatting
* objects. White space is retained, and
* will appear as #PCDATA, i.e, as an instance of FoCharacters.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the <tt>FoXMLEvent found. If any other events are encountered
* return <tt>null</tt>.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectOutOfLinePcdataOrInline">expectOutOfLinePcdataOrInline</span>()
<span class="keyword">throws</span> <span class="type">FOPException</span>, <span class="type">UnexpectedStartElementException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = expectStartElement
(FObjectSets.inlineEntity, XMLEvent.<span class="jde-java-font-lock-constant">RETAIN_W_SPACE</span>);
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
ev = expectCharacters();
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Expect that the next element will be a STARTELEMENT for one of the
* flow objects which are members of (#PCDATA|%inline;|%block;) from
* <b></span><span class="jde-java-font-lock-bold">6.2 Formatting Object Content</span><span class="comment"></b>, including out-of-line flow
* objects which may occur except as descendents of out-of-line
* formatting objects. White space is retained, and
* will appear as #PCDATA, i.e, as an instance of FoCharacters.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the <tt>FoXMLEvent</tt> found. If any other events are
* encountered return <tt>null</tt>.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectPcdataOrInlineOrBlock">expectPcdataOrInlineOrBlock</span>()
<span class="keyword">throws</span> <span class="type">FOPException</span>, <span class="type">UnexpectedStartElementException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = expectStartElement
(FObjectSets.normalPcdataBlockInlineSet, XMLEvent.<span class="jde-java-font-lock-constant">RETAIN_W_SPACE</span>);
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
ev = expectCharacters();
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Expect that the next element will be a STARTELEMENT for one of the
* flow objects which are members of (#PCDATA|%inline;|%block;) from
* <b></span><span class="jde-java-font-lock-bold">6.2 Formatting Object Content</span><span class="comment"></b>, excluding out-of-line flow
* objects which may not occur as descendents of out-of-line formatting
* objects. White space is retained, and
* will appear as #PCDATA, i.e, as an instance of FoCharacters.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> the <tt>FoXMLEvent</tt> found. If any other events are
* encountered return <tt>null</tt>.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectOutOfLinePcdataOrInlineOrBlock">expectOutOfLinePcdataOrInlineOrBlock</span>()
<span class="keyword">throws</span> <span class="type">FOPException</span>, <span class="type">UnexpectedStartElementException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = expectStartElement
(FObjectSets.outOfLinePcdataBlockInlineSet,
XMLEvent.<span class="jde-java-font-lock-constant">RETAIN_W_SPACE</span>);
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>)
ev = expectCharacters();
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Get the next ENDELEMENT event from the buffer. Discard any other
* events preceding the ENDELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an ENDELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="getEndElement">getEndElement</span>() <span class="keyword">throws</span> <span class="type">FOPException</span> {
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant" id="ENDELEMENT">ENDELEMENT</span>);
}
<span class="comment">/**
* Return the next element if it is an ENDELEMENT. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a matching ENDELEMENT event. If the next
* event detected is not of the required type, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if ENDELEMENT is not the next
* event detected. The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectEndElement">expectEndElement</span>(<span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, discardWhiteSpace);
}
<span class="comment">/**
* Get the next ENDELEMENT event with the given <tt>QName</tt>
* from the buffer. Discard any other events preceding the
* ENDELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">qName</span><span class="comment"> a <tt>String</tt> with the <tt>QName</tt> of the
* required STARTELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an ENDELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getEndElement</span>(<span class="type">String</span> <span class="variable-name">qName</span>) <span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, qName);
}
<span class="comment">/**
* Return the next element if it is an ENDELEMENT with the given
* <tt>QName</tt>. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">qName</span><span class="comment"> a <tt>String</tt> with the <tt>QName</tt> of the
* required ENDELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an ENDELEMENT with the given qname. If the next
* event detected is not an ENDELEMENT, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">expectEndElement</span>(<span class="type">String</span> <span class="variable-name">qName</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, qName, discardWhiteSpace);
}
<span class="comment">/**
* Get the next ENDELEMENT event with the given URI index and local name
* from the buffer. Discard any other events preceding the
* ENDELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">uriIndex</span><span class="comment"> an <tt>int</tt> with the index of the URI of the
* required URI
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">localName</span><span class="comment"> a <tt>String</tt> with the local name of the
* required ENDELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an ENDELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getEndElement</span>(<span class="type">int</span> <span class="variable-name">uriIndex</span>, <span class="type">String</span> <span class="variable-name">localName</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, uriIndex, localName);
}
<span class="comment">/**
* Return the next element if it is an ENDELEMENT with the given
* URI index and local name. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">uriIndex</span><span class="comment"> an <tt>int</tt> with the index of the URI of the
* required URI
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">localName</span><span class="comment"> a <tt>String</tt> with the local name of the
* required ENDELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a matching ENDELEMENT event.
* If the next
* event detected is not an ENDELEMENT, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectEndElement</span>
(<span class="type">int</span> <span class="variable-name">uriIndex</span>, <span class="type">String</span> <span class="variable-name">localName</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, uriIndex, localName, discardWhiteSpace);
}
<span class="comment">/**
* Get the next ENDELEMENT event with the given Fo type
* from the buffer. Discard any other events preceding the
* ENDELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">foType</span><span class="comment"> - the FO type of the required ENDELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a matching ENDELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getEndElement</span>(<span class="type">int</span> <span class="variable-name">foType</span>) <span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, foType);
}
<span class="comment">/**
* Return the next element if it is an ENDELEMENT with the given
* FO type. If the next
* element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">foType</span><span class="comment"> - the FO type of the required ENDELEMENT
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a matching ENDELEMENT. If the next
* event detected is not an ENDELEMENT, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">expectEndElement</span>(<span class="type">int</span> <span class="variable-name">foType</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">return</span> expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, foType, discardWhiteSpace);
}
<span class="comment">/**
* Get the next ENDELEMENT event, with the same URI index and local name
* as the <tt>FoXMLEvent</tt> argument, from the buffer.
* Discard any other events preceding the ENDELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="event">event</span><span class="comment"> an <tt>FoXMLEvent</tt>. Only the uriIndex and the
* localName from the event are used. It is intended that the FoXMLEvent
* returned to the corresponding get/expectStartElement() call be used.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an ENDELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getEndElement</span>(<span class="type">FoXMLEvent</span> <span class="variable-name">event</span>) <span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">if</span> (event.foType != FObjectNames.<span class="jde-java-font-lock-constant" id="NO_FO">NO_FO</span>)
<span class="keyword">return</span> getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, event.foType);
<span class="keyword">return</span> getTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, event.uriIndex, event.localName);
}
<span class="comment">/**
* Return the next element if it is an ENDELEMENT with the same
* URI index and local name as the <tt>FoXMLEvent argument</tt>. If the
* next element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">event</span><span class="comment"> an <tt>FoXMLEvent</tt>. Only the uriIndex and the
* localName from the event are used. It is intended that the FoXMLEvent
* returned to the corresponding get/expectStartElement() call be used.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a matching ENDELEMENT event. If the next
* event detected is not an ENDELEMENT, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectEndElement</span>
(<span class="type">FoXMLEvent</span> <span class="variable-name">event</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="keyword">if</span> (event.foType != FObjectNames.<span class="jde-java-font-lock-constant">NO_FO</span>)
<span class="keyword">return</span> expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, event.foType, discardWhiteSpace);
<span class="keyword">return</span> expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, event.uriIndex, event.localName,
discardWhiteSpace);
}
<span class="comment">/**
* Get the next ENDELEMENT event, with the same URI index and local name
* as the <tt>FoXMLEvent</tt> argument, from the buffer.
* Discard any other events preceding the ENDELEMENT event.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="discardEvent">discardEvent</span><span class="comment"> the argument event may be discarded.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">event</span><span class="comment"> an <tt>FoXMLEvent</tt>. Only the uriIndex and the
* localName from the event are used. It is intended that the FoXMLEvent
* returned to the corresponding get/expectStartElement() call be used.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> an ENDELEMENT event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name">getEndElement</span>(<span class="type">boolean</span> <span class="variable-name">discardEvent</span>, <span class="type">FoXMLEvent</span> <span class="variable-name">event</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">if</span> (event.foType != FObjectNames.<span class="jde-java-font-lock-constant">NO_FO</span>)
ev = getTypedEvent(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, event.foType);
<span class="keyword">else</span>
ev = getTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, event.uriIndex, event.localName);
<span class="keyword">if</span> (discardEvent) {
<span class="comment">//System.out.println("discardEvent");
</span> pool.surrenderEvent(event);
}
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* Return the next element if it is an ENDELEMENT with the same
* URI index and local name as the <tt>FoXMLEvent argument</tt>. If the
* next element is not of the required type, push it back onto the buffer.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardEvent</span><span class="comment"> the argument event may be discarded.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">event</span><span class="comment"> an <tt>FoXMLEvent</tt>. Only the uriIndex and the
* localName from the event are used. It is intended that the FoXMLEvent
* returned to the corresponding get/expectStartElement() call be used.
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">discardWhiteSpace</span><span class="comment"> - if true, discard any <tt>characters</tt>
* events which contain only whitespace.
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a matching ENDELEMENT event. If the next
* event detected is not an ENDELEMENT, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="variable-name">expectEndElement</span>
(<span class="type">boolean</span> <span class="variable-name">discardEvent</span>, <span class="type">FoXMLEvent</span> <span class="variable-name">event</span>, <span class="type">boolean</span> <span class="variable-name">discardWhiteSpace</span>)
<span class="keyword">throws</span> <span class="type">FOPException</span>
{
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span>;
<span class="keyword">if</span> (event.foType != FObjectNames.<span class="jde-java-font-lock-constant">NO_FO</span>)
ev = expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, event.foType, discardWhiteSpace);
<span class="keyword">else</span>
ev = expectTypedEvent
(XMLEvent.<span class="jde-java-font-lock-constant">ENDELEMENT</span>, event.uriIndex, event.localName,
discardWhiteSpace);
<span class="keyword">if</span> (discardEvent)
pool.surrenderEvent(event);
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a CHARACTERS event
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if the event is not found
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="getCharacters">getCharacters</span>() <span class="keyword">throws</span> <span class="type">FOPException</span> {
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">while</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type != XMLEvent.<span class="jde-java-font-lock-constant">CHARACTERS</span>) {
pool.surrenderEvent(ev);
ev = getEvent();
}
<span class="keyword">if</span> (ev == <span class="jde-java-font-lock-constant">null</span>) {
<span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">NoSuchElementException</span>("<span class="string">Characters not found.</span>");
}
<span class="keyword">return</span> ev;
}
<span class="comment">/**
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> a CHARACTERS event. If the next event detected is not
* a CHARACTERS event, <tt>null</tt> is returned.
* The erroneous event is pushed back.
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">FOPException</span><span class="comment"> if buffer errors or interrupts occur
* </span><span class="jde-java-font-lock-doc-tag">@exception</span><span class="comment"> </span><span class="type">NoSuchElementException</span><span class="comment"> if end of buffer detected.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span class="type">FoXMLEvent</span> <span class="function-name" id="expectCharacters">expectCharacters</span>() <span class="keyword">throws</span> <span class="type">FOPException</span> {
<span class="type">FoXMLEvent</span> <span class="variable-name">ev</span> = getEvent();
<span class="keyword">if</span> (ev != <span class="jde-java-font-lock-constant">null</span> && ev.type == XMLEvent.<span class="jde-java-font-lock-constant">CHARACTERS</span>) {
<span class="keyword">return</span> ev;
}
pushBack(ev);
<span class="keyword">return</span> <span class="jde-java-font-lock-constant">null</span>;
}
}
</pre>
</body>
</html>
|
