Home | History | Annotate | Download | only in html
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
      2 <!--NewPage-->
      3 <HTML>
      4 <HEAD>
      5 <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
      6 <TITLE>
      7 HtmlTextEscapingMode (OWASP Java HTML Sanitizer)
      8 </TITLE>
      9 
     10 
     11 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
     12 
     13 <SCRIPT type="text/javascript">
     14 function windowTitle()
     15 {
     16     if (location.href.indexOf('is-external=true') == -1) {
     17         parent.document.title="HtmlTextEscapingMode (OWASP Java HTML Sanitizer)";
     18     }
     19 }
     20 </SCRIPT>
     21 <NOSCRIPT>
     22 </NOSCRIPT>
     23 
     24 </HEAD>
     25 
     26 <BODY BGCOLOR="white" onload="windowTitle();">
     27 <HR>
     28 
     29 
     30 <!-- ========= START OF TOP NAVBAR ======= -->
     31 <A NAME="navbar_top"><!-- --></A>
     32 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
     33 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
     34 <TR>
     35 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
     36 <A NAME="navbar_top_firstrow"><!-- --></A>
     37 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
     38   <TR ALIGN="center" VALIGN="top">
     39   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
     40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
     41   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
     42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HtmlTextEscapingMode.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
     43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
     44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
     45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
     46   </TR>
     47 </TABLE>
     48 </TD>
     49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
     50 <a href="http://code.google.com/p/owasp-java-html-sanitizer" target=_top>code.google.com home</a></EM>
     51 </TD>
     52 </TR>
     53 
     54 <TR>
     55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     56 &nbsp;<A HREF="../../../org/owasp/html/HtmlStreamRenderer.html" title="class in org.owasp.html"><B>PREV CLASS</B></A>&nbsp;
     57 &nbsp;<A HREF="../../../org/owasp/html/PolicyFactory.html" title="class in org.owasp.html"><B>NEXT CLASS</B></A></FONT></TD>
     58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
     59   <A HREF="../../../index.html?org/owasp/html/HtmlTextEscapingMode.html" target="_top"><B>FRAMES</B></A>  &nbsp;
     60 &nbsp;<A HREF="HtmlTextEscapingMode.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
     61 &nbsp;<SCRIPT type="text/javascript">
     62   <!--
     63   if(window==top) {
     64     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
     65   }
     66   //-->
     67 </SCRIPT>
     68 <NOSCRIPT>
     69   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
     70 </NOSCRIPT>
     71 
     72 
     73 </FONT></TD>
     74 </TR>
     75 <TR>
     76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     77   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>
     78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
     79 DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
     80 </TR>
     81 </TABLE>
     82 <A NAME="skip-navbar_top"></A>
     83 <!-- ========= END OF TOP NAVBAR ========= -->
     84 
     85 <HR>
     86 <!-- ======== START OF CLASS DATA ======== -->
     87 <H2>
     88 <FONT SIZE="-1">
     89 org.owasp.html</FONT>
     90 <BR>
     91 Enum HtmlTextEscapingMode</H2>
     92 <PRE>
     93 java.lang.Object
     94   <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">java.lang.Enum&lt;<A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A>&gt;
     95       <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.owasp.html.HtmlTextEscapingMode</B>
     96 </PRE>
     97 <DL>
     98 <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.Comparable&lt;<A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A>&gt;</DD>
     99 </DL>
    100 <HR>
    101 <DL>
    102 <DT><PRE>public enum <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.54"><B>HtmlTextEscapingMode</B></A><DT>extends java.lang.Enum&lt;<A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A>&gt;</DL>
    103 </PRE>
    104 
    105 <P>
    106 From section 8.1.2.6 of http://www.whatwg.org/specs/web-apps/current-work/
    107  <p>
    108  The text in CDATA and RCDATA elements must not contain any
    109  occurrences of the string "</" (U+003C LESS-THAN SIGN, U+002F
    110  SOLIDUS) followed by characters that case-insensitively match the
    111  tag name of the element followed by one of U+0009 CHARACTER
    112  TABULATION, U+000A LINE FEED (LF), U+000B LINE TABULATION, U+000C
    113  FORM FEED (FF), U+0020 SPACE, U+003E GREATER-THAN SIGN (>), or
    114  U+002F SOLIDUS (/), unless that string is part of an escaping
    115  text span.
    116  </p>
    117 
    118  <p>
    119  See also
    120  http://www.whatwg.org/specs/web-apps/current-work/#cdata-rcdata-restrictions
    121  for the elements which fall in each category.
    122  </p>
    123 <P>
    124 
    125 <P>
    126 <DL>
    127 <DT><B>Author:</B></DT>
    128   <DD>Mike Samuel <mikesamuel (a] gmail.com></DD>
    129 </DL>
    130 <HR>
    131 
    132 <P>
    133 <!-- =========== ENUM CONSTANT SUMMARY =========== -->
    134 
    135 <A NAME="enum_constant_summary"><!-- --></A>
    136 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    137 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    138 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    139 <B>Enum Constant Summary</B></FONT></TH>
    140 </TR>
    141 <TR BGCOLOR="white" CLASS="TableRowColor">
    142 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#CDATA">CDATA</A></B></CODE>
    143 
    144 <BR>
    145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A span of text where HTML special characters are interpreted literally,
    146  as in a SCRIPT tag.</TD>
    147 </TR>
    148 <TR BGCOLOR="white" CLASS="TableRowColor">
    149 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#CDATA_SOMETIMES">CDATA_SOMETIMES</A></B></CODE>
    150 
    151 <BR>
    152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Like <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#CDATA"><CODE>CDATA</CODE></A> but only for certain browsers.</TD>
    153 </TR>
    154 <TR BGCOLOR="white" CLASS="TableRowColor">
    155 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#PCDATA">PCDATA</A></B></CODE>
    156 
    157 <BR>
    158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Normally escaped character data that breaks around comments and tags.</TD>
    159 </TR>
    160 <TR BGCOLOR="white" CLASS="TableRowColor">
    161 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#PLAIN_TEXT">PLAIN_TEXT</A></B></CODE>
    162 
    163 <BR>
    164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A span of text where HTML special characters are interpreted literally,
    165  where there is no end tag.</TD>
    166 </TR>
    167 <TR BGCOLOR="white" CLASS="TableRowColor">
    168 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#RCDATA">RCDATA</A></B></CODE>
    169 
    170 <BR>
    171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A span of text and character entity references where HTML special
    172  characters are interpreted literally, as in a TITLE tag.</TD>
    173 </TR>
    174 <TR BGCOLOR="white" CLASS="TableRowColor">
    175 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#VOID">VOID</A></B></CODE>
    176 
    177 <BR>
    178 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Cannot contain data.</TD>
    179 </TR>
    180 </TABLE>
    181 &nbsp;
    182 <!-- ========== METHOD SUMMARY =========== -->
    183 
    184 <A NAME="method_summary"><!-- --></A>
    185 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    186 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    187 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
    188 <B>Method Summary</B></FONT></TH>
    189 </TR>
    190 <TR BGCOLOR="white" CLASS="TableRowColor">
    191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    192 <CODE>static&nbsp;boolean</CODE></FONT></TD>
    193 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#allowsEscapingTextSpan(java.lang.String)">allowsEscapingTextSpan</A></B>(java.lang.String&nbsp;canonTagName)</CODE>
    194 
    195 <BR>
    196 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True iff the content following the given tag allows escaping text
    197  spans: <code>&lt;!--&amp;hellip;--&gt;</code> that escape even things that might
    198  be an end tag for the corresponding open tag.</TD>
    199 </TR>
    200 <TR BGCOLOR="white" CLASS="TableRowColor">
    201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    202 <CODE>static&nbsp;<A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A></CODE></FONT></TD>
    203 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#getModeForTag(java.lang.String)">getModeForTag</A></B>(java.lang.String&nbsp;canonTagName)</CODE>
    204 
    205 <BR>
    206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The mode used for content following a start tag with the given name.</TD>
    207 </TR>
    208 <TR BGCOLOR="white" CLASS="TableRowColor">
    209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    210 <CODE>static&nbsp;boolean</CODE></FONT></TD>
    211 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#isTagFollowedByLiteralContent(java.lang.String)">isTagFollowedByLiteralContent</A></B>(java.lang.String&nbsp;canonTagName)</CODE>
    212 
    213 <BR>
    214 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True if content immediately following the start tag must be treated as
    215  special CDATA so that &lt;'s are not treated as starting tags, comments
    216  or directives.</TD>
    217 </TR>
    218 <TR BGCOLOR="white" CLASS="TableRowColor">
    219 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    220 <CODE>static&nbsp;boolean</CODE></FONT></TD>
    221 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#isVoidElement(java.lang.String)">isVoidElement</A></B>(java.lang.String&nbsp;canonTagName)</CODE>
    222 
    223 <BR>
    224 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True iff the tag cannot contain any content -- will an HTML parser consider
    225  the element to have ended immediately after the start tag.</TD>
    226 </TR>
    227 <TR BGCOLOR="white" CLASS="TableRowColor">
    228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    229 <CODE>static&nbsp;<A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A></CODE></FONT></TD>
    230 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#valueOf(java.lang.String)">valueOf</A></B>(java.lang.String&nbsp;name)</CODE>
    231 
    232 <BR>
    233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the enum constant of this type with the specified name.</TD>
    234 </TR>
    235 <TR BGCOLOR="white" CLASS="TableRowColor">
    236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
    237 <CODE>static&nbsp;<A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A>[]</CODE></FONT></TD>
    238 <TD><CODE><B><A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#values()">values</A></B>()</CODE>
    239 
    240 <BR>
    241 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array containing the constants of this enum type, in
    242 the order they are declared.</TD>
    243 </TR>
    244 </TABLE>
    245 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Enum"><!-- --></A>
    246 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    247 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    248 <TH ALIGN="left"><B>Methods inherited from class java.lang.Enum</B></TH>
    249 </TR>
    250 <TR BGCOLOR="white" CLASS="TableRowColor">
    251 <TD><CODE>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf</CODE></TD>
    252 </TR>
    253 </TABLE>
    254 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
    255 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    256 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
    257 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
    258 </TR>
    259 <TR BGCOLOR="white" CLASS="TableRowColor">
    260 <TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
    261 </TR>
    262 </TABLE>
    263 &nbsp;
    264 <P>
    265 
    266 <!-- ============ ENUM CONSTANT DETAIL =========== -->
    267 
    268 <A NAME="enum_constant_detail"><!-- --></A>
    269 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    270 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    271 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    272 <B>Enum Constant Detail</B></FONT></TH>
    273 </TR>
    274 </TABLE>
    275 
    276 <A NAME="PCDATA"><!-- --></A><H3>
    277 PCDATA</H3>
    278 <PRE>
    279 public static final <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A> <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.58"><B>PCDATA</B></A></PRE>
    280 <DL>
    281 <DD>Normally escaped character data that breaks around comments and tags.
    282 <P>
    283 <DL>
    284 </DL>
    285 </DL>
    286 <HR>
    287 
    288 <A NAME="CDATA"><!-- --></A><H3>
    289 CDATA</H3>
    290 <PRE>
    291 public static final <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A> <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.63"><B>CDATA</B></A></PRE>
    292 <DL>
    293 <DD>A span of text where HTML special characters are interpreted literally,
    294  as in a SCRIPT tag.
    295 <P>
    296 <DL>
    297 </DL>
    298 </DL>
    299 <HR>
    300 
    301 <A NAME="CDATA_SOMETIMES"><!-- --></A><H3>
    302 CDATA_SOMETIMES</H3>
    303 <PRE>
    304 public static final <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A> <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.67"><B>CDATA_SOMETIMES</B></A></PRE>
    305 <DL>
    306 <DD>Like <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html#CDATA"><CODE>CDATA</CODE></A> but only for certain browsers.
    307 <P>
    308 <DL>
    309 </DL>
    310 </DL>
    311 <HR>
    312 
    313 <A NAME="RCDATA"><!-- --></A><H3>
    314 RCDATA</H3>
    315 <PRE>
    316 public static final <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A> <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.72"><B>RCDATA</B></A></PRE>
    317 <DL>
    318 <DD>A span of text and character entity references where HTML special
    319  characters are interpreted literally, as in a TITLE tag.
    320 <P>
    321 <DL>
    322 </DL>
    323 </DL>
    324 <HR>
    325 
    326 <A NAME="PLAIN_TEXT"><!-- --></A><H3>
    327 PLAIN_TEXT</H3>
    328 <PRE>
    329 public static final <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A> <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.77"><B>PLAIN_TEXT</B></A></PRE>
    330 <DL>
    331 <DD>A span of text where HTML special characters are interpreted literally,
    332  where there is no end tag.  PLAIN_TEXT runs until the end of the file.
    333 <P>
    334 <DL>
    335 </DL>
    336 </DL>
    337 <HR>
    338 
    339 <A NAME="VOID"><!-- --></A><H3>
    340 VOID</H3>
    341 <PRE>
    342 public static final <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A> <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.82"><B>VOID</B></A></PRE>
    343 <DL>
    344 <DD>Cannot contain data.
    345 <P>
    346 <DL>
    347 </DL>
    348 </DL>
    349 
    350 <!-- ============ METHOD DETAIL ========== -->
    351 
    352 <A NAME="method_detail"><!-- --></A>
    353 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
    354 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
    355 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
    356 <B>Method Detail</B></FONT></TH>
    357 </TR>
    358 </TABLE>
    359 
    360 <A NAME="values()"><!-- --></A><H3>
    361 values</H3>
    362 <PRE>
    363 public static <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A>[] <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.34"><B>values</B></A>()</PRE>
    364 <DL>
    365 <DD>Returns an array containing the constants of this enum type, in
    366 the order they are declared.  This method may be used to iterate
    367 over the constants as follows:
    368 <pre>
    369 for (HtmlTextEscapingMode c : HtmlTextEscapingMode.values())
    370 &nbsp;   System.out.println(c);
    371 </pre>
    372 <P>
    373 <DD><DL>
    374 
    375 <DT><B>Returns:</B><DD>an array containing the constants of this enum type, in
    376 the order they are declared</DL>
    377 </DD>
    378 </DL>
    379 <HR>
    380 
    381 <A NAME="valueOf(java.lang.String)"><!-- --></A><H3>
    382 valueOf</H3>
    383 <PRE>
    384 public static <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A> <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.34"><B>valueOf</B></A>(java.lang.String&nbsp;name)</PRE>
    385 <DL>
    386 <DD>Returns the enum constant of this type with the specified name.
    387 The string must match <I>exactly</I> an identifier used to declare an
    388 enum constant in this type.  (Extraneous whitespace characters are 
    389 not permitted.)
    390 <P>
    391 <DD><DL>
    392 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the enum constant to be returned.
    393 <DT><B>Returns:</B><DD>the enum constant with the specified name
    394 <DT><B>Throws:</B>
    395 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if this enum type has no constant
    396 with the specified name
    397 <DD><CODE>java.lang.NullPointerException</CODE> - if the argument is null</DL>
    398 </DD>
    399 </DL>
    400 <HR>
    401 
    402 <A NAME="getModeForTag(java.lang.String)"><!-- --></A><H3>
    403 getModeForTag</H3>
    404 <PRE>
    405 public static <A HREF="../../../org/owasp/html/HtmlTextEscapingMode.html" title="enum in org.owasp.html">HtmlTextEscapingMode</A> <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.140"><B>getModeForTag</B></A>(java.lang.String&nbsp;canonTagName)</PRE>
    406 <DL>
    407 <DD>The mode used for content following a start tag with the given name.
    408 <P>
    409 <DD><DL>
    410 </DL>
    411 </DD>
    412 </DL>
    413 <HR>
    414 
    415 <A NAME="allowsEscapingTextSpan(java.lang.String)"><!-- --></A><H3>
    416 allowsEscapingTextSpan</H3>
    417 <PRE>
    418 public static boolean <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.150"><B>allowsEscapingTextSpan</B></A>(java.lang.String&nbsp;canonTagName)</PRE>
    419 <DL>
    420 <DD>True iff the content following the given tag allows escaping text
    421  spans: <code>&lt;!--&amp;hellip;--&gt;</code> that escape even things that might
    422  be an end tag for the corresponding open tag.
    423 <P>
    424 <DD><DL>
    425 </DL>
    426 </DD>
    427 </DL>
    428 <HR>
    429 
    430 <A NAME="isTagFollowedByLiteralContent(java.lang.String)"><!-- --></A><H3>
    431 isTagFollowedByLiteralContent</H3>
    432 <PRE>
    433 public static boolean <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.162"><B>isTagFollowedByLiteralContent</B></A>(java.lang.String&nbsp;canonTagName)</PRE>
    434 <DL>
    435 <DD>True if content immediately following the start tag must be treated as
    436  special CDATA so that &lt;'s are not treated as starting tags, comments
    437  or directives.
    438 <P>
    439 <DD><DL>
    440 </DL>
    441 </DD>
    442 </DL>
    443 <HR>
    444 
    445 <A NAME="isVoidElement(java.lang.String)"><!-- --></A><H3>
    446 isVoidElement</H3>
    447 <PRE>
    448 public static boolean <A HREF="../../../src-html/org/owasp/html/HtmlTextEscapingMode.html#line.171"><B>isVoidElement</B></A>(java.lang.String&nbsp;canonTagName)</PRE>
    449 <DL>
    450 <DD>True iff the tag cannot contain any content -- will an HTML parser consider
    451  the element to have ended immediately after the start tag.
    452 <P>
    453 <DD><DL>
    454 </DL>
    455 </DD>
    456 </DL>
    457 <!-- ========= END OF CLASS DATA ========= -->
    458 <HR>
    459 
    460 
    461 <!-- ======= START OF BOTTOM NAVBAR ====== -->
    462 <A NAME="navbar_bottom"><!-- --></A>
    463 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
    464 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
    465 <TR>
    466 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
    467 <A NAME="navbar_bottom_firstrow"><!-- --></A>
    468 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
    469   <TR ALIGN="center" VALIGN="top">
    470   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
    471   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
    472   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
    473   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/HtmlTextEscapingMode.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
    474   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
    475   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
    476   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
    477   </TR>
    478 </TABLE>
    479 </TD>
    480 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
    481 <a href="http://code.google.com/p/owasp-java-html-sanitizer" target=_top>code.google.com home</a></EM>
    482 </TD>
    483 </TR>
    484 
    485 <TR>
    486 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    487 &nbsp;<A HREF="../../../org/owasp/html/HtmlStreamRenderer.html" title="class in org.owasp.html"><B>PREV CLASS</B></A>&nbsp;
    488 &nbsp;<A HREF="../../../org/owasp/html/PolicyFactory.html" title="class in org.owasp.html"><B>NEXT CLASS</B></A></FONT></TD>
    489 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
    490   <A HREF="../../../index.html?org/owasp/html/HtmlTextEscapingMode.html" target="_top"><B>FRAMES</B></A>  &nbsp;
    491 &nbsp;<A HREF="HtmlTextEscapingMode.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
    492 &nbsp;<SCRIPT type="text/javascript">
    493   <!--
    494   if(window==top) {
    495     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
    496   }
    497   //-->
    498 </SCRIPT>
    499 <NOSCRIPT>
    500   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
    501 </NOSCRIPT>
    502 
    503 
    504 </FONT></TD>
    505 </TR>
    506 <TR>
    507 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    508   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>
    509 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
    510 DETAIL:&nbsp;<A HREF="#enum_constant_detail">ENUM CONSTANTS</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
    511 </TR>
    512 </TABLE>
    513 <A NAME="skip-navbar_bottom"></A>
    514 <!-- ======== END OF BOTTOM NAVBAR ======= -->
    515 
    516 <HR>
    517 
    518 </BODY>
    519 </HTML>
    520