• root
• java
• j2se
• 1.5
• java.net
• URL

Methods

• URLtop

  public URL(String spec) throws 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:

  @param spec the String to parse as a URL.

  Exceptions:

  @exception MalformedURLException If the string specifies an unknown protocol.

  See:

  @see java.net.URL.URL(java.net.URL, java.lang.String)

  Related Links:

  Google Code Search

  Stack Overflow

• URLtop

  public URL(String protocol, String host, int port, String file) throws 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:

  @param protocol the name of the protocol to use.

  @param host the name of the host.

  @param port the port number on the host.

  @param file the file on the host

  Exceptions:

  @exception MalformedURLException if an unknown protocol is specified.

  See:

  @see System.getProperty(java.lang.String)

  @see java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory)

  @see java.net.URLStreamHandler

  @see java.net.URLStreamHandlerFactory.createURLStreamHandler(java.lang.String)

  Related Links:

  Google Code Search

  Stack Overflow

• URLtop

  public URL(String protocol, String host, int port, String file, URLStreamHandler handler) throws 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:

  @param protocol the name of the protocol to use.

  @param host the name of the host.

  @param port the port number on the host.

  @param file the file on the host

  @param handler the stream handler for the URL.

  Exceptions:

  @exception MalformedURLException if an unknown protocol is specified.

  @exception SecurityException if a security manager exists and its checkPermission method doesn't allow specifying a stream handler explicitly.

  See:

  @see System.getProperty(java.lang.String)

  @see java.net.URL.setURLStreamHandlerFactory(java.net.URLStreamHandlerFactory)

  @see java.net.URLStreamHandler

  @see java.net.URLStreamHandlerFactory.createURLStreamHandler(java.lang.String)

  @see SecurityManager.checkPermission(java.security.Permission)

  @see java.net.NetPermission

  Related Links:

  Google Code Search

  Stack Overflow

• URLtop

  public URL(String protocol, String host, String file) throws 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:

  @param protocol the name of the protocol to use.

  @param host the name of the host.

  @param file the file on the host.

  Exceptions:

  @exception MalformedURLException if an unknown protocol is specified.

  See:

  @see java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

  Related Links:

  Google Code Search

  Stack Overflow

• URLtop

  public URL(URL context, String spec) throws 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:

  @param context the context in which to parse the specification.

  @param spec the String to parse as a URL.

  Exceptions:

  @exception MalformedURLException if no protocol is specified, or an unknown protocol is found.

  See:

  @see java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

  @see java.net.URLStreamHandler

  @see java.net.URLStreamHandler.parseURL(java.net.URL, java.lang.String, int, int)

  Related Links:

  Google Code Search

  Stack Overflow

• URLtop

  public URL(URL context, String spec, URLStreamHandler handler) throws 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:

  @param context the context in which to parse the specification.

  @param spec the String to parse as a URL.

  @param handler the stream handler for the URL.

  Exceptions:

  @exception MalformedURLException if no protocol is specified, or an unknown protocol is found.

  @exception SecurityException if a security manager exists and its checkPermission method doesn't allow specifying a stream handler.

  See:

  @see java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

  @see java.net.URLStreamHandler

  @see java.net.URLStreamHandler.parseURL(java.net.URL, java.lang.String, int, int)

  Related Links:

  Google Code Search

  Stack Overflow

• equalstop

  public boolean equals(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.

  Parameters:

  @param obj the URL to compare against.

  Return:

  @return true if the objects are the same; false otherwise.

  Override hierarchy:

  equals from Object

  Related Links:

  Google Code Search

  Stack Overflow

• getAuthoritytop

  public String getAuthority()
  Gets the authority part of this URL.

  Return:

  @return the authority part of this URL

  Since:

  @since 1.3

  Related Links:

  Google Code Search

  Stack Overflow

• getContenttop

  public final Object getContent() throws IOException
  Gets the contents of this URL. This method is a shorthand for:

       openConnection().getContent()
   

  Return:

  @return the contents of this URL.

  Exceptions:

  @exception IOException if an I/O exception occurs.

  See:

  @see java.net.URLConnection.getContent()

  Related Links:

  Google Code Search

  Stack Overflow

• getContenttop

  public final Object getContent(Class[] classes) throws IOException
  Gets the contents of this URL. This method is a shorthand for:

       openConnection().getContent(Class[])
   

  Parameters:

  @param classes an array of Java types

  Return:

  @return 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.

  Exceptions:

  @exception IOException if an I/O exception occurs.

  See:

  @see java.net.URLConnection.getContent(java.lang.Class[])

  Since:

  @since 1.3

  Related Links:

  Google Code Search

  Stack Overflow

• getDefaultPorttop

  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.

  Return:

  @return the port number

  Related Links:

  Google Code Search

  Stack Overflow

• getFiletop

  public 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.

  Return:

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

  Related Links:

  Google Code Search

  Stack Overflow

• getHosttop

  public 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 ']').

  Return:

  @return the host name of this URL.

  Related Links:

  Google Code Search

  Stack Overflow

• getPathtop

  public String getPath()
  Gets the path part of this URL.

  Return:

  @return the path part of this URL, or an empty string if one does not exist

  Since:

  @since 1.3

  Related Links:

  Google Code Search

  Stack Overflow

