java.net
Class URL

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.net.URL
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable

public final class URL
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements Serializable sample code for java.io.Serializable definition code for java.io.Serializable

Class URL represents a Uniform Resource Locator, a pointer to a "resource" on the World Wide Web. A resource can be something as simple as a file or a directory, or it can be a reference to a more complicated object, such as a query to a database or to a search engine. More information on the types of URLs and their formats can be found at:

http://archive.ncsa.uiuc.edu/SDG/Software/Mosaic/Demo/url-primer.html

In general, a URL can be broken into several parts. The previous example of a URL indicates that the protocol to use is http (HyperText Transfer Protocol) and that the information resides on a host machine named www.ncsa.uiuc.edu. The information on that host machine is named /SDG/Software/Mosaic/Demo/url-primer.html. The exact meaning of this name on the host machine is both protocol dependent and host dependent. The information normally resides in a file, but it could be generated on the fly. This component of the URL is called the path component.

A URL can optionally specify a "port", which is the port number to which the TCP connection is made on the remote host machine. If the port is not specified, the default port for the protocol is used instead. For example, the default port for http is 80. An alternative port could be specified as:

     http://archive.ncsa.uiuc.edu:80/SDG/Software/Mosaic/Demo/url-primer.html
 

The syntax of URL is defined by RFC 2396: Uniform Resource Identifiers (URI): Generic Syntax, amended by RFC 2732: Format for Literal IPv6 Addresses in URLs. The Literal IPv6 address format also supports scope_ids. The syntax and usage of scope_ids is described here.

A URL may have appended to it a "fragment", also known as a "ref" or a "reference". The fragment is indicated by the sharp sign character "#" followed by more characters. For example,

     http://java.sun.com/index.html#chapter1
 

This fragment is not technically part of the URL. Rather, it indicates that after the specified resource is retrieved, the application is specifically interested in that part of the document that has the tag chapter1 attached to it. The meaning of a tag is resource specific.

An application can also specify a "relative URL", which contains only enough information to reach the resource relative to another URL. Relative URLs are frequently used within HTML pages. For example, if the contents of the URL:

     http://java.sun.com/index.html
 
contained within it the relative URL:
     FAQ.html
 
it would be a shorthand for:
     http://java.sun.com/FAQ.html
 

The relative URL need not specify all the components of a URL. If the protocol, host name, or port number is missing, the value is inherited from the fully specified URL. The file component must be specified. The optional fragment is not inherited.

The URL class does not itself encode or decode any URL components according to the escaping mechanism defined in RFC2396. It is the responsibility of the caller to encode any fields, which need to be escaped prior to calling URL, and also to decode any escaped fields, that are returned from URL. Furthermore, because URL has no knowledge of URL escaping, it does not recognise equivalence between the encoded or decoded form of the same URL. For example, the two URLs:

    http://foo.com/hello world/ and http://foo.com/hello%20world
would be considered not equal to each other.

Note, the URI sample code for java.net.URI definition code for java.net.URI class does perform escaping of its component fields in certain circumstances. The recommended way to manage the encoding and decoding of URLs is to use URI sample code for java.net.URI definition code for java.net.URI , and to convert between these two classes using toURI() sample code for java.net.URL.toURI() definition code for java.net.URL.toURI() and URI.toURL() sample code for java.net.URI.toURL() definition code for java.net.URI.toURL() .

The URLEncoder sample code for java.net.URLEncoder definition code for java.net.URLEncoder and URLDecoder sample code for java.net.URLDecoder definition code for java.net.URLDecoder classes can also be used, but only for HTML form encoding, which is not the same as the encoding scheme defined in RFC2396.

Since:
JDK1.0
See Also:
Serialized Form

Constructor Summary
URL sample code for java.net.URL.URL(java.lang.String) definition code for java.net.URL.URL(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  spec)
          Creates a URL object from the String representation.
URL sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  protocol, String sample code for java.lang.String definition code for java.lang.String  host, int port, String sample code for java.lang.String definition code for java.lang.String  file)
          Creates a URL object from the specified protocol, host, port number, and file.
URL sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String, java.net.URLStreamHandler) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String, java.net.URLStreamHandler) (String sample code for java.lang.String definition code for java.lang.String  protocol, String sample code for java.lang.String definition code for java.lang.String  host, int port, String sample code for java.lang.String definition code for java.lang.String  file, URLStreamHandler sample code for java.net.URLStreamHandler definition code for java.net.URLStreamHandler  handler)
          Creates a URL object from the specified protocol, host, port number, file, and handler.
