Module com.aoapps.net.types

Package com.aoapps.net

Class URI

java.lang.Object

com.aoapps.net.AnyURI

com.aoapps.net.URI

public class URI
extends AnyURI

Implementation of AnyURI that is restricted to RFC 3986 URI only.

This may have additional, unnecessary percent encodings, if they were present in the anyUri provided to the constructor. If consistent formatting is required, use IRI.toURI(). See isEncodingNormalized().

Furthermore, there is no assumption about the query parameter encodings, and the query could, in theory, contain any arbitrary encoded data. Existing encoded query data is maintained, as-is.

When a strict ASCII-only representation of a RFC 3986 URI is required, use URI. When a Unicode representation of a RFC 3987 IRI is preferred, use IRI. Otherwise, to support both, use AnyURI, which should also perform the best since it performs fewer conversions.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Constructor	Description
URI(String anyUri)	Encodes the given anyUri for this URI.

Method Summary

Modifier and Type	Method	Description
URI	addEncodedParameter(String encodedName, String encodedValue)	Adds an already-encoded parameter.
URI	addParameter(String name, String value)	Encodes and adds a parameter.
URI	addParameters(URIParameters params)	Adds all of the parameters.
URI	addQueryString(String query)	Adds a query string.
URI	appendFragment(Encoder encoder, Appendable out)	Appends the fragment (not including the '#').
URI	appendFragment(Appendable out)	Appends the fragment (not including the '#').
URI	appendHierPart(Encoder encoder, Appendable out)	Appends the part of the URI after the scheme and up to the first '?'
URI	appendHierPart(Appendable out)	Appends the part of the URI after the scheme and up to the first '?'
URI	appendQueryString(Encoder encoder, Appendable out)	Appends the query string (not including the '?').
URI	appendQueryString(Appendable out)	Appends the query string (not including the '?').
URI	appendScheme(Encoder encoder, Appendable out)	Appends the scheme (not including the ':').
URI	appendScheme(Appendable out)	Appends the scheme (not including the ':').
boolean	isEncodingNormalized()	Is this URI percent-encoding normalized?
URI	setEncodedFragment(String encodedFragment)	Replaces the fragment.
URI	setFragment(String fragment)	Replaces the fragment in the default encoding IRI.ENCODING.
URI	setHierPart(String hierPart)	Replaces the hier-part.
URI	setQueryString(String query)	Replaces the query string.
String	toASCIIString()	Gets the full URI in RFC 3986 URI US-ASCII format.
IRI	toIRI()	Gets this URI encoded in RFC 3987 IRI Unicode format.
String	toString()	Gets the full URI in RFC 3986 URI US-ASCII format.
URI	toURI()	Gets this URI encoded in RFC 3986 URI US-ASCII format.

Methods inherited from class com.aoapps.net.AnyURI

appendFragment, appendFragment, appendHierPart, appendHierPart, appendQueryString, appendQueryString, appendScheme, appendScheme, equals, getFragment, getFragmentIndex, getHierPart, getPathEnd, getQueryIndex, getQueryString, getScheme, getSchemeLength, hasFragment, hashCode, hasQuery, hasScheme, isScheme, pathEndsWith, pathEndsWithIgnoreCase, writeFragment, writeFragment, writeHierPart, writeHierPart, writeQueryString, writeQueryString, writeScheme, writeScheme

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

URI

public URI(String anyUri)

Encodes the given anyUri for this URI.

Method Details

toString

public String toString()

Gets the full URI in RFC 3986 URI US-ASCII format.

This might not be percent-encoding normalized. Use toIRI().toString() or toIRI().toURI().toString() if consistent formatting is required.

Overrides:

toString in class AnyURI

toASCIIString

public String toASCIIString()

Description copied from class: AnyURI

Gets the full URI in RFC 3986 URI US-ASCII format.

This might not be percent-encoding normalized. Use AnyURI.toIRI().toASCIIString() if consistent formatting is required.

Overrides:

toASCIIString in class AnyURI

appendScheme

public URI appendScheme(Appendable out)
                 throws IOException

Description copied from class: AnyURI

Appends the scheme (not including the ':').

Overrides:

appendScheme in class AnyURI

Returns:

this

Throws:

IOException

appendScheme

public URI appendScheme(Encoder encoder,
 Appendable out)
                 throws IOException

Description copied from class: AnyURI

Appends the scheme (not including the ':').

Overrides:

appendScheme in class AnyURI

Returns:

this

Throws:

IOException

appendHierPart

public URI appendHierPart(Appendable out)
                   throws IOException

Description copied from class: AnyURI

Appends the part of the URI after the scheme and up to the first '?' or '#' (exclusive), or the full URI when neither found.

Overrides:

appendHierPart in class AnyURI

Returns:

this

Throws:

IOException

appendHierPart

public URI appendHierPart(Encoder encoder,
 Appendable out)
                   throws IOException

Description copied from class: AnyURI

Appends the part of the URI after the scheme and up to the first '?' or '#' (exclusive), or the full URI when neither found.

Overrides:

appendHierPart in class AnyURI

Returns:

this

Throws:

IOException

appendQueryString

