Module com.aoapps.net.types

Package com.aoapps.net

Class URIEncoder

java.lang.Object

com.aoapps.net.URIEncoder

public final class URIEncoder
extends Object

URI encoding utilities.

TODO: These methods are for highest performance and are consistent with the JavaScript methods. They are not meant for general purpose URL manipulation, and are not trying to replace any full-featured URI tools.

Consider the following if needing more than what this provides (in no particular order):

1. URL
2. URI
3. URIBuilder
4. UriUtils
5. UrlEscapers
6. jena-iri
7. org.xbib:net-url

Author:

AO Industries, Inc.

See Also:

URLEncoder

Method Summary

Modifier and Type	Method	Description
static String	encodeURI(String uri)	Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING.
static void	encodeURI(String uri, Encoder encoder, Appendable out)	Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING.
static void	encodeURI(String uri, Appendable out)	Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING.
static void	encodeURI(String uri, StringBuffer sb)	Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING.
static void	encodeURI(String uri, StringBuilder sb)	Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING.
static String	encodeURIComponent(String s)	Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.
static void	encodeURIComponent(String s, Encoder encoder, Appendable out)	Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.
static void	encodeURIComponent(String s, Appendable out)	Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.
static void	encodeURIComponent(String s, StringBuffer sb)	Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.
static void	encodeURIComponent(String s, StringBuilder sb)	Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

encodeURIComponent

public static String encodeURIComponent(String s)

Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.

This uses URLEncoder.encode(java.lang.String) then replaces '+' with "%20".

See encodeURIComponent() - JavaScript | MDN

See Also:

URIDecoder.decodeURIComponent(java.lang.String)

encodeURIComponent

public static void encodeURIComponent(String s,
                                      Appendable out)
                               throws IOException

Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.

This uses URLEncoder.encode(java.lang.String, java.lang.String) then replaces '+' with "%20".

See encodeURIComponent() - JavaScript | MDN

Throws:

IOException

See Also:

URIDecoder.decodeURIComponent(java.lang.String, java.lang.Appendable)

encodeURIComponent

public static void encodeURIComponent(String s,
                                      Encoder encoder,
                                      Appendable out)
                               throws IOException

Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.

This uses URLEncoder.encode(java.lang.String, java.lang.String) then replaces '+' with "%20".

See encodeURIComponent() - JavaScript | MDN

Parameters:

encoder - An optional encoder the output is applied through

Throws:

IOException

See Also:

URIDecoder.decodeURIComponent(java.lang.String, com.aoapps.lang.io.Encoder, java.lang.Appendable)

encodeURIComponent

public static void encodeURIComponent(String s,
                                      StringBuilder sb)

Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.

This uses URLEncoder.encode(java.lang.String, java.lang.String) then replaces '+' with "%20".

See encodeURIComponent() - JavaScript | MDN

See Also:

URIDecoder.decodeURIComponent(java.lang.String, java.lang.StringBuilder)

encodeURIComponent

public static void encodeURIComponent(String s,
                                      StringBuffer sb)

Encodes a value for use in a path component or fragment in the default encoding IRI.ENCODING.

This uses URLEncoder.encode(java.lang.String, java.lang.String) then replaces '+' with "%20".

See encodeURIComponent() - JavaScript | MDN

See Also:

URIDecoder.decodeURIComponent(java.lang.String, java.lang.StringBuffer)

encodeURI

public static String encodeURI(String uri)

Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING. Encodes the characters in the URI, not including any characters defined in RFC 3986: Reserved Characters, '%' (for already percent-encoded), and unprintable invalid.

Any existing lower-case percent-encoded values are normalized to upper-case.

See encodeURI() - JavaScript | MDN

Returns:

The encoded URI or url when not modified

See Also:

URIDecoder.decodeURI(java.lang.String)

encodeURI

public static void encodeURI(String uri,
                             Appendable out)
                      throws IOException

Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING. Encodes the characters in the URI, not including any characters defined in RFC 3986: Reserved Characters, '%' (for already percent-encoded), and unprintable invalid.

Any existing lower-case percent-encoded values are normalized to upper-case.

See encodeURI() - JavaScript | MDN

Throws:

IOException

See Also:

URIDecoder.decodeURI(java.lang.String, java.lang.Appendable)

encodeURI

public static void encodeURI(String uri,
                             Encoder encoder,
                             Appendable out)
                      throws IOException

Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING. Encodes the characters in the URI, not including any characters defined in RFC 3986: Reserved Characters, '%' (for already percent-encoded), and unprintable invalid.

Any existing lower-case percent-encoded values are normalized to upper-case.

See encodeURI() - JavaScript | MDN

Parameters:

encoder - An optional encoder the output is applied through

Throws:

IOException

See Also:

URIDecoder.decodeURI(java.lang.String, com.aoapps.lang.io.Encoder, java.lang.Appendable)

encodeURI

public static void encodeURI(String uri,
                             StringBuilder sb)

Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING. Encodes the characters in the URI, not including any characters defined in RFC 3986: Reserved Characters, '%' (for already percent-encoded), and unprintable invalid.

Any existing lower-case percent-encoded values are normalized to upper-case.

See encodeURI() - JavaScript | MDN

See Also:

URIDecoder.decodeURI(java.lang.String, java.lang.StringBuilder)

encodeURI

public static void encodeURI(String uri,
                             StringBuffer sb)

Encodes a URI to RFC 3986 ASCII format in the default encoding IRI.ENCODING. Encodes the characters in the URI, not including any characters defined in RFC 3986: Reserved Characters, '%' (for already percent-encoded), and unprintable invalid.

Any existing lower-case percent-encoded values are normalized to upper-case.

See encodeURI() - JavaScript | MDN

See Also:

URIDecoder.decodeURI(java.lang.String, java.lang.StringBuffer)