org.apache.commons.lang3.CharEncoding Maven / Gradle / Ivy
Show all versions of commons-lang3 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.lang3;
import java.nio.charset.Charset;
import java.nio.charset.IllegalCharsetNameException;
import java.nio.charset.StandardCharsets;
/**
* Character encoding names required of every implementation of the Java platform.
*
* According to JRE character
* encoding names:
*
* 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.
*
*
* @see JRE character encoding names
* @since 2.1
* @deprecated Java 7 introduced {@link java.nio.charset.StandardCharsets}, which defines these constants as
* {@link Charset} objects. Use {@link Charset#name()} to get the string values provided in this class.
* This class will be removed in a future release.
*/
@Deprecated
public class CharEncoding {
/**
* ISO Latin Alphabet #1, also known as ISO-LATIN-1.
*
* Every implementation of the Java platform is required to support this character encoding.
*/
public static final String ISO_8859_1 = StandardCharsets.ISO_8859_1.name();
/**
* 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.
*/
public static final String US_ASCII = StandardCharsets.US_ASCII.name();
/**
* 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).
*
* Every implementation of the Java platform is required to support this character encoding.
*/
public static final String UTF_16 = StandardCharsets.UTF_16.name();
/**
* Sixteen-bit Unicode Transformation Format, big-endian byte order.
*
* Every implementation of the Java platform is required to support this character encoding.
*/
public static final String UTF_16BE = StandardCharsets.UTF_16BE.name();
/**
* Sixteen-bit Unicode Transformation Format, little-endian byte order.
*
* Every implementation of the Java platform is required to support this character encoding.
*/
public static final String UTF_16LE = StandardCharsets.UTF_16LE.name();
/**
* Eight-bit Unicode Transformation Format.
*
* Every implementation of the Java platform is required to support this character encoding.
*/
public static final String UTF_8 = StandardCharsets.UTF_8.name();
/**
* Returns whether the named charset is supported.
*
* This is similar to
* java.nio.charset.Charset.isSupported(String) but handles more formats
*
* @param name the name of the requested charset; may be either a canonical name or an alias, null returns false
* @return {@code true} if the charset is available in the current Java virtual machine
* @deprecated Please use {@link Charset#isSupported(String)} instead, although be aware that {@code null}
* values are not accepted by that method and an {@link IllegalCharsetNameException} may be thrown.
*/
@Deprecated
public static boolean isSupported(final String name) {
if (name == null) {
return false;
}
try {
return Charset.isSupported(name);
} catch (final IllegalCharsetNameException ex) {
return false;
}
}
}