scolebourne 2004/10/06 14:40:09
Modified: lang/src/java/org/apache/commons/lang CharEncoding.java
Log:
Javadoc
Revision Changes Path
1.2 +16 -30
jakarta-commons/lang/src/java/org/apache/commons/lang/CharEncoding.java
Index: CharEncoding.java
===================================================================
RCS file:
/home/cvs/jakarta-commons/lang/src/java/org/apache/commons/lang/CharEncoding.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CharEncoding.java 2 Oct 2004 01:46:29 -0000 1.1
+++ CharEncoding.java 6 Oct 2004 21:40:09 -0000 1.2
@@ -19,20 +19,15 @@
import java.io.UnsupportedEncodingException;
/**
- * TODO: Accept/Reject for 2.1.
+ * <p>Character encoding names required of every implementation of the Java
platform.</p>
*
- * 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>
+ * <p>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>:<br />
* <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>
+ * @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$
@@ -47,8 +42,7 @@
* 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>
+ * @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";
@@ -60,8 +54,7 @@
* 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>
+ * @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";
@@ -74,8 +67,7 @@
* 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>
+ * @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";
@@ -87,8 +79,7 @@
* 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>
+ * @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";
@@ -100,8 +91,7 @@
* 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>
+ * @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";
@@ -113,8 +103,7 @@
* 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>
+ * @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";
@@ -123,17 +112,14 @@
* 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>
+ * 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
+ * @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>
+ * @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) {
@@ -147,4 +133,4 @@
return true;
}
-}
\ No newline at end of file
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
