7ea6e13a8c03929ea6886af4bce2b75a8b4993cf
[controller.git] / third-party / org.openexi / nagasena / src / main / resources / doc / org / openexi / proc / common / GrammarOptions.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 GrammarOptions\r
9 </TITLE>\r
10 \r
11 <META NAME="keywords" CONTENT="org.openexi.proc.common.GrammarOptions 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="GrammarOptions";\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/common/EXIOptions.html" title="class in org.openexi.proc.common"><B>PREV CLASS</B></A>&nbsp;\r
56 &nbsp;<A HREF="../../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common"><B>NEXT CLASS</B></A></FONT></TD>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58   <A HREF="../../../../index.html?org/openexi/proc/common/GrammarOptions.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
59 &nbsp;<A HREF="GrammarOptions.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="#field_summary">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;<A HREF="#field_detail">FIELD</A>&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.common</FONT>\r
89 <BR>\r
90 Class GrammarOptions</H2>\r
91 <PRE>\r
92 java.lang.Object\r
93   <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.proc.common.GrammarOptions</B>\r
94 </PRE>\r
95 <HR>\r
96 <DL>\r
97 <DT><PRE>public final class <B>GrammarOptions</B><DT>extends java.lang.Object</DL>\r
98 </PRE>\r
99 \r
100 <P>\r
101 GrammarOptions computes a short integer that represents settings in the EXI Grammar settings
102  that determine how an EXI file will be encoded or decoded.
103 <br/><br/>
104  Values are set using binary switch values (represented as short integers).
105  <br /><br />
106  If no options have been set, the value is 0 (this is an temporary internal
107  value, rather than a valid setting).
108  <br/><br/>
109  If an XSD is available, and the file to be processed is 100% compatible with the XSD, choosing
110  STRICT_OPTIONS (1) provides the best performance. No other options can be set 
111  when files are encoded or decoded in strict mode.
112  <br/><br/>
113  The DEFAULT_OPTIONS setting is 2. The following table lists all of the options and their values. 
114  <br/><br/>
115  <table align="center" border="1" cellpadding="3" width="640"><tr>
116  <th>Constant</th><th>Value</th>
117  </tr><tr>
118  <td>STRICT_OPTIONS</td><td>1</td>
119  </tr><tr>
120  <td>DEFAULT_OPTIONS</td><td>2</td>
121  </tr><tr><td>
122  ADD_NS</td><td>4
123  </td></tr><tr><td>
124  ADD_SC</td><td>N/A*
125  </td></tr><tr><td>
126  ADD_DTD</td><td>16
127  </td></tr><tr><td>
128  ADD_CM</td><td>32
129  </td></tr><tr><td>
130  ADD_PI</td><td>64
131  </td></tr>
132  <tr><td colspan="2">*The self-contained option is not supported in this release.
133  </td></tr>
134  </table>
135  <br/><br/>
136  The value of DEFAULT_OPTIONS is 2. When you pass the options variable to an add[??] method, 
137  the binary switch value is added to the current value of the options variable.  
138  The sum of all additional switches becomes a concise list of the selected options. 
139  <br/><br/>
140  For example, if you preserve comments and processing instructions, the total is
141  98 (2 + 32 + 64). The bitwise options are set correctly, because there is one and only one 
142  combination of options that sums up to 98.
143  <br/><br/>
144  If your application uses the same options every time, you can hard code the numeric value 
145  as a short integer and use it to create your GrammarCache. For example:
146  <pre>
147  GrammarCache gc = new GrammarCache((EXISchema)null,98);
148  </pre>
149  Be careful to use the correct numeric value, to avoid unexpected results.\r
150 <P>\r
151 \r
152 <P>\r
153 <DL>\r
154 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
155 </DL>\r
156 <HR>\r
157 \r
158 <P>\r
159 <!-- =========== FIELD SUMMARY =========== -->\r
160 \r
161 <A NAME="field_summary"><!-- --></A>\r
162 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
163 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
164 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
165 <B>Field Summary</B></FONT></TH>\r
166 </TR>\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
169 <CODE>static&nbsp;short</CODE></FONT></TD>\r
170 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#DEFAULT_OPTIONS">DEFAULT_OPTIONS</A></B></CODE>\r
171 \r
172 <BR>\r
173 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates that undeclared elements and attributes will be 
174  processed when the XML stream is encoded and decoded.</TD>\r
175 </TR>\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
178 <CODE>static&nbsp;short</CODE></FONT></TD>\r
179 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#OPTIONS_UNUSED">OPTIONS_UNUSED</A></B></CODE>\r
180 \r
181 <BR>\r
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;OPTIONS_UNUSED is an internal value.</TD>\r
183 </TR>\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
186 <CODE>static&nbsp;short</CODE></FONT></TD>\r
187 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#STRICT_OPTIONS">STRICT_OPTIONS</A></B></CODE>\r
188 \r
189 <BR>\r
190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates that undeclared elements and attributes will throw an
191  exception when the XML stream is encoded and decoded.</TD>\r
192 </TR>\r
193 </TABLE>\r
194 &nbsp;\r
195 <!-- ========== METHOD SUMMARY =========== -->\r
196 \r
197 <A NAME="method_summary"><!-- --></A>\r
198 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
199 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
200 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
201 <B>Method Summary</B></FONT></TH>\r
202 </TR>\r
203 <TR BGCOLOR="white" CLASS="TableRowColor">\r
204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
205 <CODE>static&nbsp;short</CODE></FONT></TD>\r
206 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#addCM(short)">addCM</A></B>(short&nbsp;options)</CODE>\r
207 \r
208 <BR>\r
209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets Preserve Comments to <i>true</i>.</TD>\r
210 </TR>\r
211 <TR BGCOLOR="white" CLASS="TableRowColor">\r
212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
213 <CODE>static&nbsp;short</CODE></FONT></TD>\r
214 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#addDTD(short)">addDTD</A></B>(short&nbsp;options)</CODE>\r
215 \r
216 <BR>\r
217 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets Preserve Document Type Definition to <i>true</i>.</TD>\r
218 </TR>\r
219 <TR BGCOLOR="white" CLASS="TableRowColor">\r
220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
221 <CODE>static&nbsp;short</CODE></FONT></TD>\r
222 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#addNS(short)">addNS</A></B>(short&nbsp;options)</CODE>\r
223 \r
224 <BR>\r
225 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets Preserve Namespaces to <i>true</i>.</TD>\r
226 </TR>\r
227 <TR BGCOLOR="white" CLASS="TableRowColor">\r
228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
229 <CODE>static&nbsp;short</CODE></FONT></TD>\r
230 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#addPI(short)">addPI</A></B>(short&nbsp;options)</CODE>\r
231 \r
232 <BR>\r
233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets Preserve Processing Instructions to <i>true</i>.</TD>\r
234 </TR>\r
235 <TR BGCOLOR="white" CLASS="TableRowColor">\r
236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
237 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
238 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#hasCM(short)">hasCM</A></B>(short&nbsp;options)</CODE>\r
239 \r
240 <BR>\r
241 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <i>true</i> if Preserve Comments is true.</TD>\r
242 </TR>\r
243 <TR BGCOLOR="white" CLASS="TableRowColor">\r
244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
245 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
246 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#hasDTD(short)">hasDTD</A></B>(short&nbsp;options)</CODE>\r
247 \r
248 <BR>\r
249 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <i>true</i> if Preserve Document Type Definition is true.</TD>\r
250 </TR>\r
251 <TR BGCOLOR="white" CLASS="TableRowColor">\r
252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
253 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
254 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#hasNS(short)">hasNS</A></B>(short&nbsp;options)</CODE>\r
255 \r
256 <BR>\r
257 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <i>true</i> if Preserve Namespaces is true.</TD>\r
258 </TR>\r
259 <TR BGCOLOR="white" CLASS="TableRowColor">\r
260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
261 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
262 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#hasPI(short)">hasPI</A></B>(short&nbsp;options)</CODE>\r
263 \r
264 <BR>\r
265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <i>true</i> if Preserve Processing Instructions is true.</TD>\r
266 </TR>\r
267 <TR BGCOLOR="white" CLASS="TableRowColor">\r
268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
269 <CODE>static&nbsp;boolean</CODE></FONT></TD>\r
270 <TD><CODE><B><A HREF="../../../../org/openexi/proc/common/GrammarOptions.html#isPermitDeviation(short)">isPermitDeviation</A></B>(short&nbsp;options)</CODE>\r
271 \r
272 <BR>\r
273 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <i>true</i> if DEFAULT_OPTIONS is set to true.</TD>\r
274 </TR>\r
275 </TABLE>\r
276 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
277 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
278 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
279 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
280 </TR>\r
281 <TR BGCOLOR="white" CLASS="TableRowColor">\r
282 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
283 </TR>\r
284 </TABLE>\r
285 &nbsp;\r
286 <P>\r
287 \r
288 <!-- ============ FIELD DETAIL =========== -->\r
289 \r
290 <A NAME="field_detail"><!-- --></A>\r
291 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
292 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
293 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
294 <B>Field Detail</B></FONT></TH>\r
295 </TR>\r
296 </TABLE>\r
297 \r
298 <A NAME="OPTIONS_UNUSED"><!-- --></A><H3>\r
299 OPTIONS_UNUSED</H3>\r
300 <PRE>\r
301 public static final short <B>OPTIONS_UNUSED</B></PRE>\r
302 <DL>\r
303 <DD>OPTIONS_UNUSED is an internal value.
304  It indicates that the grammar options value has not yet been set.\r
305 <P>\r
306 <DL>\r
307 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.GrammarOptions.OPTIONS_UNUSED">Constant Field Values</A></DL>\r
308 </DL>\r
309 <HR>\r
310 \r
311 <A NAME="DEFAULT_OPTIONS"><!-- --></A><H3>\r
312 DEFAULT_OPTIONS</H3>\r
313 <PRE>\r
314 public static final short <B>DEFAULT_OPTIONS</B></PRE>\r
315 <DL>\r
316 <DD>Indicates that undeclared elements and attributes will be 
317  processed when the XML stream is encoded and decoded.\r
318 <P>\r
319 <DL>\r
320 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.GrammarOptions.DEFAULT_OPTIONS">Constant Field Values</A></DL>\r
321 </DL>\r
322 <HR>\r
323 \r
324 <A NAME="STRICT_OPTIONS"><!-- --></A><H3>\r
325 STRICT_OPTIONS</H3>\r
326 <PRE>\r
327 public static final short <B>STRICT_OPTIONS</B></PRE>\r
328 <DL>\r
329 <DD>Indicates that undeclared elements and attributes will throw an
330  exception when the XML stream is encoded and decoded. When 
331  STRICT_OPTIONS is set, all other Grammar Options are ignored.\r
332 <P>\r
333 <DL>\r
334 <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.openexi.proc.common.GrammarOptions.STRICT_OPTIONS">Constant Field Values</A></DL>\r
335 </DL>\r
336 \r
337 <!-- ============ METHOD DETAIL ========== -->\r
338 \r
339 <A NAME="method_detail"><!-- --></A>\r
340 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
341 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
342 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
343 <B>Method Detail</B></FONT></TH>\r
344 </TR>\r
345 </TABLE>\r
346 \r
347 <A NAME="isPermitDeviation(short)"><!-- --></A><H3>\r
348 isPermitDeviation</H3>\r
349 <PRE>\r
350 public static boolean <B>isPermitDeviation</B>(short&nbsp;options)</PRE>\r
351 <DL>\r
352 <DD>Returns <i>true</i> if DEFAULT_OPTIONS is set to true.\r
353 <P>\r
354 <DD><DL>\r
355 </DL>\r
356 </DD>\r
357 </DL>\r
358 <HR>\r
359 \r
360 <A NAME="hasNS(short)"><!-- --></A><H3>\r
361 hasNS</H3>\r
362 <PRE>\r
363 public static boolean <B>hasNS</B>(short&nbsp;options)</PRE>\r
364 <DL>\r
365 <DD>Returns <i>true</i> if Preserve Namespaces is true.\r
366 <P>\r
367 <DD><DL>\r
368 </DL>\r
369 </DD>\r
370 </DL>\r
371 <HR>\r
372 \r
373 <A NAME="hasDTD(short)"><!-- --></A><H3>\r
374 hasDTD</H3>\r
375 <PRE>\r
376 public static boolean <B>hasDTD</B>(short&nbsp;options)</PRE>\r
377 <DL>\r
378 <DD>Returns <i>true</i> if Preserve Document Type Definition is true.\r
379 <P>\r
380 <DD><DL>\r
381 </DL>\r
382 </DD>\r
383 </DL>\r
384 <HR>\r
385 \r
386 <A NAME="hasCM(short)"><!-- --></A><H3>\r
387 hasCM</H3>\r
388 <PRE>\r
389 public static boolean <B>hasCM</B>(short&nbsp;options)</PRE>\r
390 <DL>\r
391 <DD>Returns <i>true</i> if Preserve Comments is true.\r
392 <P>\r
393 <DD><DL>\r
394 </DL>\r
395 </DD>\r
396 </DL>\r
397 <HR>\r
398 \r
399 <A NAME="hasPI(short)"><!-- --></A><H3>\r
400 hasPI</H3>\r
401 <PRE>\r
402 public static boolean <B>hasPI</B>(short&nbsp;options)</PRE>\r
403 <DL>\r
404 <DD>Returns <i>true</i> if Preserve Processing Instructions is true.\r
405 <P>\r
406 <DD><DL>\r
407 </DL>\r
408 </DD>\r
409 </DL>\r
410 <HR>\r
411 \r
412 <A NAME="addNS(short)"><!-- --></A><H3>\r
413 addNS</H3>\r
414 <PRE>\r
415 public static short <B>addNS</B>(short&nbsp;options)</PRE>\r
416 <DL>\r
417 <DD>Sets Preserve Namespaces to <i>true</i>. (Adds 4 to the <i>options</i> value.)\r
418 <P>\r
419 <DD><DL>\r
420 \r
421 <DT><B>Returns:</B><DD>the new <i>options</i> short integer value</DL>\r
422 </DD>\r
423 </DL>\r
424 <HR>\r
425 \r
426 <A NAME="addDTD(short)"><!-- --></A><H3>\r
427 addDTD</H3>\r
428 <PRE>\r
429 public static short <B>addDTD</B>(short&nbsp;options)</PRE>\r
430 <DL>\r
431 <DD>Sets Preserve Document Type Definition to <i>true</i>. (Adds 16 to the <i>options</i> value.)\r
432 <P>\r
433 <DD><DL>\r
434 \r
435 <DT><B>Returns:</B><DD>the new <i>options</i> short integer value</DL>\r
436 </DD>\r
437 </DL>\r
438 <HR>\r
439 \r
440 <A NAME="addCM(short)"><!-- --></A><H3>\r
441 addCM</H3>\r
442 <PRE>\r
443 public static short <B>addCM</B>(short&nbsp;options)</PRE>\r
444 <DL>\r
445 <DD>Sets Preserve Comments to <i>true</i>. (Adds 32 to the <i>options</i> value.)\r
446 <P>\r
447 <DD><DL>\r
448 \r
449 <DT><B>Returns:</B><DD>the new <i>options</i> short integer value</DL>\r
450 </DD>\r
451 </DL>\r
452 <HR>\r
453 \r
454 <A NAME="addPI(short)"><!-- --></A><H3>\r
455 addPI</H3>\r
456 <PRE>\r
457 public static short <B>addPI</B>(short&nbsp;options)</PRE>\r
458 <DL>\r
459 <DD>Sets Preserve Processing Instructions to <i>true</i>. (Adds 64 to the <i>options</i> value.)\r
460 <P>\r
461 <DD><DL>\r
462 \r
463 <DT><B>Returns:</B><DD>the new <i>options</i> short integer value</DL>\r
464 </DD>\r
465 </DL>\r
466 <!-- ========= END OF CLASS DATA ========= -->\r
467 <HR>\r
468 \r
469 \r
470 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
471 <A NAME="navbar_bottom"><!-- --></A>\r
472 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
473 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
474 <TR>\r
475 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
476 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
477 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
478   <TR ALIGN="center" VALIGN="top">\r
479   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
480   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
481   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
482   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
483   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
484   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
485   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
486   </TR>\r
487 </TABLE>\r
488 </TD>\r
489 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
490 </EM>\r
491 </TD>\r
492 </TR>\r
493 \r
494 <TR>\r
495 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
496 &nbsp;<A HREF="../../../../org/openexi/proc/common/EXIOptions.html" title="class in org.openexi.proc.common"><B>PREV CLASS</B></A>&nbsp;\r
497 &nbsp;<A HREF="../../../../org/openexi/proc/common/QName.html" title="class in org.openexi.proc.common"><B>NEXT CLASS</B></A></FONT></TD>\r
498 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
499   <A HREF="../../../../index.html?org/openexi/proc/common/GrammarOptions.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
500 &nbsp;<A HREF="GrammarOptions.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
501 &nbsp;<SCRIPT type="text/javascript">\r
502   <!--\r
503   if(window==top) {\r
504     document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
505   }\r
506   //-->\r
507 </SCRIPT>\r
508 <NOSCRIPT>\r
509   <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
510 </NOSCRIPT>\r
511 \r
512 \r
513 </FONT></TD>\r
514 </TR>\r
515 <TR>\r
516 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
517   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
518 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
519 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
520 </TR>\r
521 </TABLE>\r
522 <A NAME="skip-navbar_bottom"></A>\r
523 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
524 \r
525 <HR>\r
526 \r
527 </BODY>\r
528 </HTML>\r