org.apache.commons.codec.Charsets Maven / Gradle / Ivy
Show all versions of commons-codec Show documentation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.commons.codec;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
/**
* Charsets required of every implementation of the Java platform.
*
* From the Java documentation Standard
* charsets:
*
* Every implementation of the Java platform is required to support the following character encodings. Consult the
* release documentation for your implementation to see if any other encodings are supported. Consult the release
* documentation for your implementation to see if any other encodings are supported.
*
*
*
* - {@code US-ASCII}
* Seven-bit ASCII, a.k.a. ISO646-US, a.k.a. the Basic Latin block of the Unicode character set.
* - {@code ISO-8859-1}
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
* - {@code UTF-8}
* Eight-bit Unicode Transformation Format.
* - {@code UTF-16BE}
* Sixteen-bit Unicode Transformation Format, big-endian byte order.
* - {@code UTF-16LE}
* Sixteen-bit Unicode Transformation Format, little-endian byte order.
* - {@code UTF-16}
* Sixteen-bit Unicode Transformation Format, byte order specified by a mandatory initial byte-order mark (either order
* accepted on input, big-endian used on output.)
*
*
* This perhaps would best belong in the Commons Lang project. Even if a similar class is defined in Commons Lang, it is
* not foreseen that Commons Codec would be made to depend on Commons Lang.
*
*
* This class is immutable and thread-safe.
*
*
* @see Standard charsets
* @since 1.7
*/
public class Charsets {
//
// This class should only contain Charset instances for required encodings. This guarantees that it will load
// correctly and without delay on all Java platforms.
//
/**
* CharEncodingISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
*
* Every implementation of the Java platform is required to support this character encoding.
*
*
* @deprecated Use {@link java.nio.charset.StandardCharsets#ISO_8859_1} instead.
* @see Standard charsets
*/
@Deprecated
public static final Charset ISO_8859_1 = StandardCharsets.ISO_8859_1;
/**
* Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
*
* Every implementation of the Java platform is required to support this character encoding.
*
*
* @deprecated Use {@link java.nio.charset.StandardCharsets#US_ASCII} instead.
* @see Standard charsets
*/
@Deprecated
public static final Charset US_ASCII = StandardCharsets.US_ASCII;
/**
* Sixteen-bit Unicode Transformation Format, The byte order specified by a mandatory initial byte-order mark
* (either order accepted on input, big-endian used on output)
*
* Every implementation of the Java platform is required to support this character encoding.
*
*
* @deprecated Use {@link java.nio.charset.StandardCharsets#UTF_16} instead.
* @see Standard charsets
*/
@Deprecated
public static final Charset UTF_16 = StandardCharsets.UTF_16;
/**
* Sixteen-bit Unicode Transformation Format, big-endian byte order.
*
* Every implementation of the Java platform is required to support this character encoding.
*
*
* @deprecated Use {@link java.nio.charset.StandardCharsets#UTF_16BE} instead.
* @see Standard charsets
*/
@Deprecated
public static final Charset UTF_16BE = StandardCharsets.UTF_16BE;
/**
* Sixteen-bit Unicode Transformation Format, little-endian byte order.
*
* Every implementation of the Java platform is required to support this character encoding.
*
*
* @deprecated Use {@link java.nio.charset.StandardCharsets#UTF_16LE} instead.
* @see Standard charsets
*/
@Deprecated
public static final Charset UTF_16LE = StandardCharsets.UTF_16LE;
/**
* Eight-bit Unicode Transformation Format.
*
* Every implementation of the Java platform is required to support this character encoding.
*
*
* @deprecated Use {@link java.nio.charset.StandardCharsets#UTF_8} instead.
* @see Standard charsets
*/
@Deprecated
public static final Charset UTF_8 = StandardCharsets.UTF_8;
/**
* Returns the given Charset or the default Charset if the given Charset is null.
*
* @param charset
* A charset or null.
* @return the given Charset or the default Charset if the given Charset is null
*/
public static Charset toCharset(final Charset charset) {
return charset == null ? Charset.defaultCharset() : charset;
}
/**
* Returns a Charset for the named charset. If the name is null, return the default Charset.
*
* @param charset
* The name of the requested charset, may be null.
* @return a Charset for the named charset
* @throws java.nio.charset.UnsupportedCharsetException
* If the named charset is unavailable
*/
public static Charset toCharset(final String charset) {
return charset == null ? Charset.defaultCharset() : Charset.forName(charset);
}
}