public class

URLName

extends Object
java.lang.Object
   ↳ com.google.code.javax.mail.URLName

Class Overview

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.

Summary

Constants
int caseDiff
Fields
private static boolean doEncode A way to turn off encoding, just in case...
static BitSet dontNeedEncoding The class contains a utility method for converting a String into a MIME format called "x-www-form-urlencoded" format.
private String file The specified file name on that host.
protected String fullURL The full version of the URL
private int hashCode Our hash code.
private String host The host name to which to connect.
private InetAddress hostAddress The host's IP address, used in equals and hashCode.
private boolean hostAddressKnown
private String password The password to use when connecting.
private int port The protocol port to connect to.
private String protocol The protocol to use (ftp, http, nntp, imap, pop3 ...
private String ref # reference.
private String username The username to use when connecting
Public Constructors
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.
URLName(String url)
Construct a URLName from the string.
Public Methods
boolean equals(Object obj)
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.
String toString()
Constructs a string representation of this URLName.
Protected Methods
void parseString(String url)
Method which does all of the work of parsing the string.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

static final int caseDiff

Constant Value: 32 (0x00000020)

Fields

private static boolean doEncode

A way to turn off encoding, just in case...

static BitSet dontNeedEncoding

The class contains a utility method for converting a String into a MIME format called "x-www-form-urlencoded" format.

To convert a String, each character is examined in turn:

  • The ASCII characters 'a' through 'z', 'A' through 'Z', '0' through '9', and ".", "-", "*", "_" remain the same.
  • The space character ' ' is converted into a plus sign '+'.
  • All other characters are converted into the 3-character string "%xy", where xy is the two-digit hexadecimal representation of the lower 8-bits of the character.

private String file

The specified file name on that host.

protected String fullURL

The full version of the URL

private int hashCode

Our hash code.

private String host

The host name to which to connect.

private InetAddress hostAddress

The host's IP address, used in equals and hashCode. Computed on demand.

private boolean hostAddressKnown

private String password

The password to use when connecting.

private int port

The protocol port to connect to.

private String protocol

The protocol to use (ftp, http, nntp, imap, pop3 ... etc.) .

private String ref

# reference.

private String username

The username to use when connecting

Public Constructors

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.

Parameters
protocol
host
port
file
username
password

public URLName (URL url)

Construct a URLName from a java.net.URL object.

Parameters
url

public URLName (String url)

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

Parameters
url

Public Methods

public boolean equals (Object obj)

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 the same host, the same port number on the host, the same username, and the same file on the host. The fields (host, username, file) are also considered the same if they are both null.

Hosts are considered equal if the names are equal (case independent) or if host name lookups for them both succeed and they both reference the same IP address.

Note that URLName has no knowledge of default port numbers for particular protocols, so "imap://host" and "imap://host:143" would not compare as equal.

Note also that the password field is not included in the comparison, nor is any reference field appended to the filename.

Parameters
obj

public String getFile ()

Returns the file name of this URLName. Returns null if this URLName has no file name.

public String getHost ()

Returns the host of this URLName. Returns null if this URLName has no host.

public String getPassword ()

Returns the password of this URLName. Returns null if this URLName has no password.

public int getPort ()

Returns the port number of this URLName. Returns -1 if the port is not set.

public String getProtocol ()

Returns the protocol of this URLName. Returns null if this URLName has no protocol.

public String getRef ()

Returns the reference of this URLName. Returns null if this URLName has no reference.

public URL getURL ()

Constructs a URL from the URLName.

Throws
MalformedURLException

public String getUsername ()

Returns the user name of this URLName. Returns null if this URLName has no user name.

public int hashCode ()

Compute the hash code for this URLName.

public String toString ()

Constructs a string representation of this URLName.

Protected Methods

protected void parseString (String url)

Method which does all of the work of parsing the string.

Parameters
url