151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 22c87ad3a45cecf9e344487cad1abfdebe79f2c7cNarayan Kamath * Copyright (C) 2014 The Android Open Source Project 3861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.nio.charset; 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 299a9f76d1e161f37b3d83d2db94ea63298d221bdfPiotr Jastrzebskiimport java.io.UnsupportedEncodingException; 30133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebskiimport libcore.icu.NativeConverter; 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.nio.ByteBuffer; 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.nio.CharBuffer; 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.nio.charset.spi.CharsetProvider; 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.AccessController; 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.AccessControlException; 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.PrivilegedAction; 37a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kongimport java.util.AbstractMap; 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Collections; 39a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kongimport java.util.HashMap; 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.HashSet; 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Iterator; 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Locale; 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Map; 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.NoSuchElementException; 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.Set; 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.ServiceLoader; 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.ServiceConfigurationError; 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.SortedMap; 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.TreeMap; 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.misc.ASCIICaseInsensitiveComparator; 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.nio.cs.ThreadLocalCoders; 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport sun.security.action.GetPropertyAction; 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A named mapping between sequences of sixteen-bit Unicode <a 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="../../lang/Character.html#unicode">code units</a> and sequences of 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * bytes. This class defines methods for creating decoders and encoders and 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for retrieving the various names associated with a charset. Instances of 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this class are immutable. 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This class also defines static methods for testing whether a particular 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset is supported, for locating charset instances by name, and for 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * constructing a map that contains every charset for which support is 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * available in the current Java virtual machine. Support for new charsets can 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * be added via the service-provider interface defined in the {@link 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * java.nio.charset.spi.CharsetProvider} class. 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> All of the methods defined in this class are safe for use by multiple 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * concurrent threads. 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 73861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * <a name="names"></a><a name="charenc"></a> 74861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * <h2>Charset names</h2> 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Charsets are named by strings composed of the following characters: 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The uppercase letters <tt>'A'</tt> through <tt>'Z'</tt> 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u0041'</tt> through <tt>'\u005a'</tt>), 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The lowercase letters <tt>'a'</tt> through <tt>'z'</tt> 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u0061'</tt> through <tt>'\u007a'</tt>), 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The digits <tt>'0'</tt> through <tt>'9'</tt> 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u0030'</tt> through <tt>'\u0039'</tt>), 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The dash character <tt>'-'</tt> 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u002d'</tt>, <small>HYPHEN-MINUS</small>), 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The plus character <tt>'+'</tt> 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u002b'</tt>, <small>PLUS SIGN</small>), 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The period character <tt>'.'</tt> 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u002e'</tt>, <small>FULL STOP</small>), 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The colon character <tt>':'</tt> 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u003a'</tt>, <small>COLON</small>), and 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li> The underscore character <tt>'_'</tt> 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'\u005f'</tt>, <small>LOW LINE</small>). 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A charset name must begin with either a letter or a digit. The empty string 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is not a legal charset name. Charset names are not case-sensitive; that is, 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * case is always ignored when comparing charset names. Charset names 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * generally follow the conventions documented in <a 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.ietf.org/rfc/rfc2278.txt"><i>RFC 2278: IANA Charset 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Registration Procedures</i></a>. 11251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 11351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Every charset has a <i>canonical name</i> and may also have one or more 11451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <i>aliases</i>. The canonical name is returned by the {@link #name() name} method 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of this class. Canonical names are, by convention, usually in upper case. 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The aliases of a charset are returned by the {@link #aliases() aliases} 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method. 11851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 119861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * <p><a name="hn">Some charsets have an <i>historical name</i> that is defined for 120861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * compatibility with previous versions of the Java platform.</a> A charset's 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * historical name is either its canonical name or one of its aliases. The 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * historical name is returned by the <tt>getEncoding()</tt> methods of the 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link java.io.InputStreamReader#getEncoding InputStreamReader} and {@link 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * java.io.OutputStreamWriter#getEncoding OutputStreamWriter} classes. 12551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 126861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * <p><a name="iana"> </a>If a charset listed in the <a 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.iana.org/assignments/character-sets"><i>IANA Charset 12851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Registry</i></a> is supported by an implementation of the Java platform then 129861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * its canonical name must be the name listed in the registry. Many charsets 13051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are given more than one name in the registry, in which case the registry 13151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * identifies one of the names as <i>MIME-preferred</i>. If a charset has more 13251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * than one registry name then its canonical name must be the MIME-preferred 13351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name and the other names in the registry must be valid aliases. If a 13451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * supported charset is not listed in the IANA registry then its canonical name 13551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * must begin with one of the strings <tt>"X-"</tt> or <tt>"x-"</tt>. 13651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 13751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The IANA charset registry does change over time, and so the canonical 13851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name and the aliases of a particular charset may also change over time. To 13951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ensure compatibility it is recommended that no alias ever be removed from a 14051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset, and that if the canonical name of a charset is changed then its 14151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * previous canonical name be made into an alias. 14251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 144861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * <h2>Standard charsets</h2> 145861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * 14651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 14751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 148861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * <p><a name="standard">Every implementation of the Java platform is required to support the 149861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * following standard charsets.</a> Consult the release documentation for your 15051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementation to see if any other charsets are supported. The behavior 15151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of such optional charsets may differ between implementations. 15251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 15351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <blockquote><table width="80%" summary="Description of standard charsets"> 154861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * <tr><th align="left">Charset</th><th align="left">Description</th></tr> 15551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>US-ASCII</tt></td> 15651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Seven-bit ASCII, a.k.a. <tt>ISO646-US</tt>, 15751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a.k.a. the Basic Latin block of the Unicode character set</td></tr> 15851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>ISO-8859-1 </tt></td> 15951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>ISO Latin Alphabet No. 1, a.k.a. <tt>ISO-LATIN-1</tt></td></tr> 16051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>UTF-8</tt></td> 16151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Eight-bit UCS Transformation Format</td></tr> 16251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>UTF-16BE</tt></td> 16351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Sixteen-bit UCS Transformation Format, 16451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * big-endian byte order</td></tr> 16551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>UTF-16LE</tt></td> 16651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Sixteen-bit UCS Transformation Format, 16751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * little-endian byte order</td></tr> 16851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tr><td valign=top><tt>UTF-16</tt></td> 16951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <td>Sixteen-bit UCS Transformation Format, 17051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte order identified by an optional byte-order mark</td></tr> 17151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </table></blockquote> 17251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 17351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The <tt>UTF-8</tt> charset is specified by <a 17451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.ietf.org/rfc/rfc2279.txt"><i>RFC 2279</i></a>; the 17551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * transformation format upon which it is based is specified in 17651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Amendment 2 of ISO 10646-1 and is also described in the <a 17751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.unicode.org/unicode/standard/standard.html"><i>Unicode 17851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Standard</i></a>. 17951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 18051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The <tt>UTF-16</tt> charsets are specified by <a 18151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.ietf.org/rfc/rfc2781.txt"><i>RFC 2781</i></a>; the 18251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * transformation formats upon which they are based are specified in 18351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Amendment 1 of ISO 10646-1 and are also described in the <a 18451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.unicode.org/unicode/standard/standard.html"><i>Unicode 18551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Standard</i></a>. 18651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 18751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The <tt>UTF-16</tt> charsets use sixteen-bit quantities and are 18851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * therefore sensitive to byte order. In these encodings the byte order of a 18951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * stream may be indicated by an initial <i>byte-order mark</i> represented by 19051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the Unicode character <tt>'\uFEFF'</tt>. Byte-order marks are handled 19151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * as follows: 19251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 19351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <ul> 19451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 19551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li><p> When decoding, the <tt>UTF-16BE</tt> and <tt>UTF-16LE</tt> 19651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charsets interpret the initial byte-order marks as a <small>ZERO-WIDTH 19751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * NON-BREAKING SPACE</small>; when encoding, they do not write 19851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte-order marks. </p></li> 19951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 20051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 20151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <li><p> When decoding, the <tt>UTF-16</tt> charset interprets the 20251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte-order mark at the beginning of the input stream to indicate the 20351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte-order of the stream but defaults to big-endian if there is no 20451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * byte-order mark; when encoding, it uses big-endian byte order and writes 20551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a big-endian byte-order mark. </p></li> 20651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 20751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </ul> 20851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 209861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * In any case, byte order marks occurring after the first element of an 21051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * input sequence are not omitted since the same code is used to represent 21151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <small>ZERO-WIDTH NON-BREAKING SPACE</small>. 21251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2139dab0f1f61ee1e8401c6abd715b4d0604bdd7305Przemyslaw Szczepaniak * <p>Android note: The Android platform default is always UTF-8. 21451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 21551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The {@link StandardCharsets} class defines constants for each of the 21651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * standard charsets. 21751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 218861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * <h2>Terminology</h2> 21951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 22051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The name of this class is taken from the terms used in 22151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <a href="http://www.ietf.org/rfc/rfc2278.txt"><i>RFC 2278</i></a>. 22251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * In that document a <i>charset</i> is defined as the combination of 22351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * one or more coded character sets and a character-encoding scheme. 22451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (This definition is confusing; some other software systems define 22551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <i>charset</i> as a synonym for <i>coded character set</i>.) 22651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 22751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> A <i>coded character set</i> is a mapping between a set of abstract 22851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * characters and a set of integers. US-ASCII, ISO 8859-1, 22951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * JIS X 0201, and Unicode are examples of coded character sets. 23051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 23151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Some standards have defined a <i>character set</i> to be simply a 23251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * set of abstract characters without an associated assigned numbering. 23351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * An alphabet is an example of such a character set. However, the subtle 23451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * distinction between <i>character set</i> and <i>coded character set</i> 23551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is rarely used in practice; the former has become a short form for the 23651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * latter, including in the Java API specification. 23751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 23851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> A <i>character-encoding scheme</i> is a mapping between one or more 23951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * coded character sets and a set of octet (eight-bit byte) sequences. 24051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * UTF-8, UTF-16, ISO 2022, and EUC are examples of 24151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * character-encoding schemes. Encoding schemes are often associated with 24251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a particular coded character set; UTF-8, for example, is used only to 24351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * encode Unicode. Some schemes, however, are associated with multiple 24451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * coded character sets; EUC, for example, can be used to encode 24551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * characters in a variety of Asian coded character sets. 24651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 24751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> When a coded character set is used exclusively with a single 24851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * character-encoding scheme then the corresponding charset is usually 24951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * named for the coded character set; otherwise a charset is usually named 25051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for the encoding scheme and, possibly, the locale of the coded 25151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * character sets that it supports. Hence <tt>US-ASCII</tt> is both the 25251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name of a coded character set and of the charset that encodes it, while 25351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>EUC-JP</tt> is the name of the charset that encodes the 25451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * JIS X 0201, JIS X 0208, and JIS X 0212 25551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * coded character sets for the Japanese language. 25651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 25751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The native character encoding of the Java programming language is 25851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * UTF-16. A charset in the Java platform therefore defines a mapping 25951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * between sequences of sixteen-bit UTF-16 code units (that is, sequences 26051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of chars) and sequences of bytes. </p> 26151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author Mark Reinhold 26451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author JSR-51 Expert Group 26551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 26651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see CharsetDecoder 26851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see CharsetEncoder 26951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see java.nio.charset.spi.CharsetProvider 27051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see java.lang.Character 27151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 27251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 27351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic abstract class Charset 27451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski implements Comparable<Charset> 27551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski{ 27651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 27751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* -- Static methods -- */ 27851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 27951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static volatile String bugLevel = null; 28051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 28151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski static boolean atBugLevel(String bl) { // package-private 28251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String level = bugLevel; 28351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (level == null) { 28451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!sun.misc.VM.isBooted()) 28551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 28651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski bugLevel = level = AccessController.doPrivileged( 28751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new GetPropertyAction("sun.nio.cs.bugLevel", "")); 28851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 28951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return level.equals(bl); 29051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 29151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 29251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 29351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Checks that the given string is a legal charset name. </p> 29451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 29551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param s 29651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A purported charset name 29751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 29851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalCharsetNameException 29951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given name is not a legal charset name 30051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 30151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static void checkName(String s) { 30251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int n = s.length(); 30351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!atBugLevel("1.4")) { 30451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (n == 0) 30551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalCharsetNameException(s); 30651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 30751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; i < n; i++) { 30851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski char c = s.charAt(i); 30951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c >= 'A' && c <= 'Z') continue; 31051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c >= 'a' && c <= 'z') continue; 31151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c >= '0' && c <= '9') continue; 31251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == '-' && i != 0) continue; 31351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == '+' && i != 0) continue; 31451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == ':' && i != 0) continue; 31551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == '_' && i != 0) continue; 31651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (c == '.' && i != 0) continue; 31751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalCharsetNameException(s); 31851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 31951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 32051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 32151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* The standard set of charsets */ 3226975f84c2ed72e1e26d20190b6f318718c849008Tobias Thierer // Android-removed: We use ICU's list of standard charsets. 3239c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static CharsetProvider standardProvider = new StandardCharsets(); 32451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 32551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Cache of the most-recently-returned charsets, 32651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // along with the names that were used to find them 32751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 328a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong // cache1/2 usage is explained in the lookup method 329a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong // 330a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong private static volatile Map.Entry<String, Charset> cache1 = null; // "Level 1" cache 331a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong private static final HashMap<String, Charset> cache2 = new HashMap<>(); // "Level 2" cache 33251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 33351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static void cache(String charsetName, Charset cs) { 334a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong synchronized(cache2) { 335a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong String canonicalName = cs.name(); 336a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong Charset canonicalCharset = cache2.get(canonicalName); 337a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong 338a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong if (canonicalCharset != null) { 339a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong cs = canonicalCharset; 340a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong } else { 341a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong cache2.put(canonicalName, cs); 342a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong 343a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong for (String alias : cs.aliases()) { 344a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong cache2.put(alias, cs); 345a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong } 346a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong } 347a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong 348a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong cache2.put(charsetName, cs); 349a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong } 350a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong 351a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong cache1 = new AbstractMap.SimpleImmutableEntry<>(charsetName, cs); 35251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 35351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 35451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Creates an iterator that walks over the available providers, ignoring 35551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // those whose lookup or instantiation causes a security exception to be 35651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // thrown. Should be invoked with full privileges. 35751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 358861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera private static Iterator<CharsetProvider> providers() { 359861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera return new Iterator<CharsetProvider>() { 36051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 36151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ServiceLoader<CharsetProvider> sl = 3623c616584fb524f6ae56ceca9beb8d7fabcb5eb1fYi Kong ServiceLoader.load(CharsetProvider.class); 36351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Iterator<CharsetProvider> i = sl.iterator(); 36451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 365861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera CharsetProvider next = null; 36651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 36751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private boolean getNext() { 36851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while (next == null) { 36951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 37051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!i.hasNext()) 37151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 37251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski next = i.next(); 37351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (ServiceConfigurationError sce) { 37451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (sce.getCause() instanceof SecurityException) { 37551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ignore security exceptions 37651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski continue; 37751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 37851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw sce; 37951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 38051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 38151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 38251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 38351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 38451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean hasNext() { 38551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return getNext(); 38651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 38751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 388861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera public CharsetProvider next() { 38951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!getNext()) 39051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NoSuchElementException(); 391861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera CharsetProvider n = next; 39251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski next = null; 39351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return n; 39451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 39551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 39651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void remove() { 39751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new UnsupportedOperationException(); 39851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 39951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 40051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }; 40151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 40251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 40351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Thread-local gate to prevent recursive provider lookups 404861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera private static ThreadLocal<ThreadLocal<?>> gate = 405861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera new ThreadLocal<ThreadLocal<?>>(); 40651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 40751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static Charset lookupViaProviders(final String charsetName) { 40851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 40951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // The runtime startup sequence looks up standard charsets as a 41051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // consequence of the VM's invocation of System.initializeSystemClass 41151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // in order to, e.g., set system properties and encode filenames. At 41251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // that point the application class loader has not been initialized, 41351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // however, so we can't look for providers because doing so will cause 41451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // that loader to be prematurely initialized with incomplete 41551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // information. 41651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 41751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!sun.misc.VM.isBooted()) 41851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 41951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 42051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (gate.get() != null) 42151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Avoid recursive provider lookups 42251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 42351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 42451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski gate.set(gate); 42551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 42651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return AccessController.doPrivileged( 42751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new PrivilegedAction<Charset>() { 42851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Charset run() { 429861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera for (Iterator<CharsetProvider> i = providers(); 430861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera i.hasNext();) { 431861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera CharsetProvider cp = i.next(); 43251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Charset cs = cp.charsetForName(charsetName); 43351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (cs != null) 43451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cs; 43551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 43651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 43751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 43851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }); 43951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 44051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } finally { 44151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski gate.set(null); 44251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 44351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 44451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4456975f84c2ed72e1e26d20190b6f318718c849008Tobias Thierer // Android-removed: Remove support for the extended charset provider. 4469c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // 44751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* The extended set of charsets */ 4489c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static Object extendedProviderLock = new Object(); 4499c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static boolean extendedProviderProbed = false; 4509c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static CharsetProvider extendedProvider = null; 4519c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // 4529c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static void probeExtendedProvider() { 4539c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // AccessController.doPrivileged(new PrivilegedAction<Object>() { 4549c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // public Object run() { 4559c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // try { 4569c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Class epc 4579c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // = Class.forName("sun.nio.cs.ext.ExtendedCharsets"); 4589c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // extendedProvider = (CharsetProvider)epc.newInstance(); 4599c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } catch (ClassNotFoundException x) { 4609c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // // Extended charsets not available 4619c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // // (charsets.jar not present) 4629c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } catch (InstantiationException x) { 4639c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // throw new Error(x); 4649c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } catch (IllegalAccessException x) { 4659c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // throw new Error(x); 4669c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4679c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // return null; 4689c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4699c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // }); 4709c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4719c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // 4729c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // private static Charset lookupExtendedCharset(String charsetName) { 4739c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // CharsetProvider ecp = null; 4749c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // synchronized (extendedProviderLock) { 4759c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // if (!extendedProviderProbed) { 4769c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // probeExtendedProvider(); 4779c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // extendedProviderProbed = true; 4789c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4799c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // ecp = extendedProvider; 4809c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 4819c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // return (ecp != null) ? ecp.charsetForName(charsetName) : null; 4829c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // } 48351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 484a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong // We expect most programs to use one Charset repeatedly, so the most recently used Charset 485a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong // instance is stored in the level 1 cache. We convey a hint to this effect to the VM by putting 486a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong // the level 1 cache miss code in a separate method. Since charsetName is not necessarily in 487a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong // canonical form, we store the mapping from both the canonical name and the aliases to the 488a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong // instance in a map for level 2 cache. 48951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static Charset lookup(String charsetName) { 49051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (charsetName == null) 49151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Null charset name"); 49251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4935769b6580a97194bb4460ece3f9772ba90f93695Narayan Kamath 4945769b6580a97194bb4460ece3f9772ba90f93695Narayan Kamath final Map.Entry<String, Charset> cached = cache1; 4955769b6580a97194bb4460ece3f9772ba90f93695Narayan Kamath if (cached != null && charsetName.equals(cached.getKey())) 4965769b6580a97194bb4460ece3f9772ba90f93695Narayan Kamath return cached.getValue(); 49751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return lookup2(charsetName); 49851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 49951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 50051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static Charset lookup2(String charsetName) { 501a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong Charset cs; 502a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong synchronized (cache2) { 503a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong if ((cs = cache2.get(charsetName)) != null) { 504a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong cache1 = new AbstractMap.SimpleImmutableEntry<>(charsetName, cs); 505a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong return cs; 506a44ea54163e807a3e1ca809ff6fb70d4db4cd76bYi Kong } 50751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 50851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 5099c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Android-changed: Drop support for "standard" and "extended" 5109c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // providers. 511133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski if ((cs = NativeConverter.charsetForName(charsetName)) != null || 51251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski (cs = lookupViaProviders(charsetName)) != null) 51351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 51451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cache(charsetName, cs); 51551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cs; 51651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 51751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 51851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* Only need to check the name if we didn't find a charset for it */ 51951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski checkName(charsetName); 52051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 52151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 52251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 52351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 524861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Tells whether the named charset is supported. 52551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 52651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param charsetName 52751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The name of the requested charset; may be either 52851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a canonical name or an alias 52951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 53051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if, and only if, support for the named charset 53151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is available in the current Java virtual machine 53251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 53351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalCharsetNameException 53451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given charset name is illegal 53551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 53651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException 53751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given <tt>charsetName</tt> is null 53851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 53951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static boolean isSupported(String charsetName) { 54051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (lookup(charsetName) != null); 54151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 54251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 54351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 544861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Returns a charset object for the named charset. 54551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 54651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param charsetName 54751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The name of the requested charset; may be either 54851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a canonical name or an alias 54951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 55051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A charset object for the named charset 55151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 55251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalCharsetNameException 55351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given charset name is illegal 55451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 55551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException 55651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the given <tt>charsetName</tt> is null 55751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 55851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws UnsupportedCharsetException 55951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If no support for the named charset is available 56051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in this instance of the Java virtual machine 56151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 56251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static Charset forName(String charsetName) { 56351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Charset cs = lookup(charsetName); 56451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (cs != null) 56551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return cs; 56651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new UnsupportedCharsetException(charsetName); 56751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 56851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 56916ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak 57016ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak /** 57116ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak * Equivalent to {@code forName} but only throws {@code UnsupportedEncodingException}, 57216ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak * which is all pre-nio code claims to throw. 57316ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak * 57416ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak * @hide internal use only 57516ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak */ 57616ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak public static Charset forNameUEE(String charsetName) throws UnsupportedEncodingException { 57716ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak try { 57816ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak return Charset.forName(charsetName); 57916ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak } catch (Exception cause) { 58016ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak UnsupportedEncodingException ex = new UnsupportedEncodingException(charsetName); 58116ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak ex.initCause(cause); 58216ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak throw ex; 58316ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak } 58416ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak } 58516ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak 58616ad3f07e7ec41d6709d10c71112ff1c077be4e5Przemyslaw Szczepaniak 58751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Fold charsets from the given iterator into the given map, ignoring 58851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // charsets whose names already have entries in the map. 58951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // 59051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static void put(Iterator<Charset> i, Map<String,Charset> m) { 59151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while (i.hasNext()) { 59251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Charset cs = i.next(); 59351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!m.containsKey(cs.name())) 59451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski m.put(cs.name(), cs); 59551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 59651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 59751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 59851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 59951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Constructs a sorted map from canonical charset names to charset objects. 60051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 60151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The map returned by this method will have one entry for each charset 60251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for which support is available in the current Java virtual machine. If 60351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * two or more supported charsets have the same canonical name then the 60451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resulting map will contain just one of them; which one it will contain 60551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is not specified. </p> 60651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 60751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The invocation of this method, and the subsequent use of the 60851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * resulting map, may cause time-consuming disk or network I/O operations 60951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to occur. This method is provided for applications that need to 61051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * enumerate all of the available charsets, for example to allow user 61151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset selection. This method is not used by the {@link #forName 61251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * forName} method, which instead employs an efficient incremental lookup 61351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * algorithm. 61451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 61551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This method may return different results at different times if new 61651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset providers are dynamically made available to the current Java 61751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * virtual machine. In the absence of such changes, the charsets returned 61851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by this method are exactly those that can be retrieved via the {@link 61951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #forName forName} method. </p> 62051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 62151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return An immutable, case-insensitive map from canonical charset names 62251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to charset objects 62351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 62451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static SortedMap<String,Charset> availableCharsets() { 62551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return AccessController.doPrivileged( 62651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new PrivilegedAction<SortedMap<String,Charset>>() { 62751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public SortedMap<String,Charset> run() { 62851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski TreeMap<String,Charset> m = 62951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new TreeMap<String,Charset>( 63051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski ASCIICaseInsensitiveComparator.CASE_INSENSITIVE_ORDER); 631133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski for (String charsetName : NativeConverter.getAvailableCharsetNames()) { 632133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski Charset charset = NativeConverter.charsetForName(charsetName); 633133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski m.put(charset.name(), charset); 634133892a64c416abdb5d19c77ec3194aeb789b34fPiotr Jastrzebski } 6359c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // Android-changed: No more "standard" provider. 6369c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath // put(standardProvider.charsets(), m); 63751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (Iterator i = providers(); i.hasNext();) { 63851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski CharsetProvider cp = (CharsetProvider)i.next(); 63951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski put(cp.charsets(), m); 64051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 64151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return Collections.unmodifiableSortedMap(m); 64251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 64351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }); 64451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 64551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 6469c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath private static Charset defaultCharset; 64751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 64851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 64951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the default charset of this Java virtual machine. 65051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6519dab0f1f61ee1e8401c6abd715b4d0604bdd7305Przemyslaw Szczepaniak * <p>Android note: The Android platform default is always UTF-8. 65251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 65351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A charset object for the default charset 65451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 65551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.5 65651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 65751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public static Charset defaultCharset() { 6586975f84c2ed72e1e26d20190b6f318718c849008Tobias Thierer // Android-changed: Use UTF_8 unconditionally. 6599c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath synchronized (Charset.class) { 6609c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath if (defaultCharset == null) { 6619c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath defaultCharset = java.nio.charset.StandardCharsets.UTF_8; 66268b04a439f8959b4482b89b437abeddb367c2521Narayan Kamath } 6639c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath 6649c67070dd3fb25e9d7ea144b297c81895a93806aNarayan Kamath return defaultCharset; 66568b04a439f8959b4482b89b437abeddb367c2521Narayan Kamath } 66651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 66751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 66851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 66951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* -- Instance fields and methods -- */ 67051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 67151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private final String name; // tickles a bug in oldjavac 67251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private final String[] aliases; // tickles a bug in oldjavac 67351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private Set<String> aliasSet = null; 67451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 67551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 67651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Initializes a new charset with the given canonical name and alias 677861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * set. 67851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 67951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param canonicalName 68051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The canonical name of this charset 68151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 68251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param aliases 68351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * An array of this charset's aliases, or null if it has no aliases 68451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 68551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalCharsetNameException 68651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the canonical name or any of the aliases are illegal 68751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 68851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected Charset(String canonicalName, String[] aliases) { 68951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski checkName(canonicalName); 69051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String[] as = (aliases == null) ? new String[0] : aliases; 69151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; i < as.length; i++) 69251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski checkName(as[i]); 69351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.name = canonicalName; 69451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.aliases = as; 69551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 69651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 69751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 698861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Returns this charset's canonical name. 69951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 70051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The canonical name of this charset 70151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 70251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final String name() { 70351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name; 70451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 70551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 70651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 707861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Returns a set containing this charset's aliases. 70851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 70951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return An immutable set of this charset's aliases 71051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 71151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final Set<String> aliases() { 71251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (aliasSet != null) 71351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return aliasSet; 71451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int n = aliases.length; 71551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski HashSet<String> hs = new HashSet<String>(n); 71651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; i < n; i++) 71751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski hs.add(aliases[i]); 71851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski aliasSet = Collections.unmodifiableSet(hs); 71951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return aliasSet; 72051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 72151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 72251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 72351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns this charset's human-readable name for the default locale. 72451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 72551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The default implementation of this method simply returns this 72651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset's canonical name. Concrete subclasses of this class may 72751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * override this method in order to provide a localized display name. </p> 72851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 72951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The display name of this charset in the default locale 73051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 73151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String displayName() { 73251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name; 73351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 73451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 73551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 73651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether or not this charset is registered in the <a 73751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * href="http://www.iana.org/assignments/character-sets">IANA Charset 738861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Registry</a>. 73951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 74051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if, and only if, this charset is known by its 74151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementor to be registered with the IANA 74251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 74351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final boolean isRegistered() { 74451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return !name.startsWith("X-") && !name.startsWith("x-"); 74551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 74651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 74751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 74851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns this charset's human-readable name for the given locale. 74951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 75051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> The default implementation of this method simply returns this 75151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset's canonical name. Concrete subclasses of this class may 75251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * override this method in order to provide a localized display name. </p> 75351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 75451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param locale 75551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The locale for which the display name is to be retrieved 75651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 75751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The display name of this charset in the given locale 75851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 75951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String displayName(Locale locale) { 76051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name; 76151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 76251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 76351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 76451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether or not this charset contains the given charset. 76551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 76651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> A charset <i>C</i> is said to <i>contain</i> a charset <i>D</i> if, 76751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and only if, every character representable in <i>D</i> is also 76851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * representable in <i>C</i>. If this relationship holds then it is 76951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * guaranteed that every string that can be encoded in <i>D</i> can also be 77051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * encoded in <i>C</i> without performing any replacements. 77151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 77251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> That <i>C</i> contains <i>D</i> does not imply that each character 77351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * representable in <i>C</i> by a particular byte sequence is represented 77451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in <i>D</i> by the same byte sequence, although sometimes this is the 77551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * case. 77651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 77751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Every charset contains itself. 77851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 77951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This method computes an approximation of the containment relation: 78051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If it returns <tt>true</tt> then the given charset is known to be 78151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * contained by this charset; if it returns <tt>false</tt>, however, then 78251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it is not necessarily the case that the given charset is not contained 78351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in this charset. 78451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 785861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * @param cs 786861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * The given charset 787861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * 78851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if the given charset is contained in this charset 78951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 79051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract boolean contains(Charset cs); 79151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 79251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 793861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Constructs a new decoder for this charset. 79451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 79551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A new decoder for this charset 79651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 79751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract CharsetDecoder newDecoder(); 79851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 79951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 800861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Constructs a new encoder for this charset. 80151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 80251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A new encoder for this charset 80351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 80451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws UnsupportedOperationException 80551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If this charset does not support encoding 80651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 80751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public abstract CharsetEncoder newEncoder(); 80851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 80951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 81051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether or not this charset supports encoding. 81151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 81251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Nearly all charsets support encoding. The primary exceptions are 81351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * special-purpose <i>auto-detect</i> charsets whose decoders can determine 81451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * which of several possible encoding schemes is in use by examining the 81551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * input byte sequence. Such charsets do not support encoding because 81651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * there is no way to determine which encoding should be used on output. 81751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implementations of such charsets should override this method to return 81851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>false</tt>. </p> 81951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 82051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if, and only if, this charset supports encoding 82151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 82251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean canEncode() { 82351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 82451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 82551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 82651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 82751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Convenience method that decodes bytes in this charset into Unicode 82851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * characters. 82951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 83051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> An invocation of this method upon a charset <tt>cs</tt> returns the 83151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * same result as the expression 83251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 83351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 83451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cs.newDecoder() 83551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .onMalformedInput(CodingErrorAction.REPLACE) 83651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .onUnmappableCharacter(CodingErrorAction.REPLACE) 83751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .decode(bb); </pre> 83851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 83951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that it is potentially more efficient because it can cache 84051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * decoders between successive invocations. 84151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 84251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This method always replaces malformed-input and unmappable-character 84351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * sequences with this charset's default replacement byte array. In order 84451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to detect such sequences, use the {@link 84551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * CharsetDecoder#decode(java.nio.ByteBuffer)} method directly. </p> 84651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 84751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param bb The byte buffer to be decoded 84851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 84951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A char buffer containing the decoded characters 85051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 85151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final CharBuffer decode(ByteBuffer bb) { 85251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 85351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return ThreadLocalCoders.decoderFor(this) 85451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .onMalformedInput(CodingErrorAction.REPLACE) 85551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .onUnmappableCharacter(CodingErrorAction.REPLACE) 85651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .decode(bb); 85751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (CharacterCodingException x) { 85851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new Error(x); // Can't happen 85951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 86051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 86151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 86251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 86351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Convenience method that encodes Unicode characters into bytes in this 86451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * charset. 86551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 86651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> An invocation of this method upon a charset <tt>cs</tt> returns the 86751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * same result as the expression 86851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 86951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 87051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cs.newEncoder() 87151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .onMalformedInput(CodingErrorAction.REPLACE) 87251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .onUnmappableCharacter(CodingErrorAction.REPLACE) 87351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * .encode(bb); </pre> 87451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 87551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that it is potentially more efficient because it can cache 87651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * encoders between successive invocations. 87751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 87851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> This method always replaces malformed-input and unmappable-character 87951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * sequences with this charset's default replacement string. In order to 88051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * detect such sequences, use the {@link 88151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * CharsetEncoder#encode(java.nio.CharBuffer)} method directly. </p> 88251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 88351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param cb The char buffer to be encoded 88451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 88551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A byte buffer containing the encoded characters 88651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 88751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final ByteBuffer encode(CharBuffer cb) { 88851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 88951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return ThreadLocalCoders.encoderFor(this) 89051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .onMalformedInput(CodingErrorAction.REPLACE) 89151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .onUnmappableCharacter(CodingErrorAction.REPLACE) 89251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski .encode(cb); 89351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (CharacterCodingException x) { 89451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new Error(x); // Can't happen 89551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 89651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 89751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 89851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 89951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Convenience method that encodes a string into bytes in this charset. 90051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 90151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> An invocation of this method upon a charset <tt>cs</tt> returns the 90251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * same result as the expression 90351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 90451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <pre> 90551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cs.encode(CharBuffer.wrap(s)); </pre> 90651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 90751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param str The string to be encoded 90851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 90951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A byte buffer containing the encoded characters 91051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 91151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final ByteBuffer encode(String str) { 91251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return encode(CharBuffer.wrap(str)); 91351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 91451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 91551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 91651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Compares this charset to another. 91751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 91851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Charsets are ordered by their canonical names, without regard to 91951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * case. </p> 92051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 92151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param that 92251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The charset to which this charset is to be compared 92351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 92451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A negative integer, zero, or a positive integer as this charset 92551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is less than, equal to, or greater than the specified charset 92651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 92751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final int compareTo(Charset that) { 92851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (name().compareToIgnoreCase(that.name())); 92951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 93051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 93151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 932861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Computes a hashcode for this charset. 93351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 93451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return An integer hashcode 93551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 93651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final int hashCode() { 93751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name().hashCode(); 93851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 93951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 94051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 94151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Tells whether or not this object is equal to another. 94251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 94351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Two charsets are equal if, and only if, they have the same canonical 94451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * names. A charset is never equal to any other type of object. </p> 94551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 94651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if, and only if, this charset is equal to the 94751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * given object 94851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 94951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final boolean equals(Object ob) { 95051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!(ob instanceof Charset)) 95151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 95251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (this == ob) 95351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 95451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name.equals(((Charset)ob).name()); 95551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 95651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 95751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 958861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera * Returns a string describing this charset. 95951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 96051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return A string describing this charset 96151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 96251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public final String toString() { 96351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name(); 96451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 965861d34f160de8a5f94b2b8b453daca5246052450Shubham Ajmera 96651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 967