java.net.URLStreamHandler Maven / Gradle / Ivy

* The parseURL method of URLStreamHandler * parses the string representation as if it were an * http specification. Most URL protocol families have a * similar parsing. A stream protocol handler for a protocol that has * a different syntax must override this routine. * * @param u the URL to receive the result of parsing * the spec. * @param spec the String representing the URL that * must be parsed. * @param start the character index at which to begin parsing. This is * just past the ':' (if there is one) that * specifies the determination of the protocol name. * @param limit the character position to stop parsing at. This is the * end of the string or the position of the * "#" character, if present. All information * after the sharp sign indicates an anchor. */ protected void parseURL(URL u, String spec, int start, int limit) { } /** * Returns the default port for a URL parsed by this handler. This method * is meant to be overidden by handlers with default port numbers. * @return the default port for a URL parsed by this handler. */ protected int getDefaultPort() { return 0; } /** * Provides the default equals calculation. May be overidden by handlers * for other protocols that have different requirements for equals(). * This method requires that none of its arguments is null. This is * guaranteed by the fact that it is only called by java.net.URL class. * @param u1 a URL object * @param u2 a URL object * @return true if the two urls are * considered equal, ie. they refer to the same * fragment in the same file. */ protected boolean equals(URL u1, URL u2) { return false; } /** * Provides the default hash calculation. May be overidden by handlers for * other protocols that have different requirements for hashCode * calculation. * @param u a URL object * @return an int suitable for hash table indexing */ protected int hashCode(URL u) { return 0; } /** * Compare two urls to see whether they refer to the same file, * i.e., having the same protocol, host, port, and path. * This method requires that none of its arguments is null. This is * guaranteed by the fact that it is only called indirectly * by java.net.URL class. * @param u1 a URL object * @param u2 a URL object * @return true if u1 and u2 refer to the same file */ protected boolean sameFile(URL u1, URL u2) { return false; } /** * Get the IP address of our host. An empty host field or a DNS failure * will result in a null return. * * @param u a URL object * @return an InetAddress representing the host * IP address. */ protected synchronized InetAddress getHostAddress(URL u) { return null; } /** * Compares the host components of two URLs. * @param u1 the URL of the first host to compare * @param u2 the URL of the second host to compare * @return true if and only if they * are equal, false otherwise. */ protected boolean hostsEqual(URL u1, URL u2) { return false; } /** * Converts a URL of a specific protocol to a * String. * * @param u the URL. * @return a string representation of the URL argument. */ protected String toExternalForm(URL u) { return null; } /** * Sets the fields of the URL argument to the indicated values. * Only classes derived from URLStreamHandler are supposed to be able * to call the set method on a URL. * * @param u the URL to modify. * @param protocol the protocol name. * @param host the remote host value for the URL. * @param port the port on the remote machine. * @param authority the authority part for the URL. * @param userInfo the userInfo part of the URL. * @param path the path component of the URL. * @param query the query part for the URL. * @param ref the reference. * @exception SecurityException if the protocol handler of the URL is * different from this one * @see java.net.URL#set(java.lang.String, java.lang.String, int, java.lang.String, java.lang.String) */ protected void setURL(URL u, String protocol, String host, int port, String authority, String userInfo, String path, String query, String ref) { } }