Charset.java revision 16ad3f07e7ec41d6709d10c71112ff1c077be4e5
151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Copyright (c) 2000, 2010, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.nio.charset; 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 289a9f76d1e161f37b3d83d2db94ea63298d221bdfPiotr Jastrzebskiimport java.io.UnsupportedEncodingException; 29133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebskiimport libcore.icu.NativeConverter; 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.nio.ByteBuffer; 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.nio.CharBuffer; 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.nio.charset.spi.CharsetProvider; 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.AccessController; 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.AccessControlException; 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.PrivilegedAction; 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Collections; 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.HashSet; 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Iterator; 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Locale; 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Map; 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.NoSuchElementException; 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Set; 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.ServiceLoader; 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.ServiceConfigurationError; 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.SortedMap; 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.TreeMap; 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.misc.ASCIICaseInsensitiveComparator; 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.nio.cs.ThreadLocalCoders; 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.security.action.GetPropertyAction; 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A named mapping between sequences of sixteen-bit Unicode <a 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="../../lang/Character.html#unicode">code units</a> and sequences of 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bytes. This class defines methods for creating decoders and encoders and 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for retrieving the various names associated with a charset. Instances of 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this class are immutable. 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This class also defines static methods for testing whether a particular 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset is supported, for locating charset instances by name, and for 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * constructing a map that contains every charset for which support is 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * available in the current Java virtual machine. Support for new charsets can 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * be added via the service-provider interface defined in the {@link 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * java.nio.charset.spi.CharsetProvider} class. 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> All of the methods defined in this class are safe for use by multiple 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * concurrent threads. 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <a name="names"><a name="charenc"> 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <h4>Charset names</h4> 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Charsets are named by strings composed of the following characters: 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The uppercase letters <tt>'A'</tt> through <tt>'Z'</tt> 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u0041'</tt> through <tt>'\u005a'</tt>), 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The lowercase letters <tt>'a'</tt> through <tt>'z'</tt> 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u0061'</tt> through <tt>'\u007a'</tt>), 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The digits <tt>'0'</tt> through <tt>'9'</tt> 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u0030'</tt> through <tt>'\u0039'</tt>), 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The dash character <tt>'-'</tt> 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u002d'</tt>, <small>HYPHEN-MINUS</small>), 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The plus character <tt>'+'</tt> 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u002b'</tt>, <small>PLUS SIGN</small>), 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The period character <tt>'.'</tt> 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u002e'</tt>, <small>FULL STOP</small>), 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The colon character <tt>':'</tt> 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u003a'</tt>, <small>COLON</small>), and 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The underscore character <tt>'_'</tt> 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u005f'</tt>, <small>LOW LINE</small>). 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A charset name must begin with either a letter or a digit. The empty string 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is not a legal charset name. Charset names are not case-sensitive; that is, 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * case is always ignored when comparing charset names. Charset names 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * generally follow the conventions documented in <a 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.ietf.org/rfc/rfc2278.txt"><i>RFC 2278: IANA Charset 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Registration Procedures</i></a>. 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Every charset has a <i>canonical name</i> and may also have one or more 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <i>aliases</i>. The canonical name is returned by the {@link #name() name} method 11251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of this class. Canonical names are, by convention, usually in upper case. 11351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The aliases of a charset are returned by the {@link #aliases() aliases} 11451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method. 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <a name="hn"> 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Some charsets have an <i>historical name</i> that is defined for 11951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * compatibility with previous versions of the Java platform. A charset's 12051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * historical name is either its canonical name or one of its aliases. The 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * historical name is returned by the <tt>getEncoding()</tt> methods of the 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link java.io.InputStreamReader#getEncoding InputStreamReader} and {@link 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * java.io.OutputStreamWriter#getEncoding OutputStreamWriter} classes. 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 12551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <a name="iana"> 12651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> If a charset listed in the <a 12851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.iana.org/assignments/character-sets"><i>IANA Charset 12951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Registry</i></a> is supported by an implementation of the Java platform then 13051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * its canonical name must be the name listed in the registry. Many charsets 13151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are given more than one name in the registry, in which case the registry 13251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * identifies one of the names as <i>MIME-preferred</i>. If a charset has more 13351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * than one registry name then its canonical name must be the MIME-preferred 13451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name and the other names in the registry must be valid aliases. If a 13551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * supported charset is not listed in the IANA registry then its canonical name 13651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * must begin with one of the strings <tt>"X-"</tt> or <tt>"x-"</tt>. 13751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 13851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The IANA charset registry does change over time, and so the canonical 13951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name and the aliases of a particular charset may also change over time. To 14051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ensure compatibility it is recommended that no alias ever be removed from a 14151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset, and that if the canonical name of a charset is changed then its 14251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * previous canonical name be made into an alias. 14351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <h4>Standard charsets</h4> 14651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <a name="standard"> 14851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Every implementation of the Java platform is required to support the 15051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * following standard charsets. Consult the release documentation for your 15151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementation to see if any other charsets are supported. The behavior 15251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of such optional charsets may differ between implementations. 15351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 15451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote><table width="80%" summary="Description of standard charsets"> 15551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><th><p align="left">Charset</p></th><th><p align="left">Description</p></th></tr> 15651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>US-ASCII</tt></td> 15751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Seven-bit ASCII, a.k.a. <tt>ISO646-US</tt>, 15851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a.k.a. the Basic Latin block of the Unicode character set</td></tr> 15951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>ISO-8859-1 </tt></td> 16051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>ISO Latin Alphabet No. 1, a.k.a. <tt>ISO-LATIN-1</tt></td></tr> 16151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>UTF-8</tt></td> 16251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Eight-bit UCS Transformation Format</td></tr> 16351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>UTF-16BE</tt></td> 16451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Sixteen-bit UCS Transformation Format, 16551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * big-endian byte order</td></tr> 16651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>UTF-16LE</tt></td> 16751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Sixteen-bit UCS Transformation Format, 16851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * little-endian byte order</td></tr> 16951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>UTF-16</tt></td> 17051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Sixteen-bit UCS Transformation Format, 17151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte order identified by an optional byte-order mark</td></tr> 17251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </table></blockquote> 17351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 17451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The <tt>UTF-8</tt> charset is specified by <a 17551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.ietf.org/rfc/rfc2279.txt"><i>RFC 2279</i></a>; the 17651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * transformation format upon which it is based is specified in 17751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Amendment 2 of ISO 10646-1 and is also described in the <a 17851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.unicode.org/unicode/standard/standard.html"><i>Unicode 17951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Standard</i></a>. 18051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 18151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The <tt>UTF-16</tt> charsets are specified by <a 18251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.ietf.org/rfc/rfc2781.txt"><i>RFC 2781</i></a>; the 18351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * transformation formats upon which they are based are specified in 18451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Amendment 1 of ISO 10646-1 and are also described in the <a 18551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.unicode.org/unicode/standard/standard.html"><i>Unicode 18651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Standard</i></a>. 18751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 18851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The <tt>UTF-16</tt> charsets use sixteen-bit quantities and are 18951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * therefore sensitive to byte order. In these encodings the byte order of a 19051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * stream may be indicated by an initial <i>byte-order mark</i> represented by 19151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the Unicode character <tt>'\uFEFF'</tt>. Byte-order marks are handled 19251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * as follows: 19351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 19451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 19551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 19651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li><p> When decoding, the <tt>UTF-16BE</tt> and <tt>UTF-16LE</tt> 19751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charsets interpret the initial byte-order marks as a <small>ZERO-WIDTH 19851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * NON-BREAKING SPACE</small>; when encoding, they do not write 19951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte-order marks. </p></li> 20051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 20151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 20251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li><p> When decoding, the <tt>UTF-16</tt> charset interprets the 20351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte-order mark at the beginning of the input stream to indicate the 20451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte-order of the stream but defaults to big-endian if there is no 20551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte-order mark; when encoding, it uses big-endian byte order and writes 20651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a big-endian byte-order mark. </p></li> 20751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 20851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 20951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 21051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * In any case, byte order marks occuring after the first element of an 21151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * input sequence are not omitted since the same code is used to represent 21251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <small>ZERO-WIDTH NON-BREAKING SPACE</small>. 21351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 21451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Every instance of the Java virtual machine has a default charset, which 21551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * may or may not be one of the standard charsets. The default charset is 21651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * determined during virtual-machine startup and typically depends upon the 21751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locale and charset being used by the underlying operating system. </p> 21851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 21951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The {@link StandardCharsets} class defines constants for each of the 22051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * standard charsets. 22151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 22251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <h4>Terminology</h4> 22351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 22451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The name of this class is taken from the terms used in 22551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <a href="http://www.ietf.org/rfc/rfc2278.txt"><i>RFC 2278</i></a>. 22651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * In that document a <i>charset</i> is defined as the combination of 22751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * one or more coded character sets and a character-encoding scheme. 22851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (This definition is confusing; some other software systems define 22951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <i>charset</i> as a synonym for <i>coded character set</i>.) 23051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 23151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> A <i>coded character set</i> is a mapping between a set of abstract 23251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * characters and a set of integers. US-ASCII, ISO 8859-1, 23351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * JIS X 0201, and Unicode are examples of coded character sets. 23451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 23551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Some standards have defined a <i>character set</i> to be simply a 23651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * set of abstract characters without an associated assigned numbering. 23751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * An alphabet is an example of such a character set. However, the subtle 23851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * distinction between <i>character set</i> and <i>coded character set</i> 23951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is rarely used in practice; the former has become a short form for the 24051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * latter, including in the Java API specification. 24151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 24251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> A <i>character-encoding scheme</i> is a mapping between one or more 24351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * coded character sets and a set of octet (eight-bit byte) sequences. 24451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * UTF-8, UTF-16, ISO 2022, and EUC are examples of 24551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * character-encoding schemes. Encoding schemes are often associated with 24651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a particular coded character set; UTF-8, for example, is used only to 24751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * encode Unicode. Some schemes, however, are associated with multiple 24851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * coded character sets; EUC, for example, can be used to encode 24951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * characters in a variety of Asian coded character sets. 25051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 25151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> When a coded character set is used exclusively with a single 25251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * character-encoding scheme then the corresponding charset is usually 25351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * named for the coded character set; otherwise a charset is usually named 25451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for the encoding scheme and, possibly, the locale of the coded 25551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * character sets that it supports. Hence <tt>US-ASCII</tt> is both the 25651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name of a coded character set and of the charset that encodes it, while 25751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>EUC-JP</tt> is the name of the charset that encodes the 25851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * JIS X 0201, JIS X 0208, and JIS X 0212 25951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * coded character sets for the Japanese language. 26051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The native character encoding of the Java programming language is 26251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * UTF-16. A charset in the Java platform therefore defines a mapping 26351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * between sequences of sixteen-bit UTF-16 code units (that is, sequences 26451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of chars) and sequences of bytes. </p> 26551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author Mark Reinhold 26851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author JSR-51 Expert Group 26951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 27051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 27151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see CharsetDecoder 27251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see CharsetEncoder 27351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see java.nio.charset.spi.CharsetProvider 27451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see java.lang.Character 27551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 27651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 27751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic abstract class Charset 27851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski implements Comparable<Charset> 27951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski{ 28051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 28151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* -- Static methods -- */ 28251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 28351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static volatile String bugLevel = null; 28451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 28551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski static boolean atBugLevel(String bl) { // package-private 28651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String level = bugLevel; 28751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (level == null) { 28851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!sun.misc.VM.isBooted()) 28951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 29051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bugLevel = level = AccessController.doPrivileged( 29151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new GetPropertyAction("sun.nio.cs.bugLevel", "")); 29251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 29351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return level.equals(bl); 29451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 29551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 29651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 29751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Checks that the given string is a legal charset name. </p> 29851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 29951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param s 30051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A purported charset name 30151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 30251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalCharsetNameException 30351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given name is not a legal charset name 30451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 30551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static void checkName(String s) { 30651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int n = s.length(); 30751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!atBugLevel("1.4")) { 30851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (n == 0) 30951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalCharsetNameException(s); 31051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 31151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; i < n; i++) { 31251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski char c = s.charAt(i); 31351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c >= 'A' && c <= 'Z') continue; 31451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c >= 'a' && c <= 'z') continue; 31551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c >= '0' && c <= '9') continue; 31651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == '-' && i != 0) continue; 31751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == '+' && i != 0) continue; 31851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == ':' && i != 0) continue; 31951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == '_' && i != 0) continue; 32051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == '.' && i != 0) continue; 32151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalCharsetNameException(s); 32251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 32351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 32451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 32551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* The standard set of charsets */ 3269c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Android-Removed: We use ICU's list of standard charsets. 3279c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static CharsetProvider standardProvider = new StandardCharsets(); 32851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 32951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Cache of the most-recently-returned charsets, 33051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // along with the names that were used to find them 33151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 33251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static volatile Object[] cache1 = null; // "Level 1" cache 33351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static volatile Object[] cache2 = null; // "Level 2" cache 33451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 33551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static void cache(String charsetName, Charset cs) { 33651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cache2 = cache1; 33751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cache1 = new Object[] { charsetName, cs }; 33851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 33951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 34051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Creates an iterator that walks over the available providers, ignoring 34151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // those whose lookup or instantiation causes a security exception to be 34251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // thrown. Should be invoked with full privileges. 34351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 34451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static Iterator providers() { 34551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return new Iterator() { 34651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 34751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ClassLoader cl = ClassLoader.getSystemClassLoader(); 34851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ServiceLoader<CharsetProvider> sl = 34951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ServiceLoader.load(CharsetProvider.class, cl); 35051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Iterator<CharsetProvider> i = sl.iterator(); 35151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 35251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Object next = null; 35351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 35451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private boolean getNext() { 35551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while (next == null) { 35651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 35751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!i.hasNext()) 35851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 35951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski next = i.next(); 36051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (ServiceConfigurationError sce) { 36151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (sce.getCause() instanceof SecurityException) { 36251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ignore security exceptions 36351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski continue; 36451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 36551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw sce; 36651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 36751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 36851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 36951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 37051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 37151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean hasNext() { 37251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getNext(); 37351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 37451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 37551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Object next() { 37651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!getNext()) 37751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NoSuchElementException(); 37851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Object n = next; 37951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski next = null; 38051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return n; 38151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 38251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 38351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void remove() { 38451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new UnsupportedOperationException(); 38551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 38651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 38751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }; 38851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 38951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 39051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Thread-local gate to prevent recursive provider lookups 39151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static ThreadLocal<ThreadLocal> gate = new ThreadLocal<ThreadLocal>(); 39251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 39351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static Charset lookupViaProviders(final String charsetName) { 39451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 39551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // The runtime startup sequence looks up standard charsets as a 39651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // consequence of the VM's invocation of System.initializeSystemClass 39751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // in order to, e.g., set system properties and encode filenames. At 39851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // that point the application class loader has not been initialized, 39951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // however, so we can't look for providers because doing so will cause 40051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // that loader to be prematurely initialized with incomplete 40151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // information. 40251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 40351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!sun.misc.VM.isBooted()) 40451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 40551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 40651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (gate.get() != null) 40751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Avoid recursive provider lookups 40851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 40951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 41051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski gate.set(gate); 41151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 41251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return AccessController.doPrivileged( 41351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new PrivilegedAction<Charset>() { 41451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Charset run() { 41551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (Iterator i = providers(); i.hasNext();) { 41651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CharsetProvider cp = (CharsetProvider)i.next(); 41751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Charset cs = cp.charsetForName(charsetName); 41851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (cs != null) 41951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cs; 42051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 42151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 42251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 42351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }); 42451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 42551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } finally { 42651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski gate.set(null); 42751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 42851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 42951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4309c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Android removed : Remove support for the extended charset provider. 4319c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // 43251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* The extended set of charsets */ 4339c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static Object extendedProviderLock = new Object(); 4349c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static boolean extendedProviderProbed = false; 4359c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static CharsetProvider extendedProvider = null; 4369c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // 4379c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static void probeExtendedProvider() { 4389c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // AccessController.doPrivileged(new PrivilegedAction<Object>() { 4399c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // public Object run() { 4409c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // try { 4419c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Class epc 4429c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // = Class.forName("sun.nio.cs.ext.ExtendedCharsets"); 4439c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // extendedProvider = (CharsetProvider)epc.newInstance(); 4449c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } catch (ClassNotFoundException x) { 4459c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // // Extended charsets not available 4469c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // // (charsets.jar not present) 4479c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } catch (InstantiationException x) { 4489c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // throw new Error(x); 4499c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } catch (IllegalAccessException x) { 4509c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // throw new Error(x); 4519c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4529c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // return null; 4539c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4549c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // }); 4559c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4569c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // 4579c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static Charset lookupExtendedCharset(String charsetName) { 4589c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // CharsetProvider ecp = null; 4599c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // synchronized (extendedProviderLock) { 4609c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // if (!extendedProviderProbed) { 4619c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // probeExtendedProvider(); 4629c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // extendedProviderProbed = true; 4639c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4649c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // ecp = extendedProvider; 4659c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4669c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // return (ecp != null) ? ecp.charsetForName(charsetName) : null; 4679c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 46851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 46951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static Charset lookup(String charsetName) { 47051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (charsetName == null) 47151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Null charset name"); 47251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 47351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Object[] a; 47451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if ((a = cache1) != null && charsetName.equals(a[0])) 47551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (Charset)a[1]; 47651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // We expect most programs to use one Charset repeatedly. 47751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // We convey a hint to this effect to the VM by putting the 47851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // level 1 cache miss code in a separate method. 47951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return lookup2(charsetName); 48051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 48151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 48251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static Charset lookup2(String charsetName) { 48351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Object[] a; 48451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if ((a = cache2) != null && charsetName.equals(a[0])) { 48551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cache2 = cache1; 48651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cache1 = a; 48751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (Charset)a[1]; 48851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 48951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 49051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Charset cs; 4919c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Android-changed: Drop support for "standard" and "extended" 4929c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // providers. 493133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski if ((cs = NativeConverter.charsetForName(charsetName)) != null || 49451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski (cs = lookupViaProviders(charsetName)) != null) 49551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 49651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cache(charsetName, cs); 49751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cs; 49851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 49951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 50051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* Only need to check the name if we didn't find a charset for it */ 50151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski checkName(charsetName); 50251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 50351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 50451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 50551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 50651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether the named charset is supported. </p> 50751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 50851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param charsetName 50951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The name of the requested charset; may be either 51051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a canonical name or an alias 51151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 51251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if, and only if, support for the named charset 51351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is available in the current Java virtual machine 51451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 51551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalCharsetNameException 51651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given charset name is illegal 51751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 51851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException 51951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given <tt>charsetName</tt> is null 52051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 52151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static boolean isSupported(String charsetName) { 52251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (lookup(charsetName) != null); 52351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 52451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 52551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 52651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a charset object for the named charset. </p> 52751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 52851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param charsetName 52951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The name of the requested charset; may be either 53051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a canonical name or an alias 53151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 53251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A charset object for the named charset 53351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 53451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalCharsetNameException 53551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given charset name is illegal 53651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 53751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException 53851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given <tt>charsetName</tt> is null 53951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 54051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws UnsupportedCharsetException 54151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If no support for the named charset is available 54251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in this instance of the Java virtual machine 54351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 54451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static Charset forName(String charsetName) { 54551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Charset cs = lookup(charsetName); 54651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (cs != null) 54751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cs; 54851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new UnsupportedCharsetException(charsetName); 54951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 55051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 55116ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak 55216ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak /** 55316ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak * Equivalent to {@code forName} but only throws {@code UnsupportedEncodingException}, 55416ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak * which is all pre-nio code claims to throw. 55516ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak * 55616ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak * @hide internal use only 55716ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak */ 55816ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak public static Charset forNameUEE(String charsetName) throws UnsupportedEncodingException { 55916ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak try { 56016ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak return Charset.forName(charsetName); 56116ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak } catch (Exception cause) { 56216ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak UnsupportedEncodingException ex = new UnsupportedEncodingException(charsetName); 56316ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak ex.initCause(cause); 56416ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak throw ex; 56516ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak } 56616ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak } 56716ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak 56816ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak 56951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Fold charsets from the given iterator into the given map, ignoring 57051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // charsets whose names already have entries in the map. 57151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 57251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static void put(Iterator<Charset> i, Map<String,Charset> m) { 57351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while (i.hasNext()) { 57451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Charset cs = i.next(); 57551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!m.containsKey(cs.name())) 57651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski m.put(cs.name(), cs); 57751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 57851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 57951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 58051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 58151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Constructs a sorted map from canonical charset names to charset objects. 58251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 58351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The map returned by this method will have one entry for each charset 58451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for which support is available in the current Java virtual machine. If 58551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * two or more supported charsets have the same canonical name then the 58651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resulting map will contain just one of them; which one it will contain 58751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is not specified. </p> 58851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 58951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The invocation of this method, and the subsequent use of the 59051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resulting map, may cause time-consuming disk or network I/O operations 59151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to occur. This method is provided for applications that need to 59251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * enumerate all of the available charsets, for example to allow user 59351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset selection. This method is not used by the {@link #forName 59451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * forName} method, which instead employs an efficient incremental lookup 59551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * algorithm. 59651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 59751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This method may return different results at different times if new 59851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset providers are dynamically made available to the current Java 59951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * virtual machine. In the absence of such changes, the charsets returned 60051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by this method are exactly those that can be retrieved via the {@link 60151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #forName forName} method. </p> 60251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 60351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return An immutable, case-insensitive map from canonical charset names 60451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to charset objects 60551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 60651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static SortedMap<String,Charset> availableCharsets() { 60751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return AccessController.doPrivileged( 60851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new PrivilegedAction<SortedMap<String,Charset>>() { 60951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public SortedMap<String,Charset> run() { 61051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski TreeMap<String,Charset> m = 61151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new TreeMap<String,Charset>( 61251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ASCIICaseInsensitiveComparator.CASE_INSENSITIVE_ORDER); 613133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski for (String charsetName : NativeConverter.getAvailableCharsetNames()) { 614133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski Charset charset = NativeConverter.charsetForName(charsetName); 615133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski m.put(charset.name(), charset); 616133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski } 6179c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Android-changed: No more "standard" provider. 6189c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // put(standardProvider.charsets(), m); 61951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (Iterator i = providers(); i.hasNext();) { 62051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CharsetProvider cp = (CharsetProvider)i.next(); 62151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski put(cp.charsets(), m); 62251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 62351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return Collections.unmodifiableSortedMap(m); 62451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 62551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }); 62651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 62751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6289c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath private static Charset defaultCharset; 62951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 63051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 63151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the default charset of this Java virtual machine. 63251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 63351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The default charset is determined during virtual-machine startup and 63451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * typically depends upon the locale and charset of the underlying 63551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * operating system. 63651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 63751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A charset object for the default charset 63851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 63951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.5 64051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 64151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static Charset defaultCharset() { 6429c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Android changed : Use UTF_8 unconditionally. 6439c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath synchronized (Charset.class) { 6449c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath if (defaultCharset == null) { 6459c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath defaultCharset = java.nio.charset.StandardCharsets.UTF_8; 64668b04a439f8959b4482b89b437abeddb367c2521Narayan Kamath } 6479c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath 6489c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath return defaultCharset; 64968b04a439f8959b4482b89b437abeddb367c2521Narayan Kamath } 65051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 65151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 65251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 65351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* -- Instance fields and methods -- */ 65451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 65551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private final String name; // tickles a bug in oldjavac 65651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private final String[] aliases; // tickles a bug in oldjavac 65751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private Set<String> aliasSet = null; 65851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 65951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 66051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Initializes a new charset with the given canonical name and alias 66151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * set. </p> 66251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 66351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param canonicalName 66451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The canonical name of this charset 66551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 66651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param aliases 66751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * An array of this charset's aliases, or null if it has no aliases 66851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 66951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalCharsetNameException 67051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the canonical name or any of the aliases are illegal 67151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 67251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected Charset(String canonicalName, String[] aliases) { 67351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski checkName(canonicalName); 67451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String[] as = (aliases == null) ? new String[0] : aliases; 67551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; i < as.length; i++) 67651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski checkName(as[i]); 67751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.name = canonicalName; 67851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.aliases = as; 67951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 68051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 68151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 68251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns this charset's canonical name. </p> 68351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 68451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The canonical name of this charset 68551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 68651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final String name() { 68751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name; 68851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 68951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 69051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 69151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a set containing this charset's aliases. </p> 69251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 69351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return An immutable set of this charset's aliases 69451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 69551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final Set<String> aliases() { 69651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (aliasSet != null) 69751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return aliasSet; 69851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int n = aliases.length; 69951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski HashSet<String> hs = new HashSet<String>(n); 70051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; i < n; i++) 70151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski hs.add(aliases[i]); 70251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski aliasSet = Collections.unmodifiableSet(hs); 70351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return aliasSet; 70451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 70551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 70651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 70751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns this charset's human-readable name for the default locale. 70851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 70951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The default implementation of this method simply returns this 71051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset's canonical name. Concrete subclasses of this class may 71151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * override this method in order to provide a localized display name. </p> 71251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 71351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The display name of this charset in the default locale 71451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 71551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String displayName() { 71651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name; 71751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 71851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 71951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 72051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether or not this charset is registered in the <a 72151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.iana.org/assignments/character-sets">IANA Charset 72251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Registry</a>. </p> 72351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 72451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if, and only if, this charset is known by its 72551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementor to be registered with the IANA 72651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 72751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final boolean isRegistered() { 72851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return !name.startsWith("X-") && !name.startsWith("x-"); 72951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 73051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 73151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 73251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns this charset's human-readable name for the given locale. 73351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 73451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The default implementation of this method simply returns this 73551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset's canonical name. Concrete subclasses of this class may 73651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * override this method in order to provide a localized display name. </p> 73751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 73851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 73951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The locale for which the display name is to be retrieved 74051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 74151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The display name of this charset in the given locale 74251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 74351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String displayName(Locale locale) { 74451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name; 74551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 74651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 74751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 74851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether or not this charset contains the given charset. 74951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 75051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> A charset <i>C</i> is said to <i>contain</i> a charset <i>D</i> if, 75151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and only if, every character representable in <i>D</i> is also 75251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * representable in <i>C</i>. If this relationship holds then it is 75351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * guaranteed that every string that can be encoded in <i>D</i> can also be 75451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * encoded in <i>C</i> without performing any replacements. 75551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 75651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> That <i>C</i> contains <i>D</i> does not imply that each character 75751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * representable in <i>C</i> by a particular byte sequence is represented 75851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in <i>D</i> by the same byte sequence, although sometimes this is the 75951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * case. 76051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 76151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Every charset contains itself. 76251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 76351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This method computes an approximation of the containment relation: 76451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If it returns <tt>true</tt> then the given charset is known to be 76551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * contained by this charset; if it returns <tt>false</tt>, however, then 76651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it is not necessarily the case that the given charset is not contained 76751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in this charset. 76851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 76951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if the given charset is contained in this charset 77051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 77151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract boolean contains(Charset cs); 77251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 77351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 77451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Constructs a new decoder for this charset. </p> 77551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 77651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A new decoder for this charset 77751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 77851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract CharsetDecoder newDecoder(); 77951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 78051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 78151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Constructs a new encoder for this charset. </p> 78251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 78351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A new encoder for this charset 78451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 78551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws UnsupportedOperationException 78651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If this charset does not support encoding 78751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 78851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract CharsetEncoder newEncoder(); 78951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 79051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 79151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether or not this charset supports encoding. 79251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 79351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Nearly all charsets support encoding. The primary exceptions are 79451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * special-purpose <i>auto-detect</i> charsets whose decoders can determine 79551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * which of several possible encoding schemes is in use by examining the 79651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * input byte sequence. Such charsets do not support encoding because 79751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * there is no way to determine which encoding should be used on output. 79851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implementations of such charsets should override this method to return 79951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>false</tt>. </p> 80051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 80151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if, and only if, this charset supports encoding 80251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 80351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean canEncode() { 80451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 80551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 80651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 80751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 80851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Convenience method that decodes bytes in this charset into Unicode 80951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * characters. 81051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 81151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> An invocation of this method upon a charset <tt>cs</tt> returns the 81251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * same result as the expression 81351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 81451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 81551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cs.newDecoder() 81651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .onMalformedInput(CodingErrorAction.REPLACE) 81751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .onUnmappableCharacter(CodingErrorAction.REPLACE) 81851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .decode(bb); </pre> 81951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 82051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that it is potentially more efficient because it can cache 82151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * decoders between successive invocations. 82251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 82351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This method always replaces malformed-input and unmappable-character 82451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * sequences with this charset's default replacement byte array. In order 82551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to detect such sequences, use the {@link 82651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * CharsetDecoder#decode(java.nio.ByteBuffer)} method directly. </p> 82751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 82851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param bb The byte buffer to be decoded 82951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 83051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A char buffer containing the decoded characters 83151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 83251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final CharBuffer decode(ByteBuffer bb) { 83351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 83451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return ThreadLocalCoders.decoderFor(this) 83551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .onMalformedInput(CodingErrorAction.REPLACE) 83651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .onUnmappableCharacter(CodingErrorAction.REPLACE) 83751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .decode(bb); 83851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (CharacterCodingException x) { 83951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new Error(x); // Can't happen 84051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 84151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 84251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 84351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 84451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Convenience method that encodes Unicode characters into bytes in this 84551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset. 84651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 84751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> An invocation of this method upon a charset <tt>cs</tt> returns the 84851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * same result as the expression 84951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 85051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 85151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cs.newEncoder() 85251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .onMalformedInput(CodingErrorAction.REPLACE) 85351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .onUnmappableCharacter(CodingErrorAction.REPLACE) 85451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .encode(bb); </pre> 85551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 85651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that it is potentially more efficient because it can cache 85751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * encoders between successive invocations. 85851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 85951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This method always replaces malformed-input and unmappable-character 86051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * sequences with this charset's default replacement string. In order to 86151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * detect such sequences, use the {@link 86251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * CharsetEncoder#encode(java.nio.CharBuffer)} method directly. </p> 86351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 86451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param cb The char buffer to be encoded 86551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 86651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A byte buffer containing the encoded characters 86751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 86851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final ByteBuffer encode(CharBuffer cb) { 86951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 87051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return ThreadLocalCoders.encoderFor(this) 87151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .onMalformedInput(CodingErrorAction.REPLACE) 87251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .onUnmappableCharacter(CodingErrorAction.REPLACE) 87351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .encode(cb); 87451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (CharacterCodingException x) { 87551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new Error(x); // Can't happen 87651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 87751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 87851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 87951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 88051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Convenience method that encodes a string into bytes in this charset. 88151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 88251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> An invocation of this method upon a charset <tt>cs</tt> returns the 88351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * same result as the expression 88451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 88551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 88651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cs.encode(CharBuffer.wrap(s)); </pre> 88751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 88851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param str The string to be encoded 88951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 89051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A byte buffer containing the encoded characters 89151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 89251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final ByteBuffer encode(String str) { 89351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return encode(CharBuffer.wrap(str)); 89451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 89551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 89651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 89751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Compares this charset to another. 89851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 89951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Charsets are ordered by their canonical names, without regard to 90051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * case. </p> 90151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 90251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param that 90351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The charset to which this charset is to be compared 90451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 90551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A negative integer, zero, or a positive integer as this charset 90651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is less than, equal to, or greater than the specified charset 90751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 90851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final int compareTo(Charset that) { 90951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (name().compareToIgnoreCase(that.name())); 91051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 91151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 91251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 91351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Computes a hashcode for this charset. </p> 91451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 91551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return An integer hashcode 91651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 91751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final int hashCode() { 91851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name().hashCode(); 91951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 92051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 92151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 92251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether or not this object is equal to another. 92351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 92451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Two charsets are equal if, and only if, they have the same canonical 92551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * names. A charset is never equal to any other type of object. </p> 92651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 92751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if, and only if, this charset is equal to the 92851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * given object 92951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 93051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final boolean equals(Object ob) { 93151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!(ob instanceof Charset)) 93251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 93351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (this == ob) 93451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 93551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name.equals(((Charset)ob).name()); 93651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 93751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 93851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 93951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns a string describing this charset. </p> 94051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 94151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A string describing this charset 94251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 94351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final String toString() { 94451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name(); 94551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 94651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 947