URL sample code for java.net.URL.URL(java.lang.String, java.lang.String, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  protocol, String sample code for java.lang.String definition code for java.lang.String  host, String sample code for java.lang.String definition code for java.lang.String  file)
          Creates a URL from the specified protocol name, host name, and file name.
URL sample code for java.net.URL.URL(java.net.URL, java.lang.String) definition code for java.net.URL.URL(java.net.URL, java.lang.String) (URL sample code for java.net.URL definition code for java.net.URL  context, String sample code for java.lang.String definition code for java.lang.String  spec)
          Creates a URL by parsing the given spec within a specified context.
URL sample code for java.net.URL.URL(java.net.URL, java.lang.String, java.net.URLStreamHandler) definition code for java.net.URL.URL(java.net.URL, java.lang.String, java.net.URLStreamHandler) (URL sample code for java.net.URL definition code for java.net.URL  context, String sample code for java.lang.String definition code for java.lang.String  spec, URLStreamHandler sample code for java.net.URLStreamHandler definition code for java.net.URLStreamHandler  handler)
          Creates a URL by parsing the given spec with the specified handler within a specified context.
 
Method Summary
 boolean equals sample code for java.net.URL.equals(java.lang.Object) definition code for java.net.URL.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  obj)
          Compares this URL for equality with another object.
 String sample code for java.lang.String definition code for java.lang.String getAuthority sample code for java.net.URL.getAuthority() definition code for java.net.URL.getAuthority() ()
          Gets the authority part of this URL.
 Object sample code for java.lang.Object definition code for java.lang.Object getContent sample code for java.net.URL.getContent() definition code for java.net.URL.getContent() ()
          Gets the contents of this URL.
 Object sample code for java.lang.Object definition code for java.lang.Object getContent sample code for java.net.URL.getContent(java.lang.Class[]) definition code for java.net.URL.getContent(java.lang.Class[]) (Class sample code for java.lang.Class definition code for java.lang.Class [] classes)
          Gets the contents of this URL.
 int getDefaultPort sample code for java.net.URL.getDefaultPort() definition code for java.net.URL.getDefaultPort() ()
          Gets the default port number of the protocol associated with this URL.
 String sample code for java.lang.String definition code for java.lang.String getFile sample code for java.net.URL.getFile() definition code for java.net.URL.getFile() ()
          Gets the file name of this URL.
 String sample code for java.lang.String definition code for java.lang.String getHost sample code for java.net.URL.getHost() definition code for java.net.URL.getHost() ()
          Gets the host name of this URL, if applicable.
 String sample code for java.lang.String definition code for java.lang.String getPath sample code for java.net.URL.getPath() definition code for java.net.URL.getPath() ()
          Gets the path part of this URL.
 int getPort sample code for java.net.URL.getPort() definition code for java.net.URL.getPort() ()
          Gets the port number of this URL.
 String sample code for java.lang.String definition code for java.lang.String getProtocol sample code for java.net.URL.getProtocol() definition code for java.net.URL.getProtocol() ()
          Gets the protocol name of this URL.
 String sample code for java.lang.String definition code for java.lang.String getQuery sample code for java.net.URL.getQuery() definition code for java.net.URL.getQuery() ()
          Gets the query part of this URL.
 String sample code for java.lang.String definition code for java.lang.String getRef sample code for java.net.URL.getRef() definition code for java.net.URL.getRef() ()
          Gets the anchor (also known as the "reference") of this URL.
 String sample code for java.lang.String definition code for java.lang.String getUserInfo sample code for java.net.URL.getUserInfo() definition code for java.net.URL.getUserInfo() ()
          Gets the userInfo part of this URL.
 int hashCode sample code for java.net.URL.hashCode() definition code for java.net.URL.hashCode() ()
          Creates an integer suitable for hash table indexing.
 URLConnection sample code for java.net.URLConnection definition code for java.net.URLConnection openConnection sample code for java.net.URL.openConnection() definition code for java.net.URL.openConnection() ()
          Returns a URLConnection object that represents a connection to the remote object referred to by the URL.
 URLConnection sample code for java.net.URLConnection definition code for java.net.URLConnection openConnection sample code for java.net.URL.openConnection(java.net.Proxy) definition code for java.net.URL.openConnection(java.net.Proxy) (Proxy sample code for java.net.Proxy definition code for java.net.Proxy  proxy)
          Same as openConnection(), except that the connection will be made through the specified proxy; Protocol handlers that do not support proxing will ignore the proxy parameter and make a normal connection.
 InputStream sample code for java.io.InputStream definition code for java.io.InputStream openStream sample code for java.net.URL.openStream() definition code for java.net.URL.openStream() ()
          Opens a connection to this URL and returns an InputStream for reading from that connection.
 boolean sameFile sample code for java.net.URL.sameFile(java.net.URL) definition code for java.net.URL.sameFile(java.net.URL) (URL sample code for java.net.URL definition code for java.net.URL  other)
          Compares two URLs, excluding the fragment component.
