Uri

CREATOR

public static final Creator<Uri> CREATOR

Reads Uris from Parcels.

EMPTY

public static final Uri EMPTY

The empty URI, equivalent to "".

buildUpon

public abstract Uri.Builder buildUpon ()

Constructs a new builder, copying the attributes from this Uri.

compareTo

public int compareTo (Uri other)

Compares the string representation of this Uri with that of another.

decode

public static String decode (String s)

Decodes '%'-escaped octets in the given string using the UTF-8 scheme. Replaces invalid octets with the unicode replacement character ("\\uFFFD").

encode

public static String encode (String s, 
                String allow)

Encodes characters in the given string as '%'-escaped octets using the UTF-8 scheme. Leaves letters ("A-Z", "a-z"), numbers ("0-9"), and unreserved characters ("_-!.~'()*") intact. Encodes all other characters with the exception of those specified in the allow argument.

encode

public static String encode (String s)

Encodes characters in the given string as '%'-escaped octets using the UTF-8 scheme. Leaves letters ("A-Z", "a-z"), numbers ("0-9"), and unreserved characters ("_-!.~'()*") intact. Encodes all other characters.

equals

public boolean equals (Object o)

Compares this Uri to another object for equality. Returns true if the encoded string representations of this Uri and the given Uri are equal. Case counts. Paths are not normalized. If one Uri specifies a default port explicitly and the other leaves it implicit, they will not be considered equal.

fromFile

public static Uri fromFile (File file)

Creates a Uri from a file. The URI has the form "file://". Encodes path characters with the exception of '/'.

Example: "file:///tmp/android.txt"

fromParts

public static Uri fromParts (String scheme, 
                String ssp, 
                String fragment)

Creates an opaque Uri from the given components. Encodes the ssp which means this method cannot be used to create hierarchical URIs.

getAuthority

public abstract String getAuthority ()

Gets the decoded authority part of this URI. For server addresses, the authority is structured as follows: [ userinfo '@' ] host [ ':' port ]

Examples: "google.com", "bob@google.com:80"

getBooleanQueryParameter

public boolean getBooleanQueryParameter (String key, 
                boolean defaultValue)

Searches the query string for the first value with the given key and interprets it as a boolean value. "false" and "0" are interpreted as false, everything else is interpreted as true.

getEncodedAuthority

public abstract String getEncodedAuthority ()

Gets the encoded authority part of this URI. For server addresses, the authority is structured as follows: [ userinfo '@' ] host [ ':' port ]

Examples: "google.com", "bob@google.com:80"

getEncodedFragment

public abstract String getEncodedFragment ()

Gets the encoded fragment part of this URI, everything after the '#'.

getEncodedPath

public abstract String getEncodedPath ()

Gets the encoded path.

getEncodedQuery

public abstract String getEncodedQuery ()

Gets the encoded query component from this URI. The query comes after the query separator ('?') and before the fragment separator ('#'). This method would return "q=android" for "http://www.google.com/search?q=android".

getEncodedSchemeSpecificPart

public abstract String getEncodedSchemeSpecificPart ()

Gets the scheme-specific part of this URI, i.e. everything between the scheme separator ':' and the fragment separator '#'. If this is a relative URI, this method returns the entire URI. Leaves escaped octets intact.

Example: "//www.google.com/search?q=android"

getEncodedUserInfo

public abstract String getEncodedUserInfo ()

Gets the encoded user information from the authority. For example, if the authority is "nobody@google.com", this method will return "nobody".

getFragment

public abstract String getFragment ()

Gets the decoded fragment part of this URI, everything after the '#'.

getHost

public abstract String getHost ()

Gets the encoded host from the authority for this URI. For example, if the authority is "bob@google.com", this method will return "google.com".

getLastPathSegment

public abstract String getLastPathSegment ()

Gets the decoded last segment in the path.

getPath

public abstract String getPath ()

Gets the decoded path.

getPathSegments

public abstract List<String> getPathSegments ()

Gets the decoded path segments.

getPort

public abstract int getPort ()

Gets the port from the authority for this URI. For example, if the authority is "google.com:80", this method will return 80.

getQuery

public abstract String getQuery ()

Gets the decoded query component from this URI. The query comes after the query separator ('?') and before the fragment separator ('#'). This method would return "q=android" for "http://www.google.com/search?q=android".

getQueryParameter

public String getQueryParameter (String key)

Searches the query string for the first value with the given key.

Warning: Prior to Jelly Bean, this decoded the '+' character as '+' rather than ' '.

getQueryParameterNames

public Set<String> getQueryParameterNames ()

Returns a set of the unique names of all query parameters. Iterating over the set will return the names in order of their first occurrence.

getQueryParameters

public List<String> getQueryParameters (String key)

Searches the query string for parameter values with the given key.

getScheme

public abstract String getScheme ()

Gets the scheme of this URI. Example: "http"

getSchemeSpecificPart

public abstract String getSchemeSpecificPart ()

Gets the scheme-specific part of this URI, i.e. everything between the scheme separator ':' and the fragment separator '#'. If this is a relative URI, this method returns the entire URI. Decodes escaped octets.

Example: "//www.google.com/search?q=android"

getUserInfo

public abstract String getUserInfo ()

Gets the decoded user information from the authority. For example, if the authority is "nobody@google.com", this method will return "nobody".

hashCode

public int hashCode ()

Hashes the encoded string represention of this Uri consistently with equals(java.lang.Object).

isAbsolute

public boolean isAbsolute ()

Returns true if this URI is absolute, i.e. if it contains an explicit scheme.

isHierarchical

public abstract boolean isHierarchical ()

Returns true if this URI is hierarchical like "http://google.com". Absolute URIs are hierarchical if the scheme-specific part starts with a '/'. Relative URIs are always hierarchical.

isOpaque

public boolean isOpaque ()

Returns true if this URI is opaque like "mailto:nobody@google.com". The scheme-specific part of an opaque URI cannot start with a '/'.

isRelative

public abstract boolean isRelative ()

Returns true if this URI is relative, i.e. if it doesn't contain an explicit scheme.

normalizeScheme

public Uri normalizeScheme ()

Return an equivalent URI with a lowercase scheme component. This aligns the Uri with Android best practices for intent filtering.

For example, "HTTP://www.android.com" becomes "http://www.android.com"

All URIs received from outside Android (such as user input, or external sources like Bluetooth, NFC, or the Internet) should be normalized before they are used to create an Intent.

This method does not validate bad URIs, or 'fix' poorly formatted URIs - so do not use it for input validation. A Uri will always be returned, even if the Uri is badly formatted to begin with and a scheme component cannot be found.

parse

public static Uri parse (String uriString)

Creates a Uri which parses the given encoded URI string.

toString

public abstract String toString ()

Returns the encoded string representation of this URI. Example: "http://google.com/"

withAppendedPath

public static Uri withAppendedPath (Uri baseUri, 
                String pathSegment)

Creates a new Uri by appending an already-encoded path segment to a base Uri.

writeToParcel

public static void writeToParcel (Parcel out, 
                Uri uri)

Writes a Uri to a Parcel.