Commit a7c084ac by Michael Koch Committed by Michael Koch

2003-11-26 Michael Koch <konqueror@gmx.de>

	* java/net/URL.java
	(URL): Fixed documentation to be HTML compliant.
	(getContent): Completed documentation.
	(getFile): Likewise.
	(getPath): Likewise.
	(getAuthority): Likewise.
	(getHost): Likewise.
	(getDefaultPort): Likewise.
	(getProtocol): Likewise.
	(hashCode): Likewise.
	(openConnection): Likewise.
	(openStream): Likewise.
	(set): Likewise.
	(getURLStreamHandler): Wrapped lines to fit into our 79 chars rule.

From-SVN: r73947
parent 57a5c93b
2003-11-26 Michael Koch <konqueror@gmx.de> 2003-11-26 Michael Koch <konqueror@gmx.de>
* java/net/URL.java
(URL): Fixed documentation to be HTML compliant.
(getContent): Completed documentation.
(getFile): Likewise.
(getPath): Likewise.
(getAuthority): Likewise.
(getHost): Likewise.
(getDefaultPort): Likewise.
(getProtocol): Likewise.
(hashCode): Likewise.
(openConnection): Likewise.
(openStream): Likewise.
(set): Likewise.
(getURLStreamHandler): Wrapped lines to fit into our 79 chars rule.
2003-11-26 Michael Koch <konqueror@gmx.de>
* java/net/InetSocketAddress.java * java/net/InetSocketAddress.java
(hostname): Made private, added documentation. (hostname): Made private, added documentation.
(addr): Likewise. (addr): Likewise.
......
...@@ -56,7 +56,8 @@ import java.util.StringTokenizer; ...@@ -56,7 +56,8 @@ import java.util.StringTokenizer;
* This final class represents an Internet Uniform Resource Locator (URL). * This final class represents an Internet Uniform Resource Locator (URL).
* For details on the syntax of URL's and what they can be used for, * For details on the syntax of URL's and what they can be used for,
* refer to RFC 1738, available from <a * refer to RFC 1738, available from <a
* href="http://ds.internic.net/rfcs/rfc1738.txt">http://ds.internic.net/rfcs/rfc1738.txt</a> * href="http://ds.internic.net/rfcs/rfc1738.txt">
* http://ds.internic.net/rfcs/rfc1738.txt</a>
* <p> * <p>
* There are a great many protocols supported by URL's such as "http", * There are a great many protocols supported by URL's such as "http",
* "ftp", and "file". This object can handle any arbitrary URL for which * "ftp", and "file". This object can handle any arbitrary URL for which
...@@ -73,10 +74,10 @@ import java.util.StringTokenizer; ...@@ -73,10 +74,10 @@ import java.util.StringTokenizer;
* If this property is set, it is assumed to be a "|" separated list of * If this property is set, it is assumed to be a "|" separated list of
* package names in which to attempt locating protocol handlers. The * package names in which to attempt locating protocol handlers. The
* protocol handler is searched for by appending the string * protocol handler is searched for by appending the string
* ".<protocol>.Handler" to each packed in the list until a hander is found. * ".&lt;protocol&gt;.Handler" to each packed in the list until a hander is
* If a protocol handler is not found in this list of packages, or if the * found. If a protocol handler is not found in this list of packages, or if
* property does not exist, then the default protocol handler of * the property does not exist, then the default protocol handler of
* "gnu.java.net.<protocol>.Handler" is tried. If this is * "gnu.java.net.&lt;protocol&gt;.Handler" is tried. If this is
* unsuccessful, a MalformedURLException is thrown. * unsuccessful, a MalformedURLException is thrown.
* <p> * <p>
* All of the constructor methods of URL attempt to load a protocol * All of the constructor methods of URL attempt to load a protocol
...@@ -310,7 +311,7 @@ public final class URL implements Serializable ...@@ -310,7 +311,7 @@ public final class URL implements Serializable
this((URL) null, spec, (URLStreamHandler) null); this((URL) null, spec, (URLStreamHandler) null);
} }
/* /**
* This method parses a String representation of a URL within the * This method parses a String representation of a URL within the
* context of an existing URL. Principally this means that any * context of an existing URL. Principally this means that any
* fields not present the URL are inheritied from the context URL. * fields not present the URL are inheritied from the context URL.
...@@ -475,6 +476,10 @@ public final class URL implements Serializable ...@@ -475,6 +476,10 @@ public final class URL implements Serializable
/** /**
* Gets the contents of this URL * Gets the contents of this URL
* *
* @param classes The allow classes for the content object.
*
* @return a context object for this URL.
*
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public final Object getContent (Class[] classes) throws IOException public final Object getContent (Class[] classes) throws IOException
...@@ -487,6 +492,8 @@ public final class URL implements Serializable ...@@ -487,6 +492,8 @@ public final class URL implements Serializable
* Returns the file portion of the URL. * Returns the file portion of the URL.
* Defined as <code>path[?query]</code>. * Defined as <code>path[?query]</code>.
* Returns the empty string if there is no file portion. * Returns the empty string if there is no file portion.
*
* @return The filename specified in this URL.
*/ */
public String getFile() public String getFile()
{ {
...@@ -497,6 +504,8 @@ public final class URL implements Serializable ...@@ -497,6 +504,8 @@ public final class URL implements Serializable
* Returns the path of the URL. This is the part of the file before any '?' * Returns the path of the URL. This is the part of the file before any '?'
* character. * character.
* *
* @return The path specified in this URL.
*
* @since 1.3 * @since 1.3
*/ */
public String getPath() public String getPath()
...@@ -507,6 +516,8 @@ public final class URL implements Serializable ...@@ -507,6 +516,8 @@ public final class URL implements Serializable
/** /**
* Returns the authority of the URL * Returns the authority of the URL
*
* @return The authority specified in this URL.
* *
* @since 1.3 * @since 1.3
*/ */
...@@ -517,6 +528,8 @@ public final class URL implements Serializable ...@@ -517,6 +528,8 @@ public final class URL implements Serializable
/** /**
* Returns the host of the URL * Returns the host of the URL
*
* @return The host specified in this URL.
*/ */
public String getHost() public String getHost()
{ {
...@@ -540,6 +553,8 @@ public final class URL implements Serializable ...@@ -540,6 +553,8 @@ public final class URL implements Serializable
/** /**
* Returns the default port of the URL. If the StreamHandler for the URL * Returns the default port of the URL. If the StreamHandler for the URL
* protocol does not define a default port it returns -1. * protocol does not define a default port it returns -1.
*
* @return The default port of the current protocol.
*/ */
public int getDefaultPort() public int getDefaultPort()
{ {
...@@ -548,6 +563,8 @@ public final class URL implements Serializable ...@@ -548,6 +563,8 @@ public final class URL implements Serializable
/** /**
* Returns the protocol of the URL * Returns the protocol of the URL
*
* @return The specified protocol.
*/ */
public String getProtocol() public String getProtocol()
{ {
...@@ -591,6 +608,8 @@ public final class URL implements Serializable ...@@ -591,6 +608,8 @@ public final class URL implements Serializable
/** /**
* Returns a hashcode computed by the URLStreamHandler of this URL * Returns a hashcode computed by the URLStreamHandler of this URL
*
* @return The hashcode for this URL.
*/ */
public int hashCode() public int hashCode()
{ {
...@@ -606,6 +625,7 @@ public final class URL implements Serializable ...@@ -606,6 +625,7 @@ public final class URL implements Serializable
* openConnection() method of the protocol handler * openConnection() method of the protocol handler
* *
* @return A URLConnection for this URL * @return A URLConnection for this URL
*
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public URLConnection openConnection() throws IOException public URLConnection openConnection() throws IOException
...@@ -617,6 +637,8 @@ public final class URL implements Serializable ...@@ -617,6 +637,8 @@ public final class URL implements Serializable
* Opens a connection to this URL and returns an InputStream for reading * Opens a connection to this URL and returns an InputStream for reading
* from that connection * from that connection
* *
* @return An <code>InputStream</code> for this URL.
*
* @exception IOException If an error occurs * @exception IOException If an error occurs
*/ */
public final InputStream openStream() throws IOException public final InputStream openStream() throws IOException
...@@ -673,6 +695,15 @@ public final class URL implements Serializable ...@@ -673,6 +695,15 @@ public final class URL implements Serializable
* that only URLStreamHandlers can modify URL fields. URLs are otherwise * that only URLStreamHandlers can modify URL fields. URLs are otherwise
* constant. * constant.
* *
* @param protocol The protocol name for this URL.
* @param host The hostname or IP address for this URL.
* @param port The port number of this URL.
* @param authority The authority of this URL.
* @param userInfo The user and password (if needed) of this URL.
* @param path The "path" portion of this URL.
* @param query The query of this URL.
* @param ref The anchor portion of this URL.
*
* @since 1.3 * @since 1.3
*/ */
protected void set(String protocol, String host, int port, protected void set(String protocol, String host, int port,
...@@ -800,7 +831,8 @@ public final class URL implements Serializable ...@@ -800,7 +831,8 @@ public final class URL implements Serializable
// to it, along with the JDK specified default as a last resort. // to it, along with the JDK specified default as a last resort.
// Except in very unusual environments the JDK specified one shouldn't // Except in very unusual environments the JDK specified one shouldn't
// ever be needed (or available). // ever be needed (or available).
String ph_search_path = System.getProperty ("java.protocol.handler.pkgs"); String ph_search_path =
System.getProperty("java.protocol.handler.pkgs");
// Tack our default package on at the ends. // Tack our default package on at the ends.
if (ph_search_path != null) if (ph_search_path != null)
...@@ -813,7 +845,8 @@ public final class URL implements Serializable ...@@ -813,7 +845,8 @@ public final class URL implements Serializable
do do
{ {
String clsName = pkgPrefix.nextToken() + "." + protocol + ".Handler"; String clsName = (pkgPrefix.nextToken() + "."
+ protocol + ".Handler");
try try
{ {
...@@ -826,7 +859,8 @@ public final class URL implements Serializable ...@@ -826,7 +859,8 @@ public final class URL implements Serializable
} }
catch (Exception e) catch (Exception e)
{ {
// Can't instantiate; handler still null, go on to next element. // Can't instantiate; handler still null,
// go on to next element.
} }
} }
while ((! (ph instanceof URLStreamHandler)) while ((! (ph instanceof URLStreamHandler))
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment