001/*
002 * Copyright (C) 2007 The Guava Authors
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
005 * in compliance with the License. You may obtain a copy of the License at
006 *
007 * http://www.apache.org/licenses/LICENSE-2.0
008 *
009 * Unless required by applicable law or agreed to in writing, software distributed under the License
010 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
011 * or implied. See the License for the specific language governing permissions and limitations under
012 * the License.
013 */
014
015package com.google.common.base;
016
017import com.google.common.annotations.GwtCompatible;
018import com.google.common.annotations.GwtIncompatible;
019import com.google.common.annotations.J2ktIncompatible;
020import java.nio.charset.Charset;
021import java.nio.charset.StandardCharsets;
022
023/**
024 * Contains constant definitions for the six standard {@link Charset} instances, which are
025 * guaranteed to be supported by all Java platform implementations.
026 *
027 * <p>Assuming you're free to choose, note that <b>{@link #UTF_8} is widely preferred</b>.
028 *
029 * <p>See the Guava User Guide article on <a
030 * href="https://github.com/google/guava/wiki/StringsExplained#charsets">{@code Charsets}</a>.
031 *
032 * @author Mike Bostock
033 * @since 1.0
034 */
035@GwtCompatible(emulated = true)
036public final class Charsets {
037
038  /**
039   * US-ASCII: seven-bit ASCII, the Basic Latin block of the Unicode character set (ISO646-US).
040   *
041   * @deprecated Use {@link StandardCharsets#US_ASCII} instead.
042   */
043  @Deprecated @J2ktIncompatible @GwtIncompatible // Charset not supported by GWT
044  public static final Charset US_ASCII = StandardCharsets.US_ASCII;
045
046  /**
047   * ISO-8859-1: ISO Latin Alphabet Number 1 (ISO-LATIN-1).
048   *
049   * @deprecated Use {@link StandardCharsets#ISO_8859_1} instead.
050   */
051  @Deprecated public static final Charset ISO_8859_1 = StandardCharsets.ISO_8859_1;
052
053  /**
054   * UTF-8: eight-bit UCS Transformation Format.
055   *
056   * @deprecated Use {@link StandardCharsets#UTF_8} instead.
057   */
058  @Deprecated public static final Charset UTF_8 = StandardCharsets.UTF_8;
059
060  /**
061   * UTF-16BE: sixteen-bit UCS Transformation Format, big-endian byte order.
062   *
063   * @deprecated Use {@link StandardCharsets#UTF_16BE} instead.
064   */
065  @Deprecated @J2ktIncompatible @GwtIncompatible // Charset not supported by GWT
066  public static final Charset UTF_16BE = StandardCharsets.UTF_16BE;
067
068  /**
069   * UTF-16LE: sixteen-bit UCS Transformation Format, little-endian byte order.
070   *
071   * @deprecated Use {@link StandardCharsets#UTF_16LE} instead.
072   */
073  @Deprecated @J2ktIncompatible @GwtIncompatible // Charset not supported by GWT
074  public static final Charset UTF_16LE = StandardCharsets.UTF_16LE;
075
076  /**
077   * UTF-16: sixteen-bit UCS Transformation Format, byte order identified by an optional byte-order
078   * mark.
079   *
080   * @deprecated Use {@link StandardCharsets#UTF_16} instead.
081   */
082  @Deprecated @J2ktIncompatible @GwtIncompatible // Charset not supported by GWT
083  public static final Charset UTF_16 = StandardCharsets.UTF_16;
084
085  private Charsets() {}
086}