• getPorttop

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

  Return:

  @return the port number, or -1 if the port is not set

  Related Links:

  Google Code Search

  Stack Overflow

• getProtocoltop

  public String getProtocol()
  Gets the protocol name of this URL.

  Return:

  @return the protocol of this URL.

  Related Links:

  Google Code Search

  Stack Overflow

• getQuerytop

  public String getQuery()
  Gets the query part of this URL.

  Return:

  @return the query part of this URL, or null if one does not exist

  Since:

  @since 1.3

  Related Links:

  Google Code Search

  Stack Overflow

• getReftop

  public String getRef()
  Gets the anchor (also known as the "reference") of this URL.

  Return:

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

  Related Links:

  Google Code Search

  Stack Overflow

• getUserInfotop

  public String getUserInfo()
  Gets the userInfo part of this URL.

  Return:

  @return the userInfo part of this URL, or null if one does not exist

  Related Links:

  Google Code Search

  Stack Overflow

• hashCodetop

  public synchronized 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.

  Return:

  @return a hash code for this URL.

  Override hierarchy:

  hashCode from Object

  Related Links:

  Google Code Search

  Stack Overflow

• openConnectiontop

  public URLConnection openConnection() throws 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.

  Return:

  @return a URLConnection to the URL.

  Exceptions:

  @exception IOException if an I/O exception occurs.

  See:

  @see java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

  @see java.net.URLConnection

  @see java.net.URLStreamHandler.openConnection(java.net.URL)

  Related Links:

  Google Code Search

  Stack Overflow

• openConnectiontop

  public URLConnection openConnection(Proxy proxy) throws 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:

  @param proxy the Proxy through which this connection will be made. If direct connection is desired, Proxy.NO_PROXY should be specified.

  Return:

  @return a URLConnection to the URL.

  Exceptions:

  @exception IOException if an I/O exception occurs.

  @exception SecurityException if a security manager is present and the caller doesn't have permission to connect to the proxy.

  @exception IllegalArgumentException will be thrown if proxy is null, or proxy has the wrong type

  @exception UnsupportedOperationException if the subclass that implements the protocol handler doesn't support this method.

  See:

  @see java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

  @see java.net.URLConnection

  @see java.net.URLStreamHandler.openConnection(java.net.URL, java.net.Proxy)

  Since:

  @since 1.5

  Related Links:

  Google Code Search

  Stack Overflow

• openStreamtop

  public final InputStream openStream() throws IOException
  Opens a connection to this URL and returns an InputStream for reading from that connection. This method is a shorthand for:

       openConnection().getInputStream()
   

  Return:

  @return an input stream for reading from the URL connection.

  Exceptions:

  @exception IOException if an I/O exception occurs.

  See:

  @see java.net.URL.openConnection()

  @see java.net.URLConnection.getInputStream()

  Related Links:

  Google Code Search

  Stack Overflow

• sameFiletop

  public boolean sameFile(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:

  @param other the URL to compare against.

  Return:

  @return true if they reference the same remote object; false otherwise.

  Related Links:

  Google Code Search

  Stack Overflow

• settop

  protected void set(String protocol, String host, int port, String file, 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:

  @param protocol the name of the protocol to use

  @param host the name of the host

  @param port the port number on the host

  @param file the file on the host

  @param ref the internal reference in the URL

  Related Links:

  Google Code Search

  Stack Overflow

• settop

  protected void set(String protocol, String host, int port, String authority, String userInfo, String path, String query, 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:

  @param protocol the name of the protocol to use

  @param host the name of the host

  @param port the port number on the host

  @param authority the authority part for the url

  @param userInfo the username and password

  @param path the file on the host

  @param ref the internal reference in the URL

  @param query the query part of this URL

  Since:

  @since 1.3

  Related Links:

  Google Code Search

  Stack Overflow

• setURLStreamHandlerFactorytop

  public static void setURLStreamHandlerFactory(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:

  @param fac the desired factory.

  Exceptions:

  @exception Error if the application has already set a factory.

  @exception SecurityException if a security manager exists and its checkSetFactory method doesn't allow the operation.

  See:

  @see java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

  @see java.net.URLStreamHandlerFactory

  @see SecurityManager.checkSetFactory()

  Related Links:

  Google Code Search

  Stack Overflow

• toExternalFormtop

  public 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.

  Return:

  @return a string representation of this object.

  See:

  @see java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

  @see java.net.URLStreamHandler.toExternalForm(java.net.URL)

  Related Links:

  Google Code Search

  Stack Overflow

• toStringtop

  public 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.

  Return:

  @return a string representation of this object.

  See:

  @see java.net.URL.URL(java.lang.String, java.lang.String, int, java.lang.String)

  @see java.net.URLStreamHandler.toExternalForm(java.net.URL)

  Override hierarchy:

  toString from Object

  Related Links:

  Google Code Search

  Stack Overflow

• toURItop

  public URI toURI() throws URISyntaxException
  Returns a 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.

  Return:

  @return a URI instance equivalent to this URL.

  Exceptions:

  @exception URISyntaxException if this URL is not formatted strictly according to to RFC2396 and cannot be converted to a URI.

  Since:

  @since 1.5

  Related Links:

  Google Code Search

  Stack Overflow