OpenJDK 1.23 · java.net.URLEncoder · APIdia, the JavaDoc alternative

Utility class for HTML form encoding. This class contains static methods for converting a String to the application/x-www-form-urlencoded MIME format. For more information about HTML form encoding, consult the HTML specification.

When encoding a String, the following rules apply:

The alphanumeric characters "a" through "z", "A" through "Z" and "0" through "9" remain the same.
The special characters ".", "-", "*", and "_" remain the same.
The space character " " is converted into a plus sign "+".
All other characters are unsafe and are first converted into one or more bytes using some encoding scheme. Then each byte is represented by the 3-character string "%xy", where xy is the two-digit hexadecimal representation of the byte. The recommended encoding scheme to use is UTF-8. However, for compatibility reasons, if an encoding is not specified, then the default charset is used.

For example using UTF-8 as the encoding scheme the string "The string ü@foo-bar" would get converted to "The+string+%C3%BC%40foo-bar" because in UTF-8 the character ü is encoded as two bytes C3 (hex) and BC (hex), and the character @ is encoded as one byte 40 (hex).

Field Summary

Modifier and Type	Field and Description
private static final IntPredicate	DONT_NEED_ENCODING
private static final int	ENCODING_CHUNK_SIZE

Constructor Summary

Access	Constructor and Description
private	URLEncoder() You can't call the constructor.

Method Summary

Modifier and Type	Method and Description
public static String	Returns: the translated `String`. encode(String `String` to be translated. s) Deprecated The resulting string may vary depending on the default charset. Instead, use the encode(String,String) method to specify the encoding. Translates a string into `x-www-form-urlencoded` format.
public static String	Returns: the translated `String`. encode(String `String` to be translated. s, String The name of a supported character encoding. enc) Translates a string into `application/x-www-form-urlencoded` format using a specific encoding scheme.
public static String	Returns: the translated `String`. encode(String `String` to be translated. s, Charset the given charset charset) Translates a string into `application/x-www-form-urlencoded` format using a specific Charset.
private static void	flushToStringBuilder(StringBuilder the StringBuilder to output encoded and escaped bytes to out, CharsetEncoder charset encoder. Will be reset if endOfInput is true ce, CharBuffer input buffer, will be cleared cb, ByteBuffer output buffer, will be cleared bb, boolean true if this is the last flush for an encoding chunk, to all bytes in ce is flushed to out and reset endOfInput) Encodes input chars in `cb` and appends the byte values in an escaped format (`"%XX"`) to `out`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DONT_NEED_ENCODING	back to summary
private static final IntPredicate DONT_NEED_ENCODING

ENCODING_CHUNK_SIZE	back to summary
private static final int ENCODING_CHUNK_SIZE

Constructor Detail

URLEncoder	back to summary
private URLEncoder() You can't call the constructor.

Method Detail

encode back to summary

encode	back to summary
public static String encode(String s) Deprecated The resulting string may vary depending on the default charset. Instead, use the encode(String,String) method to specify the encoding. Translates a string into `x-www-form-urlencoded` format. This method uses the default charset as the encoding scheme to obtain the bytes for unsafe characters. Parameters s:String `String` to be translated. Returns:String the translated `String`. Annotations @Deprecated

public static String encode(String s)

Deprecated

The resulting string may vary depending on the default charset. Instead, use the encode(String,String) method to specify the encoding.

Translates a string into x-www-form-urlencoded format. This method uses the default charset as the encoding scheme to obtain the bytes for unsafe characters.

Parameters

s:String: String to be translated.

Returns:String

the translated String.

Annotations

@Deprecated

encode back to summary

encode	back to summary
public static String encode(String s, String enc) throws UnsupportedEncodingException Translates a string into `application/x-www-form-urlencoded` format using a specific encoding scheme. This method behaves the same as encode(String s, Charset charset) except that it will look up the charset using the given encoding name. Parameters s:String `String` to be translated. enc:String The name of a supported character encoding. Returns:String the translated `String`. Exceptions UnsupportedEncodingException: If the named encoding is not supported Since 1.4 See Also `URLDecoder#decode(java.lang.String, java.lang.String)`

public static String encode(String s, String enc) throws UnsupportedEncodingException

Translates a string into application/x-www-form-urlencoded format using a specific encoding scheme.

This method behaves the same as encode(String s, Charset charset) except that it will look up the charset using the given encoding name.

Parameters

s:String: String to be translated.
enc:String: The name of a supported character encoding.

Returns:String

the translated String.

Exceptions

UnsupportedEncodingException:: If the named encoding is not supported

Since

1.4

encode back to summary

encode	back to summary
public static String encode(String s, Charset charset) Translates a string into `application/x-www-form-urlencoded` format using a specific Charset. This method uses the supplied charset to obtain the bytes for unsafe characters. If the input string is malformed, or if the input cannot be mapped to a valid byte sequence in the given `Charset`, then the erroneous input will be replaced with the `Charset`'s replacement values. API Note The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities. Parameters s:String `String` to be translated. charset:Charset the given charset Returns:String the translated `String`. Exceptions NullPointerException: if `s` or `charset` is `null`. Since 10 External Specification https://www.w3.org/TR/html4 See Also `URLDecoder#decode(java.lang.String, Charset)`

public static String encode(String s, Charset charset)

Translates a string into application/x-www-form-urlencoded format using a specific Charset. This method uses the supplied charset to obtain the bytes for unsafe characters.

If the input string is malformed, or if the input cannot be mapped to a valid byte sequence in the given Charset, then the erroneous input will be replaced with the Charset's replacement values.

API Note

The World Wide Web Consortium Recommendation states that UTF-8 should be used. Not doing so may introduce incompatibilities.

Parameters

s:String: String to be translated.
charset:Charset: the given charset

Returns:String

the translated String.

Exceptions

NullPointerException:: if s or charset is null.

Since

External Specification

https://www.w3.org/TR/html4

flushToStringBuilder back to summary

flushToStringBuilder	back to summary
private static void flushToStringBuilder(StringBuilder out, CharsetEncoder ce, CharBuffer cb, ByteBuffer bb, boolean endOfInput) Encodes input chars in `cb` and appends the byte values in an escaped format (`"%XX"`) to `out`. The temporary byte buffer, `bb`, must be able to accept `cb.position() * ce.maxBytesPerChar()` bytes. Parameters out:StringBuilder the StringBuilder to output encoded and escaped bytes to ce:CharsetEncoder charset encoder. Will be reset if endOfInput is true cb:CharBuffer input buffer, will be cleared bb:ByteBuffer output buffer, will be cleared endOfInput:boolean true if this is the last flush for an encoding chunk, to all bytes in ce is flushed to out and reset

private static void flushToStringBuilder(StringBuilder out, CharsetEncoder ce, CharBuffer cb, ByteBuffer bb, boolean endOfInput)

Encodes input chars in cb and appends the byte values in an escaped format ("%XX") to out. The temporary byte buffer, bb, must be able to accept cb.position() * ce.maxBytesPerChar() bytes.

Parameters

out:StringBuilder: the StringBuilder to output encoded and escaped bytes to
ce:CharsetEncoder: charset encoder. Will be reset if endOfInput is true
cb:CharBuffer: input buffer, will be cleared
bb:ByteBuffer: output buffer, will be cleared
endOfInput:boolean: true if this is the last flush for an encoding chunk, to all bytes in ce is flushed to out and reset

public Class URLEncoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail