View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.codec.net;
19  
20  /**
21   * Character encoding names required of every implementation of the Java platform.
22   * 
23   * According to the Java documentation <a
24   * href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character encoding names
25   * </a>:
26   * <p>
27   * <cite>Every implementation of the Java platform is required to support the following character encodings. Consult the
28   * release documentation for your implementation to see if any other encodings are supported. </cite>
29   * </p>
30   * 
31   * This interface is private to the package since it perhaps would best belong in the [lang] project with other required
32   * encoding names. As is, this interface only defines the names used in this package. Even if a similar interface is
33   * defined in [lang], it is not forseen that [codec] would be made to depend on [lang].
34   * 
35   * @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character encoding
36   *          names </a>
37   * @author Apache Software Foundation
38   * @since 1.4
39   * @version $Id: CharacterEncodingNames.java 480406 2006-11-29 04:56:58Z bayard $
40   */
41  class CharacterEncodingNames {
42      /**
43       * <p>
44       * Seven-bit ASCII, also known as ISO646-US, also known as the Basic Latin block of the Unicode character set.
45       * </p>
46       * <p>
47       * Every implementation of the Java platform is required to support this character encoding.
48       * </p>
49       * 
50       * @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
51       *          encoding names </a>
52       */
53      static final String US_ASCII = "US-ASCII";
54  
55      /**
56       * <p>
57       * Eight-bit Unicode Transformation Format.
58       * </p>
59       * <p>
60       * Every implementation of the Java platform is required to support this character encoding.
61       * </p>
62       * 
63       * @see <a href="http://java.sun.com/j2se/1.3/docs/api/java/lang/package-summary.html#charenc">JRE character
64       *          encoding names </a>
65       */
66      static final String UTF8 = "UTF-8";
67  }