protected  void set sample code for java.net.URL.set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String) definition code for java.net.URL.set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  protocol, String sample code for java.lang.String definition code for java.lang.String  host, int port, String sample code for java.lang.String definition code for java.lang.String  file, String sample code for java.lang.String definition code for java.lang.String  ref)
          Sets the fields of the URL.
protected  void set sample code for java.net.URL.set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) definition code for java.net.URL.set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  protocol, String sample code for java.lang.String definition code for java.lang.String  host, int port, String sample code for java.lang.String definition code for java.lang.String  authority, String sample code for java.lang.String definition code for java.lang.String  userInfo, String sample code for java.lang.String definition code for java.lang.String  path, String sample code for java.lang.String definition code for java.lang.String  query, String sample code for java.lang.String definition code for java.lang.String  ref)
          Sets the specified 8 fields of the URL.
static void setURLStreamHandlerFactory sample code for java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory) definition code for java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory) (URLStreamHandlerFactory sample code for java.net.URLStreamHandlerFactory definition code for java.net.URLStreamHandlerFactory  fac)
          Sets an application's URLStreamHandlerFactory.
 String sample code for java.lang.String definition code for java.lang.String toExternalForm sample code for java.net.URL.toExternalForm() definition code for java.net.URL.toExternalForm() ()
          Constructs a string representation of this URL.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.net.URL.toString() definition code for java.net.URL.toString() ()
          Constructs a string representation of this URL.
 URI sample code for java.net.URI definition code for java.net.URI toURI sample code for java.net.URL.toURI() definition code for java.net.URL.toURI() ()
          Returns a URI sample code for java.net.URI definition code for java.net.URI equivalent to this URL.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

URL sample code for java.net.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL(java.lang.String, java.lang.String, int, java.lang.String)

public URL(String sample code for java.lang.String definition code for java.lang.String  protocol,
           String sample code for java.lang.String definition code for java.lang.String  host,
           int port,
           String sample code for java.lang.String definition code for java.lang.String  file)
    throws MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException 
Creates a URL object from the specified protocol, host, port number, and file.

host can be expressed as a host name or a literal IP address. If IPv6 literal address is used, it should be enclosed in square brackets ('[' and ']'), as specified by RFC 2732; However, the literal IPv6 address format defined in RFC 2373: IP Version 6 Addressing Architecture is also accepted.

Specifying a port number of -1 indicates that the URL should use the default port for the protocol.

If this is the first URL object being created with the specified protocol, a stream protocol handler object, an instance of class URLStreamHandler, is created for that protocol:

  1. If the application has previously set up an instance of URLStreamHandlerFactory as the stream handler factory, then the createURLStreamHandler method of that instance is called with the protocol string as an argument to create the stream protocol handler.
  2. If no URLStreamHandlerFactory has yet been set up, or if the factory's createURLStreamHandler method returns null, then the constructor finds the value of the system property:
             java.protocol.handler.pkgs
         
    If the value of that system property is not null, it is interpreted as a list of packages separated by a vertical slash character '|'. The constructor tries to load the class named:
             <package>.<protocol>.Handler
         
    where <package> is replaced by the name of the package and <protocol> is replaced by the name of the protocol. If this class does not exist, or if the class exists but it is not a subclass of URLStreamHandler, then the next package in the list is tried.
  3. If the previous step fails to find a protocol handler, then the constructor tries to load from a system default package.
             <system default package>.<protocol>.Handler
         
    If this class does not exist, or if the class exists but it is not a subclass of URLStreamHandler, then a MalformedURLException is thrown.

Protocol handlers for the following protocols are guaranteed to exist on the search path :-

     http, https, ftp, file, and jar
 
