Bugzilla Bug 30334

[lang] New class proposal: CharacterEncoding
	http://issues.apache.org/bugzilla/show_bug.cgi?id=30334
	Comitted to CVS for further comments.


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@137889 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Gary D. Gregory 2004-08-03 17:17:08 +00:00
parent 1f9d273472
commit 8b6499b395
2 changed files with 250 additions and 0 deletions

View File

@ -0,0 +1,150 @@
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* 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 org.apache.commons.lang;
import java.io.UnsupportedEncodingException;
/**
* TODO: Accept/Reject for 2.1.
*
* Character encoding names required of every implementation of the Java platform.
*
* According to the Java documentation <a
* href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character encoding names
* </a>:
* <p>
* <cite>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. </cite>
* </p>
*
* @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character encoding
* names </a>
* @author Apache Software Foundation
* @since 2.1
* @version $Id: CharacterEncoding.java,v 1.1 2004/08/03 17:15:32 ggregory Exp $
*/
public class CharacterEncoding {
/**
* <p>
* ISO Latin Alphabet No. 1, a.k.a. ISO-LATIN-1.
* </p>
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
* encoding names </a>
*/
public static final String ISO_8859_1 = "ISO-8859-1";
/**
* <p>
* Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
* </p>
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
* encoding names </a>
*/
public static final String US_ASCII = "US-ASCII";
/**
* <p>
* 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).
* </p>
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
* encoding names </a>
*/
public static final String UTF_16 = "UTF-16";
/**
* <p>
* Sixteen-bit Unicode Transformation Format, big-endian byte order.
* </p>
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
* encoding names </a>
*/
public static final String UTF_16BE = "UTF-16BE";
/**
* <p>
* Sixteen-bit Unicode Transformation Format, little-endian byte order.
* </p>
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
* encoding names </a>
*/
public static final String UTF_16LE = "UTF-16LE";
/**
* <p>
* Eight-bit Unicode Transformation Format.
* </p>
* <p>
* Every implementation of the Java platform is required to support this character encoding.
* </p>
*
* @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
* encoding names </a>
*/
public static final String UTF_8 = "UTF-8";
/**
* <p>
* Returns whether the named charset is supported.
* </p>
* <p>
* This is similar to <a
* href="http://java.sun.com/j2se/1.4.2/docs/api/java/nio/charset/Charset.html#isSupported(java.lang.String)">java.nio.charset.Charset.isSupported(String)
* </a>
* </p>
*
* @param name
* The name of the requested charset; may be either a canonical name or an alias
* @return <code>true</code> if, and only if, support for the named charset is available in the current Java virtual machine
*
* @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
* encoding names </a>
*/
public static boolean isSupported(String name) {
if (name == null) {
return false;
}
try {
new String(ArrayUtils.EMPTY_BYTE_ARRAY, name);
} catch (UnsupportedEncodingException e) {
return false;
}
return true;
}
}

View File

@ -0,0 +1,100 @@
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* 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 org.apache.commons.lang;
import junit.framework.Test;
import junit.framework.TestCase;
import junit.framework.TestSuite;
import junit.textui.TestRunner;
/**
* Tests CharacterEncoding.
*
* @see CharacterEncoding
* @author Gary D. Gregory
* @version $Id: CharacterEncodingTest.java,v 1.1 2004/08/03 17:17:08 ggregory Exp $
*/
public class CharacterEncodingTest extends TestCase {
public static void main(String[] args) {
TestRunner.run(suite());
}
public static Test suite() {
TestSuite suite = new TestSuite(CharacterEncodingTest.class);
suite.setName("CharacterEncoding Tests");
return suite;
}
private void assertSupportedEncoding(String name) {
assertTrue("Encoding should be supported: " + name, CharacterEncoding.isSupported(name));
}
public void testMustBeSupportedJava1_3_1() {
if (SystemUtils.isJavaVersionAtLeast(1.3f)) {
this.assertSupportedEncoding(CharacterEncoding.ISO_8859_1);
this.assertSupportedEncoding(CharacterEncoding.US_ASCII);
this.assertSupportedEncoding(CharacterEncoding.UTF_16);
this.assertSupportedEncoding(CharacterEncoding.UTF_16BE);
this.assertSupportedEncoding(CharacterEncoding.UTF_16LE);
this.assertSupportedEncoding(CharacterEncoding.UTF_8);
} else {
this.warn("Java 1.3 tests not run since the current version is " + SystemUtils.JAVA_VERSION);
}
}
public void testNotSupported() {
assertFalse(CharacterEncoding.isSupported(null));
assertFalse(CharacterEncoding.isSupported(""));
assertFalse(CharacterEncoding.isSupported(" "));
assertFalse(CharacterEncoding.isSupported("\t\r\n"));
assertFalse(CharacterEncoding.isSupported("DOESNOTEXIST"));
assertFalse(CharacterEncoding.isSupported("this is not a valid encoding name"));
}
public void testWorksOnJava1_1_8() {
//
// In this test, I simply deleted the encodings from the 1.3.1 list.
// The Javadoc do not specify which encodings are required.
//
if (SystemUtils.isJavaVersionAtLeast(1.1f)) {
this.assertSupportedEncoding(CharacterEncoding.ISO_8859_1);
this.assertSupportedEncoding(CharacterEncoding.US_ASCII);
this.assertSupportedEncoding(CharacterEncoding.UTF_8);
} else {
this.warn("Java 1.1 tests not run since the current version is " + SystemUtils.JAVA_VERSION);
}
}
public void testWorksOnJava1_2_2() {
//
// In this test, I simply deleted the encodings from the 1.3.1 list.
// The Javadoc do not specify which encodings are required.
//
if (SystemUtils.isJavaVersionAtLeast(1.2f)) {
this.assertSupportedEncoding(CharacterEncoding.ISO_8859_1);
this.assertSupportedEncoding(CharacterEncoding.US_ASCII);
this.assertSupportedEncoding(CharacterEncoding.UTF_8);
} else {
this.warn("Java 1.2 tests not run since the current version is " + SystemUtils.JAVA_VERSION);
}
}
void warn(String msg) {
System.err.println(msg);
}
}