Bug 849: Fixed NPE in Translated Data Change Events.
[controller.git] / third-party / org.openexi / nagasena / src / main / resources / doc / org / openexi / proc / io / Scanner.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
2 <!--NewPage-->\r
3 <HTML>\r
4 <HEAD>\r
5 <!-- Generated by javadoc (build 1.5.0_22) on Thu Apr 10 14:54:57 PDT 2014 -->\r
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">\r
7 <TITLE>\r
8 Scanner\r
9 </TITLE>\r
10 \r
11 <META NAME="keywords" CONTENT="org.openexi.proc.io.Scanner class">\r
12 \r
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">\r
14 \r
15 <SCRIPT type="text/javascript">\r
16 function windowTitle()\r
17 {\r
18     parent.document.title="Scanner";\r
19 }\r
20 </SCRIPT>\r
21 <NOSCRIPT>\r
22 </NOSCRIPT>\r
23 \r
24 </HEAD>\r
25 \r
26 <BODY BGCOLOR="white" onload="windowTitle();">\r
27 \r
28 \r
29 <!-- ========= START OF TOP NAVBAR ======= -->\r
30 <A NAME="navbar_top"><!-- --></A>\r
31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
33 <TR>\r
34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
35 <A NAME="navbar_top_firstrow"><!-- --></A>\r
36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
37   <TR ALIGN="center" VALIGN="top">\r
38   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
40   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
45   </TR>\r
46 </TABLE>\r
47 </TD>\r
48 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
49 </EM>\r
50 </TD>\r
51 </TR>\r
52 \r
53 <TR>\r
54 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
55 &nbsp;<A HREF="../../../../org/openexi/proc/io/CharacterBuffer.html" title="class in org.openexi.proc.io"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;NEXT CLASS</FONT></TD>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58   <A HREF="../../../../index.html?org/openexi/proc/io/Scanner.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="Scanner.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
60 &nbsp;<SCRIPT type="text/javascript">\r
61   <!--\r
62   if(window==top) {\r
63     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
64   }\r
65   //-->\r
66 </SCRIPT>\r
67 <NOSCRIPT>\r
68   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
69 </NOSCRIPT>\r
70 \r
71 \r
72 </FONT></TD>\r
73 </TR>\r
74 <TR>\r
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
76   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.openexi.proc.grammars.Apparatus">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
77 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
78 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
79 </TR>\r
80 </TABLE>\r
81 <A NAME="skip-navbar_top"></A>\r
82 <!-- ========= END OF TOP NAVBAR ========= -->\r
83 \r
84 <HR>\r
85 <!-- ======== START OF CLASS DATA ======== -->\r
86 <H2>\r
87 <FONT SIZE="-1">\r
88 org.openexi.proc.io</FONT>\r
89 <BR>\r
90 Class Scanner</H2>\r
91 <PRE>\r
92 java.lang.Object\r
93   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by ">org.openexi.proc.grammars.Apparatus\r
94       <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.proc.io.Scanner</B>\r
95 </PRE>\r
96 <HR>\r
97 <DL>\r
98 <DT><PRE>public abstract class <B>Scanner</B><DT>extends org.openexi.proc.grammars.Apparatus</DL>\r
99 </PRE>\r
100 \r
101 <P>\r
102 The Scanner class provides methods for scanning events 
103  in the body of an EXI stream.\r
104 <P>\r
105 \r
106 <P>\r
107 <DL>\r
108 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
109 </DL>\r
110 <HR>\r
111 \r
112 <P>\r
113 <!-- =========== FIELD SUMMARY =========== -->\r
114 \r
115 <A NAME="field_summary"><!-- --></A>\r
116 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
117 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
118 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
119 <B>Field Summary</B></FONT></TH>\r
120 </TR>\r
121 </TABLE>\r
122 &nbsp;<A NAME="fields_inherited_from_class_org.openexi.proc.grammars.Apparatus"><!-- --></A>\r
123 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
124 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
125 <TH ALIGN="left"><B>Fields inherited from class org.openexi.proc.grammars.Apparatus</B></TH>\r
126 </TR>\r
127 <TR BGCOLOR="white" CLASS="TableRowColor">\r
128 <TD><CODE>CODEC_BASE64BINARY, CODEC_BOOLEAN, CODEC_DATE, CODEC_DATETIME, CODEC_DECIMAL, CODEC_DOUBLE, CODEC_ENUMERATION, CODEC_GDAY, CODEC_GMONTH, CODEC_GMONTHDAY, CODEC_GYEAR, CODEC_GYEARMONTH, CODEC_HEXBINARY, CODEC_INTEGER, CODEC_LEXICAL, CODEC_LIST, CODEC_STRING, CODEC_TIME, currentState, eventTypesWorkSpace, schema, stringTable</CODE></TD>\r
129 </TR>\r
130 </TABLE>\r
131 &nbsp;\r
132 <!-- ========== METHOD SUMMARY =========== -->\r
133 \r
134 <A NAME="method_summary"><!-- --></A>\r
135 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
136 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
137 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
138 <B>Method Summary</B></FONT></TH>\r
139 </TR>\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
142 <CODE>&nbsp;void</CODE></FONT></TD>\r
143 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#closeInputStream()">closeInputStream</A></B>()</CODE>\r
144 \r
145 <BR>\r
146 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Close the input stream.</TD>\r
147 </TR>\r
148 <TR BGCOLOR="white" CLASS="TableRowColor">\r
149 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
150 <CODE>&nbsp;<A HREF="../../../../org/openexi/proc/common/EXIOptions.html" title="class in org.openexi.proc.common">EXIOptions</A></CODE></FONT></TD>\r
151 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#getHeaderOptions()">getHeaderOptions</A></B>()</CODE>\r
152 \r
153 <BR>\r
154 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the EXI Header options from the header of the
155  EXI stream, if present.</TD>\r
156 </TR>\r
157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
159 <CODE>abstract &nbsp;<A HREF="../../../../org/openexi/proc/common/EventDescription.html" title="interface in org.openexi.proc.common">EventDescription</A></CODE></FONT></TD>\r
160 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#nextEvent()">nextEvent</A></B>()</CODE>\r
161 \r
162 <BR>\r
163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the next event from the EXI stream.</TD>\r
164 </TR>\r
165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
166 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
167 <CODE>abstract &nbsp;void</CODE></FONT></TD>\r
168 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#setBinaryChunkSize(int)">setBinaryChunkSize</A></B>(int&nbsp;chunkSize)</CODE>\r
169 \r
170 <BR>\r
171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Binary values are read in chunks of the specified size when the
172  use of binary data is enabled.</TD>\r
173 </TR>\r
174 <TR BGCOLOR="white" CLASS="TableRowColor">\r
175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
176 <CODE>&nbsp;void</CODE></FONT></TD>\r
177 <TD><CODE><B><A HREF="../../../../org/openexi/proc/io/Scanner.html#setSchema(org.openexi.schema.EXISchema, org.openexi.proc.common.QName[], int)">setSchema</A></B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A>&nbsp;schema,\r
178           <A HREF="../../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[]&nbsp;dtrm,\r
179           int&nbsp;n_bindings)</CODE>\r
180 \r
181 <BR>\r
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
183 </TR>\r
184 </TABLE>\r
185 &nbsp;<A NAME="methods_inherited_from_class_org.openexi.proc.grammars.Apparatus"><!-- --></A>\r
186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
187 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
188 <TH ALIGN="left"><B>Methods inherited from class org.openexi.proc.grammars.Apparatus</B></TH>\r
189 </TR>\r
190 <TR BGCOLOR="white" CLASS="TableRowColor">\r
191 <TD><CODE>attribute, characters, endDocument, endElement, getAlignmentType, getNextEventCodes, getNextEventTypes, getPreserveLexicalValues, miscContent, nillify, reset, setPreserveLexicalValues, setStringTable, startDocument, startElement, startWildcardElement, undeclaredCharacters, wildcardAttribute, xsitp</CODE></TD>\r
192 </TR>\r
193 </TABLE>\r
194 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
195 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
196 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
197 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
198 </TR>\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">\r
200 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
201 </TR>\r
202 </TABLE>\r
203 &nbsp;\r
204 <P>\r
205 \r
206 <!-- ============ METHOD DETAIL ========== -->\r
207 \r
208 <A NAME="method_detail"><!-- --></A>\r
209 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
210 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
211 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
212 <B>Method Detail</B></FONT></TH>\r
213 </TR>\r
214 </TABLE>\r
215 \r
216 <A NAME="setSchema(org.openexi.schema.EXISchema, org.openexi.proc.common.QName[], int)"><!-- --></A><H3>\r
217 setSchema</H3>\r
218 <PRE>\r
219 public void <B>setSchema</B>(<A HREF="../../../../org/openexi/schema/EXISchema.html" title="class in org.openexi.schema">EXISchema</A>&nbsp;schema,\r
220                       <A HREF="../../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common">QName</A>[]&nbsp;dtrm,\r
221                       int&nbsp;n_bindings)</PRE>\r
222 <DL>\r
223 <DD><DL>\r
224 <DT><B>Overrides:</B><DD><CODE>setSchema</CODE> in class <CODE>org.openexi.proc.grammars.Apparatus</CODE></DL>\r
225 </DD>\r
226 <DD><DL>\r
227 </DL>\r
228 </DD>\r
229 </DL>\r
230 <HR>\r
231 \r
232 <A NAME="nextEvent()"><!-- --></A><H3>\r
233 nextEvent</H3>\r
234 <PRE>\r
235 public abstract <A HREF="../../../../org/openexi/proc/common/EventDescription.html" title="interface in org.openexi.proc.common">EventDescription</A> <B>nextEvent</B>()\r
236                                     throws java.io.IOException</PRE>\r
237 <DL>\r
238 <DD>Gets the next event from the EXI stream.\r
239 <P>\r
240 <DD><DL>\r
241 \r
242 <DT><B>Returns:</B><DD>EXIEvent\r
243 <DT><B>Throws:</B>\r
244 <DD><CODE>java.io.IOException</CODE></DL>\r
245 </DD>\r
246 </DL>\r
247 <HR>\r
248 \r
249 <A NAME="closeInputStream()"><!-- --></A><H3>\r
250 closeInputStream</H3>\r
251 <PRE>\r
252 public void <B>closeInputStream</B>()\r
253                       throws java.io.IOException</PRE>\r
254 <DL>\r
255 <DD>Close the input stream.\r
256 <P>\r
257 <DD><DL>\r
258 \r
259 <DT><B>Throws:</B>\r
260 <DD><CODE>java.io.IOException</CODE></DL>\r
261 </DD>\r
262 </DL>\r
263 <HR>\r
264 \r
265 <A NAME="getHeaderOptions()"><!-- --></A><H3>\r
266 getHeaderOptions</H3>\r
267 <PRE>\r
268 public final <A HREF="../../../../org/openexi/proc/common/EXIOptions.html" title="class in org.openexi.proc.common">EXIOptions</A> <B>getHeaderOptions</B>()</PRE>\r
269 <DL>\r
270 <DD>Returns the EXI Header options from the header of the
271  EXI stream, if present. Otherwise, returns null.\r
272 <P>\r
273 <DD><DL>\r
274 \r
275 <DT><B>Returns:</B><DD>EXIOptions or <i>null</i> if no header options are set.</DL>\r
276 </DD>\r
277 </DL>\r
278 <HR>\r
279 \r
280 <A NAME="setBinaryChunkSize(int)"><!-- --></A><H3>\r
281 setBinaryChunkSize</H3>\r
282 <PRE>\r
283 public abstract void <B>setBinaryChunkSize</B>(int&nbsp;chunkSize)</PRE>\r
284 <DL>\r
285 <DD>Binary values are read in chunks of the specified size when the
286  use of binary data is enabled.\r
287 <P>\r
288 <DD><DL>\r
289 <DT><B>Parameters:</B><DD><CODE>chunkSize</CODE> - </DL>\r
290 </DD>\r
291 </DL>\r
292 <!-- ========= END OF CLASS DATA ========= -->\r
293 <HR>\r
294 \r
295 \r
296 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
297 <A NAME="navbar_bottom"><!-- --></A>\r
298 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
299 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
300 <TR>\r
301 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
302 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
303 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
304   <TR ALIGN="center" VALIGN="top">\r
305   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
306   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
307   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
308   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
309   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
310   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
311   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
312   </TR>\r
313 </TABLE>\r
314 </TD>\r
315 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
316 </EM>\r
317 </TD>\r
318 </TR>\r
319 \r
320 <TR>\r
321 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
322 &nbsp;<A HREF="../../../../org/openexi/proc/io/CharacterBuffer.html" title="class in org.openexi.proc.io"><B>PREV CLASS</B></A>&nbsp;\r
323 &nbsp;NEXT CLASS</FONT></TD>\r
324 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
325   <A HREF="../../../../index.html?org/openexi/proc/io/Scanner.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
326 &nbsp;<A HREF="Scanner.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
327 &nbsp;<SCRIPT type="text/javascript">\r
328   <!--\r
329   if(window==top) {\r
330     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
331   }\r
332   //-->\r
333 </SCRIPT>\r
334 <NOSCRIPT>\r
335   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
336 </NOSCRIPT>\r
337 \r
338 \r
339 </FONT></TD>\r
340 </TR>\r
341 <TR>\r
342 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
343   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_org.openexi.proc.grammars.Apparatus">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
344 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
345 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
346 </TR>\r
347 </TABLE>\r
348 <A NAME="skip-navbar_bottom"></A>\r
349 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
350 \r
351 <HR>\r
352 \r
353 </BODY>\r
354 </HTML>\r