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 * http://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.codec;
19
20 /**
21 * Character encoding names required of every implementation of the Java platform.
22 *
23 * From the Java documentation <a
24 * href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>:
25 * <p>
26 * <cite>Every implementation of the Java platform is required to support the following character encodings. Consult the
27 * release documentation for your implementation to see if any other encodings are supported. Consult the release
28 * documentation for your implementation to see if any other encodings are supported.</cite>
29 * </p>
30 *
31 * <ul>
32 * <li><code>US-ASCII</code><br/>
33 * Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</li>
34 * <li><code>ISO-8859-1</code><br/>
35 * ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</li>
36 * <li><code>UTF-8</code><br/>
37 * Eight-bit Unicode Transformation Format.</li>
38 * <li><code>UTF-16BE</code><br/>
39 * Sixteen-bit Unicode Transformation Format, big-endian byte order.</li>
40 * <li><code>UTF-16LE</code><br/>
41 * Sixteen-bit Unicode Transformation Format, little-endian byte order.</li>
42 * <li><code>UTF-16</code><br/>
43 * Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
44 * accepted on input, big-endian used on output.)</li>
45 * </ul>
46 *
47 * This perhaps would best belong in the [lang] project. Even if a similar interface is defined in [lang], it is not
48 * foreseen that [codec] would be made to depend on [lang].
49 *
50 * <p>
51 * This class is immutable and thread-safe.
52 * </p>
53 *
54 * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
55 * @since 1.4
56 * @version $Id$
57 */
58 public class CharEncoding {
59 /**
60 * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
61 * <p>
62 * Every implementation of the Java platform is required to support this character encoding.
63 *
64 * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
65 */
66 public static final String ISO_8859_1 = "ISO-8859-1";
67
68 /**
69 * Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
70 * <p>
71 * Every implementation of the Java platform is required to support this character encoding.
72 *
73 * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
74 */
75 public static final String US_ASCII = "US-ASCII";
76
77 /**
78 * Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark
79 * (either order accepted on input, big-endian used on output)
80 * <p>
81 * Every implementation of the Java platform is required to support this character encoding.
82 *
83 * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
84 */
85 public static final String UTF_16 = "UTF-16";
86
87 /**
88 * Sixteen-bit Unicode Transformation Format, big-endian byte order.
89 * <p>
90 * Every implementation of the Java platform is required to support this character encoding.
91 *
92 * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
93 */
94 public static final String UTF_16BE = "UTF-16BE";
95
96 /**
97 * Sixteen-bit Unicode Transformation Format, little-endian byte order.
98 * <p>
99 * Every implementation of the Java platform is required to support this character encoding.
100 *
101 * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
102 */
103 public static final String UTF_16LE = "UTF-16LE";
104
105 /**
106 * Eight-bit Unicode Transformation Format.
107 * <p>
108 * Every implementation of the Java platform is required to support this character encoding.
109 *
110 * @see <a href="http://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
111 */
112 public static final String UTF_8 = "UTF-8";
113 }