IDNA.html   [plain text]


<?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>IDNA</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.IDNA class"/><meta name="keywords" content="ACE_PREFIX"/><meta name="keywords" content="toASCII()"/><meta name="keywords" content="toUnicode()"/><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/DecompositionMappings.html">Prev Class</a> | <a href="../../../gnu/inet/encoding/IDNAException.html">Next Class</a></td><td class="navi"><a href="../../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="IDNA.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | Constr</td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <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 IDNA</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.IDNA</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">IDNA</b></code></div><div class="class synopsis superclass"><code>extends java.lang.Object</code></div></div><hr/><div class="class description"> Copyright (C) 2004, 2005, 2006, 2007  Free Software Foundation, Inc.

 Author: Oliver Hitz

 This file is part of GNU Libidn.

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public License
 as published by the Free Software Foundation; either version 2.1 of
 the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
 USA
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field 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="#ACE_PREFIX">ACE_PREFIX</a></code></dt></dl></td></tr></table></dd></dl><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="#toASCII(String)">toASCII</a>(String&nbsp;input)</code></dt><dd class="description"> Converts a Unicode string to ASCII using the procedure in RFC3490
 section 4.1.</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="#toASCII(String,boolean,boolean)">toASCII</a>(String&nbsp;input, boolean&nbsp;allowUnassigned, boolean&nbsp;useSTD3ASCIIRules)</code></dt><dd class="description"> Converts a Unicode string to ASCII using the procedure in RFC3490
 section 4.1.</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="#toUnicode(String)">toUnicode</a>(String&nbsp;input)</code></dt><dd class="description"> Converts an ASCII-encoded string to Unicode.</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="#toUnicode(String,boolean,boolean)">toUnicode</a>(String&nbsp;input, boolean&nbsp;allowUnassigned, boolean&nbsp;useSTD3ASCIIRules)</code></dt><dd class="description"> Converts an ASCII-encoded string to Unicode.</dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="ACE_PREFIX" id="ACE_PREFIX"/><div class="member detail outer"><h3 class="member detail name">ACE_PREFIX</h3><pre class="member detail synopsis">public static final String ACE_PREFIX</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="toASCII(String)" id="toASCII(String)"/><div class="member detail outer"><h3 class="member detail name">toASCII</h3><pre class="member detail synopsis">public static String toASCII(String input)
            throws <a href="../../../gnu/inet/encoding/IDNAException.html" title="Class in gnu.inet.encoding">IDNAException</a></pre><blockquote class="member detail name"><div class="member detail description"> Converts a Unicode string to ASCII using the procedure in RFC3490
 section 4.1. Unassigned characters are not allowed and STD3 ASCII
 rules are enforced. The input string may be a domain name
 containing dots.
</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">Unicode string.</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">Encoded string.</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="toASCII(String,boolean,boolean)" id="toASCII(String,boolean,boolean)"/><div class="member detail outer"><h3 class="member detail name">toASCII</h3><pre class="member detail synopsis">public static String toASCII(String input,
                             boolean allowUnassigned,
                             boolean useSTD3ASCIIRules)
            throws <a href="../../../gnu/inet/encoding/IDNAException.html" title="Class in gnu.inet.encoding">IDNAException</a></pre><blockquote class="member detail name"><div class="member detail description"> Converts a Unicode string to ASCII using the procedure in RFC3490
 section 4.1. Unassigned characters are not allowed and STD3 ASCII
 rules are enforced.
</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">Unicode string.</span></dd><dd class="item"><code class="name">allowUnassigned</code><span class="separator"> - </span><span class="description">Unassigned characters, allowed or not?</span></dd><dd class="item"><code class="name">useSTD3ASCIIRules</code><span class="separator"> - </span><span class="description">STD3 ASCII rules, enforced or not?</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">Encoded string.</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="toUnicode(String)" id="toUnicode(String)"/><div class="member detail outer"><h3 class="member detail name">toUnicode</h3><pre class="member detail synopsis">public static String toUnicode(String input)</pre><blockquote class="member detail name"><div class="member detail description"> Converts an ASCII-encoded string to Unicode. Unassigned
 characters are not allowed and STD3 hostnames are enforced. Input
 may be domain name containing dots.
</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">ASCII input string.</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">Unicode string.</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="toUnicode(String,boolean,boolean)" id="toUnicode(String,boolean,boolean)"/><div class="member detail outer"><h3 class="member detail name">toUnicode</h3><pre class="member detail synopsis">public static String toUnicode(String input,
                               boolean allowUnassigned,
                               boolean useSTD3ASCIIRules)</pre><blockquote class="member detail name"><div class="member detail description"> Converts an ASCII-encoded string to Unicode.
</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">ASCII input string.</span></dd><dd class="item"><code class="name">allowUnassigned</code><span class="separator"> - </span><span class="description">Allow unassigned Unicode characters.</span></dd><dd class="item"><code class="name">useSTD3ASCIIRules</code><span class="separator"> - </span><span class="description">Check that the output conforms to STD3.</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">Unicode string.</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>