1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.lang3;
19
20 import java.nio.charset.Charset;
21 import java.nio.charset.IllegalCharsetNameException;
22 import java.nio.charset.StandardCharsets;
23
24 /**
25 * Character encoding names required of every implementation of the Java platform.
26 *
27 * <p>
28 * According to <a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html">JRE character
29 * encoding names</a>:
30 * </p>
31 *
32 * <p>
33 * <cite>Every implementation of the Java platform is required to support the following character encodings.
34 * Consult the release documentation for your implementation to see if any other encodings are supported.
35 * </cite>
36 * </p>
37 *
38 * @see <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html">JRE character encoding names</a>
39 * @since 2.1
40 * @deprecated Java 7 introduced {@link java.nio.charset.StandardCharsets}, which defines these constants as
41 * {@link Charset} objects. Use {@link Charset#name()} to get the string values provided in this class.
42 * This class will be removed in a future release.
43 */
44 @Deprecated
45 public class CharEncoding {
46
47 /**
48 * ISO Latin Alphabet #1, also known as ISO-LATIN-1.
49 *
50 * <p>
51 * Every implementation of the Java platform is required to support this character encoding.
52 * </p>
53 */
54 public static final String ISO_8859_1 = StandardCharsets.ISO_8859_1.name();
55
56 /**
57 * Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block
58 * of the Unicode character set.
59 *
60 * <p>
61 * Every implementation of the Java platform is required to support this character encoding.
62 * </p>
63 */
64 public static final String US_ASCII = StandardCharsets.US_ASCII.name();
65
66 /**
67 * Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial
68 * byte-order mark (either order accepted on input, big-endian used on output).
69 *
70 * <p>
71 * Every implementation of the Java platform is required to support this character encoding.
72 * </p>
73 */
74 public static final String UTF_16 = StandardCharsets.UTF_16.name();
75
76 /**
77 * Sixteen-bit Unicode Transformation Format, big-endian byte order.
78 *
79 * <p>
80 * Every implementation of the Java platform is required to support this character encoding.
81 * </p>
82 */
83 public static final String UTF_16BE = StandardCharsets.UTF_16BE.name();
84
85 /**
86 * Sixteen-bit Unicode Transformation Format, little-endian byte order.
87 *
88 * <p>
89 * Every implementation of the Java platform is required to support this character encoding.
90 * </p>
91 */
92 public static final String UTF_16LE = StandardCharsets.UTF_16LE.name();
93
94 /**
95 * Eight-bit Unicode Transformation Format.
96 *
97 * <p>
98 * Every implementation of the Java platform is required to support this character encoding.
99 * </p>
100 */
101 public static final String UTF_8 = StandardCharsets.UTF_8.name();
102
103 /**
104 * Tests whether the named charset is supported.
105 *
106 * <p>
107 * This is similar to <a
108 * href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html#isSupported%28java.lang.String%29">
109 * java.nio.charset.Charset.isSupported(String)</a> but handles more formats
110 * </p>
111 *
112 * @param name The name of the requested charset; may be either a canonical name or an alias, null returns false
113 * @return {@code true} if the charset is available in the current Java virtual machine
114 * @deprecated Please use {@link Charset#isSupported(String)} instead, although be aware that {@code null}
115 * values are not accepted by that method and an {@link IllegalCharsetNameException} may be thrown.
116 */
117 @Deprecated
118 public static boolean isSupported(final String name) {
119 if (name == null) {
120 return false;
121 }
122 try {
123 return Charset.isSupported(name);
124 } catch (final IllegalCharsetNameException ex) {
125 return false;
126 }
127 }
128
129 /**
130 * Constructs a new instance.
131 *
132 * @deprecated Will be removed in 4.0.0.
133 */
134 @Deprecated
135 public CharEncoding() {
136 // empty
137 }
138 }