    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *   http://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 *
    017 */
    018
    019package org.apache.commons.compress.utils;
    020
    021/**
    022 * Character encoding names required of every implementation of the Java platform.
    023 *
    024 * From the Java documentation <a href="https://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard
    025 * charsets</a>:
    026 * <p>
    027 * <cite>Every implementation of the Java platform is required to support the following character encodings. Consult the
    028 * release documentation for your implementation to see if any other encodings are supported. Consult the release
    029 * documentation for your implementation to see if any other encodings are supported. </cite>
    030 * </p>
    031 *
    032 * <dl>
    033 * <dt>{@code US-ASCII}</dt>
    034 * <dd>Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.</dd>
    035 * <dt>{@code ISO-8859-1}</dt>
    036 * <dd>ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.</dd>
    037 * <dt>{@code UTF-8}</dt>
    038 * <dd>Eight-bit Unicode Transformation Format.</dd>
    039 * <dt>{@code UTF-16BE}</dt>
    040 * <dd>Sixteen-bit Unicode Transformation Format, big-endian byte order.</dd>
    041 * <dt>{@code UTF-16LE}</dt>
    042 * <dd>Sixteen-bit Unicode Transformation Format, little-endian byte order.</dd>
    043 * <dt>{@code UTF-16}</dt>
    044 * <dd>Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
    045 * accepted on input, big-endian used on output.)</dd>
    046 * </dl>
    047 *
    048 * <p>This perhaps would best belong in the [lang] project. Even if a similar interface is defined in [lang], it is not
    049 * foreseen that [compress] would be made to depend on [lang].</p>
    050 *
    051 * @see <a href="https://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
    052 * @since 1.4
    053 */
    054public class CharsetNames {
    055    /**
    056     * CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
    057     * <p>
    058     * Every implementation of the Java platform is required to support this character encoding.
    059     * </p>
    060     *
    061     * @see <a href="https://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
    062     */
    063    public static final String ISO_8859_1 = "ISO-8859-1";
    064
    065    /**
    066     * <p>
    067     * Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
    068     * </p>
    069     * <p>
    070     * Every implementation of the Java platform is required to support this character encoding.
    071     * </p>
    072     *
    073     * @see <a href="https://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
    074     */
    075    public static final String US_ASCII = "US-ASCII";
    076
    077    /**
    078     * <p>
    079     * Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark
    080     * (either order accepted on input, big-endian used on output)
    081     * </p>
    082     * <p>
    083     * Every implementation of the Java platform is required to support this character encoding.
    084     * </p>
    085     *
    086     * @see <a href="https://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
    087     */
    088    public static final String UTF_16 = "UTF-16";
    089
    090    /**
    091     * <p>
    092     * Sixteen-bit Unicode Transformation Format, big-endian byte order.
    093     * </p>
    094     * <p>
    095     * Every implementation of the Java platform is required to support this character encoding.
    096     * </p>
    097     *
    098     * @see <a href="https://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
    099     */
    100    public static final String UTF_16BE = "UTF-16BE";
    101
    102    /**
    103     * <p>
    104     * Sixteen-bit Unicode Transformation Format, little-endian byte order.
    105     * </p>
    106     * <p>
    107     * Every implementation of the Java platform is required to support this character encoding.
    108     * </p>
    109     *
    110     * @see <a href="https://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
    111     */
    112    public static final String UTF_16LE = "UTF-16LE";
    113
    114    /**
    115     * <p>
    116     * Eight-bit Unicode Transformation Format.
    117     * </p>
    118     * <p>
    119     * Every implementation of the Java platform is required to support this character encoding.
    120     * </p>
    121     *
    122     * @see <a href="https://download.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
    123     */
    124    public static final String UTF_8 = "UTF-8";
    125}