org.apache.commons.lang3.CharEncoding Maven / Gradle / Ivy
Show all versions of swagger-all 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;
/**
* 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
* @version $Id: CharEncoding.java 1459653 2013-03-22 07:37:03Z bayard $
*/
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 = "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.
*/
public static final String US_ASCII = "US-ASCII";
/**
* 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 = "UTF-16";
/**
* 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 = "UTF-16BE";
/**
* 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 = "UTF-16LE";
/**
* Eight-bit Unicode Transformation Format.
*
* Every implementation of the Java platform is required to support this character encoding.
*/
public static final String UTF_8 = "UTF-8";
//-----------------------------------------------------------------------
/**
* 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
*/
public static boolean isSupported(final String name) {
if (name == null) {
return false;
}
try {
return Charset.isSupported(name);
} catch (final IllegalCharsetNameException ex) {
return false;
}
}
}