Protocol handlers for additional protocols may also be available.

No validation of the inputs is performed by this constructor.

Parameters:
protocol - the name of the protocol to use.
host - the name of the host.
port - the port number on the host.
file - the file on the host
Throws:
MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException - if an unknown protocol is specified.
See Also:
System.getProperty(java.lang.String) sample code for java.lang.System.getProperty(java.lang.String) definition code for java.lang.System.getProperty(java.lang.String) , setURLStreamHandlerFactory( java.net.URLStreamHandlerFactory) sample code for java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory) definition code for java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory) , URLStreamHandler sample code for java.net.URLStreamHandler definition code for java.net.URLStreamHandler , URLStreamHandlerFactory.createURLStreamHandler( java.lang.String) sample code for java.net.URLStreamHandlerFactory.createURLStreamHandler(java.lang.String) definition code for java.net.URLStreamHandlerFactory.createURLStreamHandler(java.lang.String)

URL sample code for java.net.URL(java.lang.String, java.lang.String, java.lang.String) definition code for java.net.URL(java.lang.String, java.lang.String, java.lang.String)

public URL(String sample code for java.lang.String definition code for java.lang.String  protocol,
           String sample code for java.lang.String definition code for java.lang.String  host,
           String sample code for java.lang.String definition code for java.lang.String  file)
    throws MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException 
Creates a URL from the specified protocol name, host name, and file name. The default port for the specified protocol is used.

This method is equivalent to calling the four-argument constructor with the arguments being protocol, host, -1, and file. No validation of the inputs is performed by this constructor.

Parameters:
protocol - the name of the protocol to use.
host - the name of the host.
file - the file on the host.
Throws:
MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException - if an unknown protocol is specified.
See Also:
URL(java.lang.String, java.lang.String, int, java.lang.String) sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

URL sample code for java.net.URL(java.lang.String, java.lang.String, int, java.lang.String, java.net.URLStreamHandler) definition code for java.net.URL(java.lang.String, java.lang.String, int, java.lang.String, java.net.URLStreamHandler)

public URL(String sample code for java.lang.String definition code for java.lang.String  protocol,
           String sample code for java.lang.String definition code for java.lang.String  host,
           int port,
           String sample code for java.lang.String definition code for java.lang.String  file,
           URLStreamHandler sample code for java.net.URLStreamHandler definition code for java.net.URLStreamHandler  handler)
    throws MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException 
Creates a URL object from the specified protocol, host, port number, file, and handler. Specifying a port number of -1 indicates that the URL should use the default port for the protocol. Specifying a handler of null indicates that the URL should use a default stream handler for the protocol, as outlined for: java.net.URL#URL(java.lang.String, java.lang.String, int, java.lang.String)

If the handler is not null and there is a security manager, the security manager's checkPermission method is called with a NetPermission("specifyStreamHandler") permission. This may result in a SecurityException. No validation of the inputs is performed by this constructor.

Parameters:
protocol - the name of the protocol to use.
host - the name of the host.
port - the port number on the host.
file - the file on the host
handler - the stream handler for the URL.
Throws:
MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException - if an unknown protocol is specified.
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if a security manager exists and its checkPermission method doesn't allow specifying a stream handler explicitly.
See Also:
System.getProperty(java.lang.String) sample code for java.lang.System.getProperty(java.lang.String) definition code for java.lang.System.getProperty(java.lang.String) , setURLStreamHandlerFactory( java.net.URLStreamHandlerFactory) sample code for java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory) definition code for java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory) , URLStreamHandler sample code for java.net.URLStreamHandler definition code for java.net.URLStreamHandler , URLStreamHandlerFactory.createURLStreamHandler( java.lang.String) sample code for java.net.URLStreamHandlerFactory.createURLStreamHandler(java.lang.String) definition code for java.net.URLStreamHandlerFactory.createURLStreamHandler(java.lang.String) , SecurityManager.checkPermission(java.security.Permission) sample code for java.lang.SecurityManager.checkPermission(java.security.Permission) definition code for java.lang.SecurityManager.checkPermission(java.security.Permission) , NetPermission sample code for java.net.NetPermission definition code for java.net.NetPermission

URL sample code for java.net.URL(java.lang.String) definition code for java.net.URL(java.lang.String)

public URL(String sample code for java.lang.String definition code for java.lang.String  spec)
    throws MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException 
Creates a URL object from the String representation.

