java.net.URLDecoder Maven / Gradle / Ivy
/*
This is not an official specification document, and usage is restricted.
NOTICE
(c) 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
Neither this file nor any files generated from it describe a complete
specification, and they may only be used as described below. For
example, no permission is given for you to incorporate this file, in
whole or in part, in an implementation of a Java specification.
Sun Microsystems Inc. owns the copyright in this file and it is provided
to you for informative, as opposed to normative, use. The file and any
files generated from it may be used to generate other informative
documentation, such as a unified set of documents of API signatures for
a platform that includes technologies expressed as Java APIs. The file
may also be used to produce "compilation stubs," which allow
applications to be compiled and validated for such platforms.
Any work generated from this file, such as unified javadocs or compiled
stub files, must be accompanied by this notice in its entirety.
This work corresponds to the API signatures of JSR 219: Foundation
Profile 1.1. In the event of a discrepency between this work and the
JSR 219 specification, which is available at
http://www.jcp.org/en/jsr/detail?id=219, the latter takes precedence.
*/
package java.net;
import java.io.*;
/**
* Utility class for HTML form decoding. This class contains static methods
* for decoding a String from the application/x-www-form-urlencoded
* MIME format.
*
* To conversion process is the reverse of that used by the URLEncoder class. It is assumed
* that all characters in the encoded string are one of the following:
* "a" through "z",
* "A" through "Z",
* "0" through "9", and
* "-", "_",
* ".", and "*". The
* character "%" is allowed but is interpreted
* as the start of a special escaped sequence.
*
* The following rules are applied in the conversion:
*
*
* - The alphanumeric characters "
a" through
* "z", "A" through
* "Z" and "0"
* through "9" remain the same.
* - The special characters "
.",
* "-", "*", and
* "_" remain the same.
* - The plus sign "
+" is converted into a
* space character " " .
* - A sequence of the form "
%xy" will be
* treated as representing a byte where xy is the two-digit
* hexadecimal representation of the 8 bits. Then, all substrings
* that contain one or more of these byte sequences consecutively
* will be replaced by the character(s) whose encoding would result
* in those consecutive bytes.
* The encoding scheme used to decode these characters may be specified,
* or if unspecified, the default encoding of the platform will be used.
*
*
* There are two possible ways in which this decoder could deal with
* illegal strings. It could either leave illegal characters alone or
* it could throw an {@link java.lang.IllegalArgumentException}.
* Which approach the decoder takes is left to the
* implementation.
*
* @author Mark Chamness
* @author Michael McCloskey
* @version 1.9, 02/02/00
* @since 1.2
*/
public class URLDecoder
{
public URLDecoder() { }
/**
* Decodes a x-www-form-urlencoded string.
* The platform's default encoding is used to determine what characters
* are represented by any consecutive sequences of the form
* "%xy".
* @param s the String to decode
* @deprecated The resulting string may vary depending on the platform's
* default encoding. Instead, use the decode(String,String) method
* to specify the encoding.
* @return the newly decoded String
*/
public static String decode(String s) {
return null;
}
/**
* Decodes a application/x-www-form-urlencoded string using a specific
* encoding scheme.
* The supplied encoding is used to determine
* what characters are represented by any consecutive sequences of the
* form "%xy".
*
* Note: The
* World Wide Web Consortium Recommendation states that
* UTF-8 should be used. Not doing so may introduce
* incompatibilites.
*
* @param s the String to decode
* @param enc The name of a supported
* character
* encoding.
* @return the newly decoded String
* @exception UnsupportedEncodingException
* If the named encoding is not supported
* @see URLEncoder#encode(java.lang.String, java.lang.String)
* @since 1.4
*/
public static String decode(String s, String enc)
throws UnsupportedEncodingException
{
return null;
}
}