<?xml version="1.0" encoding="US-ASCII"?> <!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>Stringprep</title><script src="../../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="gnu.inet.encoding.Stringprep class"/><meta name="keywords" content="nameprep()"/><meta name="keywords" content="nodeprep()"/><meta name="keywords" content="resourceprep()"/><link rel="stylesheet" type="text/css" href="../../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../../gnu/inet/encoding/package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../../../gnu/inet/encoding/RFC3454.html">Prev Class</a> | <a href="../../../gnu/inet/encoding/StringprepException.html">Next Class</a></td><td class="navi"><a href="../../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="Stringprep.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | Field | <a href="#summary-methods">Method</a> | Constr</td><td class="navi">Detail: Nested | Field | <a href="#detail-methods">Method</a> | Constr</td></tr></table><div class="class title outer"><h3 class="class title-package">gnu.inet.encoding</h3><h1 class="class title-class">Class Stringprep</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code>java.lang.Object</code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>gnu.inet.encoding.Stringprep</code></li><li></li></ul></li></ul></div><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">Stringprep</b></code></div><div class="class synopsis superclass"><code>extends java.lang.Object</code></div></div><hr/><div class="class description"> This class offers static methods for preparing internationalized strings. It supports the following stringprep profiles: <ul><li>RFC3491 nameprep </li><li>RFC3920 XMPP nodeprep and resourceprep </li></ul> Note that this implementation only supports 16-bit Unicode code points. </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#nameprep(String)">nameprep</a>(String input)</code></dt><dd class="description"> Preps a name according to the Stringprep profile defined in RFC3491.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#nameprep(String,boolean)">nameprep</a>(String input, boolean allowUnassigned)</code></dt><dd class="description"> Preps a name according to the Stringprep profile defined in RFC3491.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#nodeprep(String)">nodeprep</a>(String input)</code></dt><dd class="description"> Preps a node name according to the Stringprep profile defined in RFC3920.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#nodeprep(String,boolean)">nodeprep</a>(String input, boolean allowUnassigned)</code></dt><dd class="description"> Preps a node name according to the Stringprep profile defined in RFC3920.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#resourceprep(String)">resourceprep</a>(String input)</code></dt><dd class="description"> Preps a resource name according to the Stringprep profile defined in RFC3920.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">static String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#resourceprep(String,boolean)">resourceprep</a>(String input, boolean allowUnassigned)</code></dt><dd class="description"> Preps a resource name according to the Stringprep profile defined in RFC3920.</dd></dl></td></tr></table></dd></dl><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="nameprep(String)" id="nameprep(String)"/><div class="member detail outer"><h3 class="member detail name">nameprep</h3><pre class="member detail synopsis">public static String nameprep(String input) throws <a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a>, NullPointerException</pre><blockquote class="member detail name"><div class="member detail description"> Preps a name according to the Stringprep profile defined in RFC3491. Unassigned code points are not allowed. </div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">input</code><span class="separator"> - </span><span class="description">the name to prep.</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">the prepped name.</dd></dl></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Throws:</b></dt><dd class="member detail thrown item"><code class="name"><a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a></code><span class="separator"> - </span><span class="description">If the name cannot be prepped with this profile.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="nameprep(String,boolean)" id="nameprep(String,boolean)"/><div class="member detail outer"><h3 class="member detail name">nameprep</h3><pre class="member detail synopsis">public static String nameprep(String input, boolean allowUnassigned) throws <a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a>, NullPointerException</pre><blockquote class="member detail name"><div class="member detail description"> Preps a name according to the Stringprep profile defined in RFC3491. </div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">input</code><span class="separator"> - </span><span class="description">the name to prep.</span></dd><dd class="item"><code class="name">allowUnassigned</code><span class="separator"> - </span><span class="description">true if the name may contain unassigned code points.</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">the prepped name.</dd></dl></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Throws:</b></dt><dd class="member detail thrown item"><code class="name"><a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a></code><span class="separator"> - </span><span class="description">If the name cannot be prepped with this profile.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="nodeprep(String)" id="nodeprep(String)"/><div class="member detail outer"><h3 class="member detail name">nodeprep</h3><pre class="member detail synopsis">public static String nodeprep(String input) throws <a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a>, NullPointerException</pre><blockquote class="member detail name"><div class="member detail description"> Preps a node name according to the Stringprep profile defined in RFC3920. Unassigned code points are not allowed. </div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">input</code><span class="separator"> - </span><span class="description">the node name to prep.</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">the prepped node name.</dd></dl></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Throws:</b></dt><dd class="member detail thrown item"><code class="name"><a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a></code><span class="separator"> - </span><span class="description">If the node name cannot be prepped with this profile.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="nodeprep(String,boolean)" id="nodeprep(String,boolean)"/><div class="member detail outer"><h3 class="member detail name">nodeprep</h3><pre class="member detail synopsis">public static String nodeprep(String input, boolean allowUnassigned) throws <a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a>, NullPointerException</pre><blockquote class="member detail name"><div class="member detail description"> Preps a node name according to the Stringprep profile defined in RFC3920. </div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">input</code><span class="separator"> - </span><span class="description">the node name to prep.</span></dd><dd class="item"><code class="name">allowUnassigned</code><span class="separator"> - </span><span class="description">true if the node name may contain unassigned code points.</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">the prepped node name.</dd></dl></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Throws:</b></dt><dd class="member detail thrown item"><code class="name"><a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a></code><span class="separator"> - </span><span class="description">If the node name cannot be prepped with this profile.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="resourceprep(String)" id="resourceprep(String)"/><div class="member detail outer"><h3 class="member detail name">resourceprep</h3><pre class="member detail synopsis">public static String resourceprep(String input) throws <a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a>, NullPointerException</pre><blockquote class="member detail name"><div class="member detail description"> Preps a resource name according to the Stringprep profile defined in RFC3920. Unassigned code points are not allowed. </div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">input</code><span class="separator"> - </span><span class="description">the resource name to prep.</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">the prepped node name.</dd></dl></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Throws:</b></dt><dd class="member detail thrown item"><code class="name"><a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a></code><span class="separator"> - </span><span class="description">If the resource name cannot be prepped with this profile.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="resourceprep(String,boolean)" id="resourceprep(String,boolean)"/><div class="member detail outer"><h3 class="member detail name">resourceprep</h3><pre class="member detail synopsis">public static String resourceprep(String input, boolean allowUnassigned) throws <a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a>, NullPointerException</pre><blockquote class="member detail name"><div class="member detail description"> Preps a resource name according to the Stringprep profile defined in RFC3920. </div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">input</code><span class="separator"> - </span><span class="description">the resource name to prep.</span></dd><dd class="item"><code class="name">allowUnassigned</code><span class="separator"> - </span><span class="description">true if the resource name may contain unassigned code points.</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">the prepped node name.</dd></dl></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Throws:</b></dt><dd class="member detail thrown item"><code class="name"><a href="../../../gnu/inet/encoding/StringprepException.html" title="Class in gnu.inet.encoding">StringprepException</a></code><span class="separator"> - </span><span class="description">If the resource name cannot be prepped with this profile.</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../../gnu/inet/encoding/package-summary.html">Package</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../about.html">About</a></span></div></td></tr></table></body></html>