This constructor is equivalent to a call to the two-argument constructor with a null first argument.

Parameters:
spec - the String to parse as a URL.
Throws:
MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException - If the string specifies an unknown protocol.
See Also:
URL(java.net.URL, java.lang.String) sample code for java.net.URL.URL(java.net.URL, java.lang.String) definition code for java.net.URL.URL(java.net.URL, java.lang.String)

URL sample code for java.net.URL(java.net.URL, java.lang.String) definition code for java.net.URL(java.net.URL, java.lang.String)

public URL(URL sample code for java.net.URL definition code for java.net.URL  context,
           String sample code for java.lang.String definition code for java.lang.String  spec)
    throws MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException 
Creates a URL by parsing the given spec within a specified context. The new URL is created from the given context URL and the spec argument as described in RFC2396 "Uniform Resource Identifiers : Generic * Syntax" :
          <scheme>://<authority><path>?<query>#<fragment>
 
The reference is parsed into the scheme, authority, path, query and fragment parts. If the path component is empty and the scheme, authority, and query components are undefined, then the new URL is a reference to the current document. Otherwise, the fragment and query parts present in the spec are used in the new URL.

If the scheme component is defined in the given spec and does not match the scheme of the context, then the new URL is created as an absolute URL based on the spec alone. Otherwise the scheme component is inherited from the context URL.

If the authority component is present in the spec then the spec is treated as absolute and the spec authority and path will replace the context authority and path. If the authority component is absent in the spec then the authority of the new URL will be inherited from the context.

If the spec's path component begins with a slash character "/" then the path is treated as absolute and the spec path replaces the context path.

Otherwise, the path is treated as a relative path and is appended to the context path, as described in RFC2396. Also, in this case, the path is canonicalized through the removal of directory changes made by occurences of ".." and ".".

For a more detailed description of URL parsing, refer to RFC2396.

Parameters:
context - the context in which to parse the specification.
spec - the String to parse as a URL.
Throws:
MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException - if no protocol is specified, or an unknown protocol is found.
See Also:
URL(java.lang.String, java.lang.String, int, java.lang.String) sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) , URLStreamHandler sample code for java.net.URLStreamHandler definition code for java.net.URLStreamHandler , URLStreamHandler.parseURL(java.net.URL, java.lang.String, int, int) sample code for java.net.URLStreamHandler.parseURL(java.net.URL, java.lang.String, int, int) definition code for java.net.URLStreamHandler.parseURL(java.net.URL, java.lang.String, int, int)

URL sample code for java.net.URL(java.net.URL, java.lang.String, java.net.URLStreamHandler) definition code for java.net.URL(java.net.URL, java.lang.String, java.net.URLStreamHandler)

public URL(URL sample code for java.net.URL definition code for java.net.URL  context,
           String sample code for java.lang.String definition code for java.lang.String  spec,
           URLStreamHandler sample code for java.net.URLStreamHandler definition code for java.net.URLStreamHandler  handler)
    throws MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException 
Creates a URL by parsing the given spec with the specified handler within a specified context. If the handler is null, the parsing occurs as with the two argument constructor.

Parameters:
context - the context in which to parse the specification.
spec - the String to parse as a URL.
handler - the stream handler for the URL.
Throws:
MalformedURLException sample code for java.net.MalformedURLException definition code for java.net.MalformedURLException - if no protocol is specified, or an unknown protocol is found.
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if a security manager exists and its checkPermission method doesn't allow specifying a stream handler.
See Also:
URL(java.lang.String, java.lang.String, int, java.lang.String) sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) , URLStreamHandler sample code for java.net.URLStreamHandler definition code for java.net.URLStreamHandler , URLStreamHandler.parseURL(java.net.URL, java.lang.String, int, int) sample code for java.net.URLStreamHandler.parseURL(java.net.URL, java.lang.String, int, int) definition code for java.net.URLStreamHandler.parseURL(java.net.URL, java.lang.String, int, int)
Method Detail

set sample code for java.net.URL.set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String) definition code for java.net.URL.set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String)

protected void set(String sample code for java.lang.String definition code for java.lang.String  protocol,
                   String sample code for java.lang.String definition code for java.lang.String  host,
                   int port,
                   String sample code for java.lang.String definition code for java.lang.String  file,
                   String sample code for java.lang.String definition code for java.lang.String  ref)
Sets the fields of the URL. This is not a public method so that only URLStreamHandlers can modify URL fields. URLs are otherwise constant.

