third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/HeaderOptionsOutputType.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:56 PDT 2014 -->\r
   6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">\r
   7 <TITLE>\r
   8 HeaderOptionsOutputType\r
   9 </TITLE>\r
  10 \r
  11 <META NAME="keywords" CONTENT="org.openexi.proc.HeaderOptionsOutputType 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="HeaderOptionsOutputType";\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/EXISchemaResolver.html" title="interface in org.openexi.proc"><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/HeaderOptionsOutputType.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  59 &nbsp;<A HREF="HeaderOptionsOutputType.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="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&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="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&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</FONT>\r
  89 <BR>\r
  90 Enum HeaderOptionsOutputType</H2>\r
  91 <PRE>\r
  92 java.lang.Object\r
  93   <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Enum&lt;<A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A>&gt;\r
  94       <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.openexi.proc.HeaderOptionsOutputType</B>\r
  95 </PRE>\r
  96 <DL>\r
  97 <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Comparable&lt;<A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A>&gt;</DD>\r
  98 </DL>\r
  99 <HR>\r
 100 <DL>\r
 101 <DT><PRE>public enum <B>HeaderOptionsOutputType</B><DT>extends java.lang.Enum&lt;<A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A>&gt;</DL>\r
 102 </PRE>\r
 103 \r
 104 <P>\r
 105 This enumeration provides three possible settings for header options output.
 106  <br /><br />
 107  <ul>
 108  <li><i>none</i> &ndash; Header options are not included in the header.
 109  The receiver of the document must have precise knowledge of the
 110  settings used to encode the document.<br /><br />
 111  </li>
 112  <li>
 113  <i>lessSchemaId</i> &ndash; Header options are present. Every
 114  setting used is written out in the header options, except SchemaID.
 115  The receiver of the document must know which schema is used to
 116  encode the document.<br /><br />
 117  </li>
 118  <li>
 119  <i>all</i> &ndash; All header options are present. Every setting
 120  used is written to the header options, including SchemaID.
 121  </li>
 122  </ul>\r
 123 <P>\r
 124 \r
 125 <P>\r
 126 <DL>\r
 127 <!-- yWorks UML Doclet   http://www.yworks.com/   b0ac8294d3f86ae0003f3a3a002ea3cf577df824efc6f2... -->
 128 </DL>\r
 129 <HR>\r
 130 \r
 131 <P>\r
 132 <!-- =========== ENUM CONSTANT SUMMARY =========== -->\r
 133 \r
 134 <A NAME="enum_constant_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>Enum Constant Summary</B></FONT></TH>\r
 139 </TR>\r
 140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 141 <TD><CODE><B><A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html#all">all</A></B></CODE>\r
 142 \r
 143 <BR>\r
 144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 145 </TR>\r
 146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 147 <TD><CODE><B><A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html#lessSchemaId">lessSchemaId</A></B></CODE>\r
 148 \r
 149 <BR>\r
 150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 151 </TR>\r
 152 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 153 <TD><CODE><B><A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html#none">none</A></B></CODE>\r
 154 \r
 155 <BR>\r
 156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 157 </TR>\r
 158 </TABLE>\r
 159 &nbsp;\r
 160 <!-- ========== METHOD SUMMARY =========== -->\r
 161 \r
 162 <A NAME="method_summary"><!-- --></A>\r
 163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 164 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 165 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 166 <B>Method Summary</B></FONT></TH>\r
 167 </TR>\r
 168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 170 <CODE>static&nbsp;<A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A></CODE></FONT></TD>\r
 171 <TD><CODE><B><A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String&nbsp;name)</CODE>\r
 172 \r
 173 <BR>\r
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the enum constant of this type with the specified name.</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;<A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A>[]</CODE></FONT></TD>\r
 179 <TD><CODE><B><A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html#values()">values</A></B>()</CODE>\r
 180 \r
 181 <BR>\r
 182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the constants of this enum type, in
 183 the order they're declared.</TD>\r
 184 </TR>\r
 185 </TABLE>\r
 186 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A>\r
 187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 188 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 189 <TH ALIGN="left"><B>Methods inherited from class java.lang.Enum</B></TH>\r
 190 </TR>\r
 191 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 192 <TD><CODE>compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD>\r
 193 </TR>\r
 194 </TABLE>\r
 195 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 197 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 198 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 199 </TR>\r
 200 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 201 <TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>\r
 202 </TR>\r
 203 </TABLE>\r
 204 &nbsp;\r
 205 <P>\r
 206 \r
 207 <!-- ============ ENUM CONSTANT DETAIL =========== -->\r
 208 \r
 209 <A NAME="enum_constant_detail"><!-- --></A>\r
 210 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 211 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 212 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 213 <B>Enum Constant Detail</B></FONT></TH>\r
 214 </TR>\r
 215 </TABLE>\r
 216 \r
 217 <A NAME="none"><!-- --></A><H3>\r
 218 none</H3>\r
 219 <PRE>\r
 220 public static final <A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A> <B>none</B></PRE>\r
 221 <DL>\r
 222 <DL>\r
 223 </DL>\r
 224 </DL>\r
 225 <HR>\r
 226 \r
 227 <A NAME="lessSchemaId"><!-- --></A><H3>\r
 228 lessSchemaId</H3>\r
 229 <PRE>\r
 230 public static final <A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A> <B>lessSchemaId</B></PRE>\r
 231 <DL>\r
 232 <DL>\r
 233 </DL>\r
 234 </DL>\r
 235 <HR>\r
 236 \r
 237 <A NAME="all"><!-- --></A><H3>\r
 238 all</H3>\r
 239 <PRE>\r
 240 public static final <A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A> <B>all</B></PRE>\r
 241 <DL>\r
 242 <DL>\r
 243 </DL>\r
 244 </DL>\r
 245 \r
 246 <!-- ============ METHOD DETAIL ========== -->\r
 247 \r
 248 <A NAME="method_detail"><!-- --></A>\r
 249 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 250 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 251 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 252 <B>Method Detail</B></FONT></TH>\r
 253 </TR>\r
 254 </TABLE>\r
 255 \r
 256 <A NAME="values()"><!-- --></A><H3>\r
 257 values</H3>\r
 258 <PRE>\r
 259 public static final <A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A>[] <B>values</B>()</PRE>\r
 260 <DL>\r
 261 <DD>Returns an array containing the constants of this enum type, in
 262 the order they're declared.  This method may be used to iterate
 263 over the constants as follows:
 264 <pre>
 265 for(HeaderOptionsOutputType c : HeaderOptionsOutputType.values())
 266         System.out.println(c);
 267 </pre>\r
 268 <P>\r
 269 <DD><DL>\r
 270 \r
 271 <DT><B>Returns:</B><DD>an array containing the constants of this enum type, in
 272 the order they're declared</DL>\r
 273 </DD>\r
 274 </DL>\r
 275 <HR>\r
 276 \r
 277 <A NAME="valueOf(java.lang.String)"><!-- --></A><H3>\r
 278 valueOf</H3>\r
 279 <PRE>\r
 280 public static <A HREF="../../../org/openexi/proc/HeaderOptionsOutputType.html" title="enum in org.openexi.proc">HeaderOptionsOutputType</A> <B>valueOf</B>(java.lang.String&nbsp;name)</PRE>\r
 281 <DL>\r
 282 <DD>Returns the enum constant of this type with the specified name.
 283 The string must match <I>exactly</I> an identifier used to declare an
 284 enum constant in this type.  (Extraneous whitespace characters are
 285 not permitted.)\r
 286 <P>\r
 287 <DD><DL>\r
 288 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned.\r
 289 <DT><B>Returns:</B><DD>the enum constant with the specified name\r
 290 <DT><B>Throws:</B>\r
 291 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant
 292 with the specified name</DL>\r
 293 </DD>\r
 294 </DL>\r
 295 <!-- ========= END OF CLASS DATA ========= -->\r
 296 <HR>\r
 297 \r
 298 \r
 299 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 300 <A NAME="navbar_bottom"><!-- --></A>\r
 301 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 302 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 303 <TR>\r
 304 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 305 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 306 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 307   <TR ALIGN="center" VALIGN="top">\r
 308   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 309   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 310   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 311   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 312   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 313   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 314   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 315   </TR>\r
 316 </TABLE>\r
 317 </TD>\r
 318 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 319 </EM>\r
 320 </TD>\r
 321 </TR>\r
 322 \r
 323 <TR>\r
 324 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 325 &nbsp;<A HREF="../../../org/openexi/proc/EXISchemaResolver.html" title="interface in org.openexi.proc"><B>PREV CLASS</B></A>&nbsp;\r
 326 &nbsp;NEXT CLASS</FONT></TD>\r
 327 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 328   <A HREF="../../../index.html?org/openexi/proc/HeaderOptionsOutputType.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 329 &nbsp;<A HREF="HeaderOptionsOutputType.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 330 &nbsp;<SCRIPT type="text/javascript">\r
 331   <!--\r
 332   if(window==top) {\r
 333     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 334   }\r
 335   //-->\r
 336 </SCRIPT>\r
 337 <NOSCRIPT>\r
 338   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 339 </NOSCRIPT>\r
 340 \r
 341 \r
 342 </FONT></TD>\r
 343 </TR>\r
 344 <TR>\r
 345 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 346   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#enum_constant_summary">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 347 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 348 DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 349 </TR>\r
 350 </TABLE>\r
 351 <A NAME="skip-navbar_bottom"></A>\r
 352 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 353 \r
 354 <HR>\r
 355 \r
 356 </BODY>\r
 357 </HTML>\r