public URI appendQueryString(Appendable out)
                      throws IOException

Description copied from class: AnyURI

Appends the query string (not including the '?').

Overrides:

appendQueryString in class AnyURI

Returns:

this

Throws:

IOException

appendQueryString

public URI appendQueryString(Encoder encoder,
 Appendable out)
                      throws IOException

Description copied from class: AnyURI

Appends the query string (not including the '?').

Overrides:

appendQueryString in class AnyURI

Returns:

this

Throws:

IOException

appendFragment

public URI appendFragment(Appendable out)
                   throws IOException

Description copied from class: AnyURI

Appends the fragment (not including the '#').

Overrides:

appendFragment in class AnyURI

Returns:

this

Throws:

IOException

appendFragment

public URI appendFragment(Encoder encoder,
 Appendable out)
                   throws IOException

Description copied from class: AnyURI

Appends the fragment (not including the '#').

Overrides:

appendFragment in class AnyURI

Returns:

this

Throws:

IOException

isEncodingNormalized

public boolean isEncodingNormalized()

Is this URI percent-encoding normalized? Normalized percent encoding means it will have only the required percent encodings, and the encodings are capitalized hexadecimal.

Note: This only refers to the percent encodings. This is not related to full URI normalization.

Overrides:

isEncodingNormalized in class AnyURI

Returns:

true when this was derived from an IRI, which are always encoding normalized. false otherwise, since the percent-encoding normalization status is unknown.

toURI

public URI toURI()

Gets this URI encoded in RFC 3986 URI US-ASCII format.

This might not be percent-encoding normalized. Use AnyURI.toIRI().toURI() if consistent formatting is required.

Overrides:

toURI in class AnyURI

Returns:

this

See Also:

• URIEncoder.encodeURI(java.lang.String)

toIRI

public IRI toIRI()

Gets this URI encoded in RFC 3987 IRI Unicode format.

Overrides:

toIRI in class AnyURI

Returns:

The IRI.

See Also:

• URIDecoder.decodeURI(java.lang.String)

setHierPart

public URI setHierPart(String hierPart)

Description copied from class: AnyURI

Replaces the hier-part.

Overrides:

setHierPart in class AnyURI

Parameters:

hierPart - The hier-part may not contain the query marker '?' or fragment marker '#'

Returns:

The new AnyURI or this when unmodified.

setQueryString

public URI setQueryString(String query)

Description copied from class: AnyURI

Replaces the query string.

Overrides:

setQueryString in class AnyURI

Parameters:

query - The query (not including the first '?') - it is added without additional encoding. The query is removed when the query is null. The query may not contain the fragment marker '#'

Returns:

The new AnyURI or this when unmodified.

addQueryString

public URI addQueryString(String query)

Description copied from class: AnyURI

Adds a query string.

Overrides:

addQueryString in class AnyURI

Parameters:

query - The query (not including the first '?' / '&') - it is added without additional encoding. Nothing is added when the query is null. The query may not contain the fragment marker '#'

Returns:

The new AnyURI or this when unmodified.

addEncodedParameter

public URI addEncodedParameter(String encodedName,
 String encodedValue)

Description copied from class: AnyURI

Adds an already-encoded parameter.

Overrides:

addEncodedParameter in class AnyURI

Parameters:

encodedName - The parameter name - it is added without additional encoding. Nothing is added when the name is null. The name may not contain the fragment marker '#'

encodedValue - The parameter value - it is added without additional encoding. When null, the parameter is added without any '='. Must be null when name is null. The value may not contain the fragment marker '#'

Returns:

The new AnyURI or this when unmodified.

addParameter

public URI addParameter(String name,
 String value)

Description copied from class: AnyURI

Encodes and adds a parameter.

Overrides:

addParameter in class AnyURI

Parameters:

name - The parameter name. Nothing is added when the name is null.

value - The parameter value. When null, the parameter is added without any '='. Must be null when name is null.

Returns:

The new AnyURI or this when unmodified.

See Also:

• URIEncoder.encodeURIComponent(java.lang.String)

addParameters

public URI addParameters(URIParameters params)

Description copied from class: AnyURI

Adds all of the parameters.

Overrides:

addParameters in class AnyURI

Parameters:

params - The parameters to add. Nothing is added when null or empty.

Returns:

The new AnyURI or this when unmodified.

See Also:

• URIParametersUtils.addParams(java.lang.String, com.aoapps.net.URIParameters)

setEncodedFragment

public URI setEncodedFragment(String encodedFragment)

Description copied from class: AnyURI

Replaces the fragment.

Overrides:

setEncodedFragment in class AnyURI

Parameters:

encodedFragment - The fragment (not including the '#') - it is added without additional encoding. Removes fragment when null.

Returns:

The new AnyURI or this when unmodified.

setFragment

public URI setFragment(String fragment)

Description copied from class: AnyURI

Replaces the fragment in the default encoding IRI.ENCODING.

TODO: Implement specification of fragment-escape.

Overrides:

setFragment in class AnyURI

Parameters:

fragment - The fragment (not including the '#') or null for no fragment.

Returns:

The new AnyURI or this when unmodified.