Mozilla::DOM::URI is a wrapper around an instance of Mozilla's nsIURI interface. This class inherits from Supports.
* nsIURI - interface for an uniform resource identifier w/ i18n support. * * AUTF8String attributes may contain unescaped UTF-8 characters. * Consumers should be careful to escape the UTF-8 strings as necessary, but * should always try to "display" the UTF-8 version as provided by this * interface. * * AUTF8String attributes may also contain escaped characters. * * Unescaping URI segments is unadvised unless there is intimate * knowledge of the underlying charset or there is no plan to display (or * otherwise enforce a charset on) the resulting URI substring. * * @status FROZEN * URIs are essentially structured names for things -- anything. This interface * provides accessors to set and query the most basic components of an URI. * Subclasses, including nsIURL, impose greater structure on the URI. * * This interface follows Tim Berners-Lee's URI spec (RFC2396) , where the * basic URI components are defined as such: * * ftp://username:password@hostname:portnumber/pathname * \ / \ / \ / \ /\ / * - --------------- ------ -------- ------- * | | | | | * | | | | Path * | | | Port * | | Host / * | UserPass / * Scheme / * \ / * -------------------------------- * | * PrePath * * The definition of the URI components has been extended to allow for * internationalized domain names  and the more generic IRI structure . * *  http://www.ietf.org/rfc/rfc2396.txt *  http://www.ietf.org/internet-drafts/draft-ietf-idn-idna-06.txt *  http://www.ietf.org/internet-drafts/draft-masinter-url-i18n-08.txt
Pass this to QueryInterface.
* Clones the current URI. For some protocols, this is more than just an * optimization. For example, under MacOS, the spec of a file URL does not * necessarily uniquely identify a file since two volumes could share the * same name.
- $other (Mozilla::DOM::URI)* URI equivalence test (not a strict string comparison). * * eg. http://foo.com:80/ == http://foo.com/
* The URI host with an ASCII compatible encoding. Follows the IDNA * draft spec for converting internationalized domain names (UTF-8) to * ASCII for compatibility with existing internet infrasture.
* The URI spec with an ASCII compatible encoding. Host portion follows * the IDNA draft spec. Other parts are URL-escaped per the rules of * RFC2396. The result is strictly ASCII.
* The host is the internet domain name to which this URI refers. It could * be an IPv4 (or IPv6) address literal. If supported, it could be a * non-ASCII internationalized domain name. * * Characters are NOT escaped.
* The host:port (or simply the host, if port == -1). * * Characters are NOT escaped.
* The charset of the document from which this URI originated. An empty * value implies UTF-8. * * If this value is something other than UTF-8 then the URI components * (e.g., spec, prePath, username, etc.) will all be fully URL-escaped. * Otherwise, the URI components may contain unescaped multibyte UTF-8 * characters.
* The path, typically including at least a leading '/' (but may also be * empty, depending on the protocol). * * Some characters may be escaped.
* A port value of -1 corresponds to the protocol's default port (eg. -1 * implies port 80 for http URIs).
* The prePath (eg. scheme://user:password@host:port) returns the string * before the path. This is useful for authentication or managing sessions. * * Some characters may be escaped.
* The Scheme is the protocol to which this URI refers. The scheme is * restricted to the US-ASCII charset per RFC2396.
* Returns a string representation of the URI. Setting the spec causes * the new spec to be parsed, initializing the URI. * * Some characters may be escaped.
* The username:password (or username only if value doesn't contain a ':') * * Some characters may be escaped.
* The optional username and password, assuming the preHost consists of * username:password. * * Some characters may be escaped.
- $relativePath (string)* This method resolves a relative string into an absolute URI string, * using this URI as the base. * * NOTE: some implementations may have no concept of a relative URI.
- $scheme (string)* An optimization to do scheme checks without requiring the users of nsIURI * to GetScheme, thereby saving extra allocating and freeing. Returns true if * the schemes match (case ignored).
- $aHost (string)
- $aHostPort (string)
- $aPassword (string)
- $aPath (string)
- $aPort (integer (long))
- $aScheme (string)
- $aSpec (string)
- $aUserPass (string)
- $aUsername (string)
Copyright (C) 2005-2007, Scott Lanning
This software is licensed under the LGPL. See Mozilla::DOM for a full notice.