Java example source code file (Charsets.java)

This example Java source code file (Charsets.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

charset, charsets, gwtcompatible, gwtincompatible, iso-8859-1, iso_8859_1, non-utf-8, us-ascii, us_ascii, utf-16, utf-16be, utf-16le, utf_16be, utf_16le

The Charsets.java Java example source code

/*
 * Copyright (C) 2007 The Guava Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.common.base;

import com.google.common.annotations.GwtCompatible;
import com.google.common.annotations.GwtIncompatible;

import java.nio.charset.Charset;

/**
 * Contains constant definitions for the six standard {@link Charset} instances, which are
 * guaranteed to be supported by all Java platform implementations.
 *
 * <p>Assuming you're free to choose, note that {@link #UTF_8} is widely preferred.
 *
 * <p>See the Guava User Guide article on
 * <a href="https://github.com/google/guava/wiki/StringsExplained#charsets">{@code Charsets}.
 *
 * @author Mike Bostock
 * @since 1.0
 */
@GwtCompatible(emulated = true)
public final class Charsets {
  private Charsets() {}

  /**
   * US-ASCII: seven-bit ASCII, the Basic Latin block of the Unicode character set (ISO646-US).
   *
   * <p>Note for Java 7 and later: this constant should be treated as deprecated; use
   * {@link java.nio.charset.StandardCharsets#US_ASCII} instead.
   *
   */
  @GwtIncompatible // Non-UTF-8 Charset
  public static final Charset US_ASCII = Charset.forName("US-ASCII");

  /**
   * ISO-8859-1: ISO Latin Alphabet Number 1 (ISO-LATIN-1).
   *
   * <p>Note for Java 7 and later: this constant should be treated as deprecated; use
   * {@link java.nio.charset.StandardCharsets#ISO_8859_1} instead.
   *
   */
  @GwtIncompatible // Non-UTF-8 Charset
  public static final Charset ISO_8859_1 = Charset.forName("ISO-8859-1");

  /**
   * UTF-8: eight-bit UCS Transformation Format.
   *
   * <p>Note for Java 7 and later: this constant should be treated as deprecated; use
   * {@link java.nio.charset.StandardCharsets#UTF_8} instead.
   *
   */
  public static final Charset UTF_8 = Charset.forName("UTF-8");

  /**
   * UTF-16BE: sixteen-bit UCS Transformation Format, big-endian byte order.
   *
   * <p>Note for Java 7 and later: this constant should be treated as deprecated; use
   * {@link java.nio.charset.StandardCharsets#UTF_16BE} instead.
   *
   */
  @GwtIncompatible // Non-UTF-8 Charset
  public static final Charset UTF_16BE = Charset.forName("UTF-16BE");

  /**
   * UTF-16LE: sixteen-bit UCS Transformation Format, little-endian byte order.
   *
   * <p>Note for Java 7 and later: this constant should be treated as deprecated; use
   * {@link java.nio.charset.StandardCharsets#UTF_16LE} instead.
   *
   */
  @GwtIncompatible // Non-UTF-8 Charset
  public static final Charset UTF_16LE = Charset.forName("UTF-16LE");

  /**
   * UTF-16: sixteen-bit UCS Transformation Format, byte order identified by an optional byte-order
   * mark.
   *
   * <p>Note for Java 7 and later: this constant should be treated as deprecated; use
   * {@link java.nio.charset.StandardCharsets#UTF_16} instead.
   *
   */
  @GwtIncompatible // Non-UTF-8 Charset
  public static final Charset UTF_16 = Charset.forName("UTF-16");

  /*
   * Please do not add new Charset references to this class, unless those character encodings are
   * part of the set required to be supported by all Java platform implementations! Any Charsets
   * initialized here may cause unexpected delays when this class is loaded. See the Charset
   * Javadocs for the list of built-in character encodings.
   */
}