Parameters:
protocol - the name of the protocol to use
host - the name of the host
port - the port number on the host
file - the file on the host
ref - the internal reference in the URL

set sample code for java.net.URL.set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String) definition code for java.net.URL.set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

protected void set(String sample code for java.lang.String definition code for java.lang.String  protocol,
                   String sample code for java.lang.String definition code for java.lang.String  host,
                   int port,
                   String sample code for java.lang.String definition code for java.lang.String  authority,
                   String sample code for java.lang.String definition code for java.lang.String  userInfo,
                   String sample code for java.lang.String definition code for java.lang.String  path,
                   String sample code for java.lang.String definition code for java.lang.String  query,
                   String sample code for java.lang.String definition code for java.lang.String  ref)
Sets the specified 8 fields of the URL. This is not a public method so that only URLStreamHandlers can modify URL fields. URLs are otherwise constant.

Parameters:
protocol - the name of the protocol to use
host - the name of the host
port - the port number on the host
authority - the authority part for the url
userInfo - the username and password
path - the file on the host
ref - the internal reference in the URL
query - the query part of this URL
Since:
1.3

getQuery sample code for java.net.URL.getQuery() definition code for java.net.URL.getQuery()

public String sample code for java.lang.String definition code for java.lang.String  getQuery()
Gets the query part of this URL.

Returns:
the query part of this URL, or null if one does not exist
Since:
1.3

getPath sample code for java.net.URL.getPath() definition code for java.net.URL.getPath()

public String sample code for java.lang.String definition code for java.lang.String  getPath()
Gets the path part of this URL.

Returns:
the path part of this URL, or an empty string if one does not exist
Since:
1.3

getUserInfo sample code for java.net.URL.getUserInfo() definition code for java.net.URL.getUserInfo()

public String sample code for java.lang.String definition code for java.lang.String  getUserInfo()
Gets the userInfo part of this URL.

Returns:
the userInfo part of this URL, or null if one does not exist

getAuthority sample code for java.net.URL.getAuthority() definition code for java.net.URL.getAuthority()

public String sample code for java.lang.String definition code for java.lang.String  getAuthority()
Gets the authority part of this URL.

Returns:
the authority part of this URL
Since:
1.3

getPort sample code for java.net.URL.getPort() definition code for java.net.URL.getPort()

public int getPort()
Gets the port number of this URL.

Returns:
the port number, or -1 if the port is not set

getDefaultPort sample code for java.net.URL.getDefaultPort() definition code for java.net.URL.getDefaultPort()

public int getDefaultPort()
Gets the default port number of the protocol associated with this URL. If the URL scheme or the URLStreamHandler for the URL do not define a default port number, then -1 is returned.

Returns:
the port number

getProtocol sample code for java.net.URL.getProtocol() definition code for java.net.URL.getProtocol()

public String sample code for java.lang.String definition code for java.lang.String  getProtocol()
Gets the protocol name of this URL.

Returns:
the protocol of this URL.

getHost sample code for java.net.URL.getHost() definition code for java.net.URL.getHost()

public String sample code for java.lang.String definition code for java.lang.String  getHost()
Gets the host name of this URL, if applicable. The format of the host conforms to RFC 2732, i.e. for a literal IPv6 address, this method will return the IPv6 address enclosed in square brackets ('[' and ']').

Returns:
the host name of this URL.

getFile sample code for java.net.URL.getFile() definition code for java.net.URL.getFile()

public String sample code for java.lang.String definition code for java.lang.String  getFile()
Gets the file name of this URL. The returned file portion will be the same as getPath(), plus the concatenation of the value of getQuery(), if any. If there is no query portion, this method and getPath() will return identical results.

Returns:
the file name of this URL, or an empty string if one does not exist

getRef sample code for java.net.URL.getRef() definition code for java.net.URL.getRef()

public String sample code for java.lang.String definition code for java.lang.String  getRef()
Gets the anchor (also known as the "reference") of this URL.

Returns:
the anchor (also known as the "reference") of this URL, or null if one does not exist

equals sample code for java.net.URL.equals(java.lang.Object) definition code for java.net.URL.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  obj)
Compares this URL for equality with another object.

If the given object is not a URL then this method immediately returns false.

Two URL objects are equal if they have the same protocol, reference equivalent hosts, have the same port number on the host, and the same file and fragment of the file.

