Package org.owasp.html

Class Encoding

java.lang.Object

org.owasp.html.Encoding

public final class Encoding
extends java.lang.Object

Encoders and decoders for HTML.

Constructor Summary

Constructors

Constructor	Description
Encoding()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	decodeHtml(java.lang.String s)	Decodes HTML entities to produce a string containing only valid Unicode scalar values.
static void	encodeRcdataOnto(java.lang.String plainText, java.lang.Appendable output)	Appends an encoded form of plainText to putput where the encoding is sufficient to prevent an HTML parser from transitioning out of the RCDATA state.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Encoding

public Encoding()

Method Detail

decodeHtml

public static java.lang.String decodeHtml(java.lang.String s)

Decodes HTML entities to produce a string containing only valid Unicode scalar values.

Parameters:

s - text/html

Returns:

text/plain

encodeRcdataOnto

public static void encodeRcdataOnto(java.lang.String plainText,
                                    java.lang.Appendable output)
                             throws java.io.IOException

Appends an encoded form of plainText to putput where the encoding is sufficient to prevent an HTML parser from transitioning out of the RCDATA state. This is suitable for encoding a text node inside a <textarea> or <title> element outside foreign content.

Parameters:

plainText - text/plain

output - a buffer of text/html that has a well-formed HTML prefix that would leave an HTML parser in the Data state if it were to encounter a space character as the next character. In practice this means that the buffer does not contain partial tags or comments, and the most recently opened element is `` or `<title>` and that element is still open.</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.io.IOException</code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../org/owasp/html/package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/Encoding.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../index-all.html">Index</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../org/owasp/html/ElementPolicy.Util.html" title="class in org.owasp.html"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../org/owasp/html/FilterUrlByProtocolAttributePolicy.html" title="class in org.owasp.html"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../index.html?org/owasp/html/Encoding.html" target="_top">Frames</a></li> <li><a href="Encoding.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2019 <a href="https://owasp.org">OWASP</a>. All rights reserved.</small></p> </body> </html>