javax.mail

Class URLName


public class URLName
extends java.lang.Object

The name of a URL. This class represents a URL name and also provides the basic parsing functionality to parse most internet standard URL schemes.

Note that this class differs from java.net.URL in that this class just represents the name of a URL, it does not model the connection to a URL.

Field Summary

protected String
fullURL
The full version of the URL

Constructor Summary

URLName(String url)
Construct a URLName from the string.
URLName(String protocol, String host, int port, String file, String username, String password)
Creates a URLName object from the specified protocol, host, port number, file, username, and password.
URLName(URL url)
Construct a URLName from a java.net.URL object.

Method Summary

boolean
equals(Object other)
Compares two URLNames.
String
getFile()
Returns the file name of this URLName.
String
getHost()
Returns the host of this URLName.
String
getPassword()
Returns the password of this URLName.
int
getPort()
Returns the port number of this URLName.
String
getProtocol()
Returns the protocol of this URLName.
String
getRef()
Returns the reference of this URLName.
URL
getURL()
Constructs a URL from the URLName.
String
getUsername()
Returns the user name of this URLName.
int
hashCode()
Compute the hash code for this URLName.
protected void
parseString(String url)
Method which does all of the work of parsing the string.
String
toString()
Constructs a string representation of this URLName.

Field Details

fullURL

protected String fullURL
The full version of the URL

Constructor Details

URLName

public URLName(String url)
Construct a URLName from the string. Parses out all the possible information(protocol, host, port, file, username, password).


URLName

public URLName(String protocol,
               String host,
               int port,
               String file,
               String username,
               String password)
Creates a URLName object from the specified protocol, host, port number, file, username, and password. Specifying a port number of -1 indicates that the URL should use the default port for the protocol.


URLName

public URLName(URL url)
Construct a URLName from a java.net.URL object.

Method Details

equals

public boolean equals(Object other)
Compares two URLNames. The result is true if and only if the argument is not null and is a URLName object that represents the same URLName as this object. Two URLName objects are equal if they have the same protocol and reference the same host, the same port number on the host, the same username and password, and the same file on the host. The fields(host, username, password, file) are also considered the same if they are both null.


getFile

public String getFile()
Returns the file name of this URLName. Returns null if this URLName has no file name.


getHost

public String getHost()
Returns the host of this URLName. Returns null if this URLName has no host.


getPassword

public String getPassword()
Returns the password of this URLName. Returns null if this URLName has no password.


getPort

public int getPort()
Returns the port number of this URLName. Returns -1 if the port is not set.


getProtocol

public String getProtocol()
Returns the protocol of this URLName. Returns null if this URLName has no protocol.


getRef

public String getRef()
Returns the reference of this URLName. Returns null if this URLName has no reference.


getURL

public URL getURL()
            throws MalformedURLException
Constructs a URL from the URLName.


getUsername

public String getUsername()
Returns the user name of this URLName. Returns null if this URLName has no user name.


hashCode

public int hashCode()
Compute the hash code for this URLName.


parseString

protected void parseString(String url)
Method which does all of the work of parsing the string.


toString

public String toString()
Constructs a string representation of this URLName.