Two hosts are considered equivalent if both host names can be resolved into the same IP addresses; else if either host name can't be resolved, the host names must be equal without regard to case; or both host names equal to null.

Since hosts comparison requires name resolution, this operation is a blocking operation.

Note: The defined behavior for equals is known to be inconsistent with virtual hosting in HTTP.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
obj - the URL to compare against.
Returns:
true if the objects are the same; false otherwise.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

hashCode sample code for java.net.URL.hashCode() definition code for java.net.URL.hashCode()

public int hashCode()
Creates an integer suitable for hash table indexing.

The hash code is based upon all the URL components relevant for URL comparison. As such, this operation is a blocking operation.

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a hash code for this URL.
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

sameFile sample code for java.net.URL.sameFile(java.net.URL) definition code for java.net.URL.sameFile(java.net.URL)

public boolean sameFile(URL sample code for java.net.URL definition code for java.net.URL  other)
Compares two URLs, excluding the fragment component.

Returns true if this URL and the other argument are equal without taking the fragment component into consideration.

Parameters:
other - the URL to compare against.
Returns:
true if they reference the same remote object; false otherwise.

toString sample code for java.net.URL.toString() definition code for java.net.URL.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Constructs a string representation of this URL. The string is created by calling the toExternalForm method of the stream protocol handler for this object.

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
a string representation of this object.
See Also:
URL(java.lang.String, java.lang.String, int, java.lang.String) sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) , URLStreamHandler.toExternalForm(java.net.URL) sample code for java.net.URLStreamHandler.toExternalForm(java.net.URL) definition code for java.net.URLStreamHandler.toExternalForm(java.net.URL)

toExternalForm sample code for java.net.URL.toExternalForm() definition code for java.net.URL.toExternalForm()

public String sample code for java.lang.String definition code for java.lang.String  toExternalForm()
Constructs a string representation of this URL. The string is created by calling the toExternalForm method of the stream protocol handler for this object.

Returns:
a string representation of this object.
See Also:
URL(java.lang.String, java.lang.String, int, java.lang.String) sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) , URLStreamHandler.toExternalForm(java.net.URL) sample code for java.net.URLStreamHandler.toExternalForm(java.net.URL) definition code for java.net.URLStreamHandler.toExternalForm(java.net.URL)

toURI sample code for java.net.URL.toURI() definition code for java.net.URL.toURI()

public URI sample code for java.net.URI definition code for java.net.URI  toURI()
          throws URISyntaxException sample code for java.net.URISyntaxException definition code for java.net.URISyntaxException 
Returns a URI sample code for java.net.URI definition code for java.net.URI equivalent to this URL. This method functions in the same way as new URI (this.toString()).

Note, any URL instance that complies with RFC 2396 can be converted to a URI. However, some URLs that are not strictly in compliance can not be converted to a URI.

Returns:
a URI instance equivalent to this URL.
Throws:
URISyntaxException sample code for java.net.URISyntaxException definition code for java.net.URISyntaxException - if this URL is not formatted strictly according to to RFC2396 and cannot be converted to a URI.
Since:
1.5

openConnection sample code for java.net.URL.openConnection() definition code for java.net.URL.openConnection()

public URLConnection sample code for java.net.URLConnection definition code for java.net.URLConnection  openConnection()
                             throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Returns a URLConnection object that represents a connection to the remote object referred to by the URL.

A new connection is opened every time by calling the openConnection method of the protocol handler for this URL.

If for the URL's protocol (such as HTTP or JAR), there exists a public, specialized URLConnection subclass belonging to one of the following packages or one of their subpackages: java.lang, java.io, java.util, java.net, the connection returned will be of that subclass. For example, for HTTP an HttpURLConnection will be returned, and for JAR a JarURLConnection will be returned.

Returns:
a URLConnection to the URL.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O exception occurs.
See Also:
URL(java.lang.String, java.lang.String, int, java.lang.String) sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) , URLConnection sample code for java.net.URLConnection definition code for java.net.URLConnection , URLStreamHandler.openConnection(java.net.URL) sample code for java.net.URLStreamHandler.openConnection(java.net.URL) definition code for java.net.URLStreamHandler.openConnection(java.net.URL)

openConnection sample code for java.net.URL.openConnection(java.net.Proxy) definition code for java.net.URL.openConnection(java.net.Proxy)

public URLConnection sample code for java.net.URLConnection definition code for java.net.URLConnection  openConnection(Proxy sample code for java.net.Proxy definition code for java.net.Proxy  proxy)
                             throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Same as openConnection(), except that the connection will be made through the specified proxy; Protocol handlers that do not support proxing will ignore the proxy parameter and make a normal connection. Calling this method preempts the system's default ProxySelector settings.

Parameters:
proxy - the Proxy through which this connection will be made. If direct connection is desired, Proxy.NO_PROXY should be specified.
Returns:
a URLConnection to the URL.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O exception occurs.
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if a security manager is present and the caller doesn't have permission to connect to the proxy.
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - will be thrown if proxy is null, or proxy has the wrong type
UnsupportedOperationException sample code for java.lang.UnsupportedOperationException definition code for java.lang.UnsupportedOperationException - if the subclass that implements the protocol handler doesn't support this method.
Since:
1.5
See Also:
URL(java.lang.String, java.lang.String, int, java.lang.String) sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) , URLConnection sample code for java.net.URLConnection definition code for java.net.URLConnection , URLStreamHandler.openConnection(java.net.URL, java.net.Proxy) sample code for java.net.URLStreamHandler.openConnection(java.net.URL, java.net.Proxy) definition code for java.net.URLStreamHandler.openConnection(java.net.URL, java.net.Proxy)

openStream sample code for java.net.URL.openStream() definition code for java.net.URL.openStream()

public final InputStream sample code for java.io.InputStream definition code for java.io.InputStream  openStream()
                             throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Opens a connection to this URL and returns an InputStream for reading from that connection. This method is a shorthand for:
     openConnection().getInputStream()
 

Returns:
an input stream for reading from the URL connection.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O exception occurs.
See Also:
openConnection() sample code for java.net.URL.openConnection() definition code for java.net.URL.openConnection() , URLConnection.getInputStream() sample code for java.net.URLConnection.getInputStream() definition code for java.net.URLConnection.getInputStream()

getContent sample code for java.net.URL.getContent() definition code for java.net.URL.getContent()

public final Object sample code for java.lang.Object definition code for java.lang.Object  getContent()
                        throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Gets the contents of this URL. This method is a shorthand for:
     openConnection().getContent()
 

Returns:
the contents of this URL.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O exception occurs.
See Also:
URLConnection.getContent() sample code for java.net.URLConnection.getContent() definition code for java.net.URLConnection.getContent()

getContent sample code for java.net.URL.getContent(java.lang.Class[]) definition code for java.net.URL.getContent(java.lang.Class[])

public final Object sample code for java.lang.Object definition code for java.lang.Object  getContent(Class sample code for java.lang.Class definition code for java.lang.Class [] classes)
                        throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Gets the contents of this URL. This method is a shorthand for:
     openConnection().getContent(Class[])
 

Parameters:
classes - an array of Java types
Returns:
the content object of this URL that is the first match of the types specified in the classes array. null if none of the requested types are supported.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O exception occurs.
Since:
1.3
See Also:
URLConnection.getContent(Class[]) sample code for java.net.URLConnection.getContent(java.lang.Class[]) definition code for java.net.URLConnection.getContent(java.lang.Class[])

setURLStreamHandlerFactory sample code for java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory) definition code for java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory)

public static void setURLStreamHandlerFactory(URLStreamHandlerFactory sample code for java.net.URLStreamHandlerFactory definition code for java.net.URLStreamHandlerFactory  fac)
Sets an application's URLStreamHandlerFactory. This method can be called at most once in a given Java Virtual Machine.

The URLStreamHandlerFactory instance is used to construct a stream protocol handler from a protocol name.

If there is a security manager, this method first calls the security manager's checkSetFactory method to ensure the operation is allowed. This could result in a SecurityException.

Parameters:
fac - the desired factory.
Throws:
Error sample code for java.lang.Error definition code for java.lang.Error - if the application has already set a factory.
SecurityException sample code for java.lang.SecurityException definition code for java.lang.SecurityException - if a security manager exists and its checkSetFactory method doesn't allow the operation.
See Also:
URL(java.lang.String, java.lang.String, int, java.lang.String) sample code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) definition code for java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String) , URLStreamHandlerFactory sample code for java.net.URLStreamHandlerFactory definition code for java.net.URLStreamHandlerFactory , SecurityManager.checkSetFactory() sample code for java.lang.SecurityManager.checkSetFactory() definition code for java.lang.SecurityManager.checkSetFactory()