JavaMail API 1.6.2 · javax.mail.URLName

Field Summary

Modifier and Type	Field and Description
pack-priv static final int	caseDiff
private static boolean	doEncode A way to turn off encoding, just in case...
pack-priv 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

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
private static String	_encode(String s)
pack-priv static String	Returns: the newly decoded `String` decode(String the `String` to decode s) Decodes a "x-www-form-urlencoded" to a `String`.
pack-priv static String	Returns: the translated `String`. encode(String `String` to be translated. s) Translates a string into `x-www-form-urlencoded` format.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Compares two URLNames.
public String	Returns: the file name of this URLName getFile() Returns the file name of this URLName.
public String	Returns: the host name getHost() Returns the host of this URLName.
private synchronized InetAddress	getHostAddress() Get the IP address of our host.
public String	Returns: the password getPassword() Returns the password of this URLName.
public int	Returns: the port number getPort() Returns the port number of this URLName.
public String	Returns: the protocol getProtocol() Returns the protocol of this URLName.
public String	Returns: the reference part of the URLName getRef() Returns the reference of this URLName.
public URL	Returns: the URL getURL() Constructs a URL from the URLName.
public String	Returns: the user name getUsername() Returns the user name of this URLName.
public int	hashCode() Overrides java.lang.Object.hashCode. Compute the hash code for this URLName.
private static int	indexOfAny(String s, String any) Return the first index of any of the characters in "any" in "s", or -1 if none are found.
private static int	indexOfAny(String s, String any, int start)
protected void	parseString(String the URL string to parse url) Method which does all of the work of parsing the string.
public String	toString() Overrides java.lang.Object.toString. Constructs a string representation of this URLName.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

caseDiff	back to summary
pack-priv static final int caseDiff

doEncode	back to summary
private static boolean doEncode A way to turn off encoding, just in case...

dontNeedEncoding back to summary

dontNeedEncoding	back to summary
pack-priv 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. Author Herb Jellinek Since JDK1.0

pack-priv 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.

Author: Herb Jellinek
Since: JDK1.0

file	back to summary
private String file The specified file name on that host.

fullURL	back to summary
protected String fullURL The full version of the URL

hashCode	back to summary
private int hashCode Our hash code.

host	back to summary
private String host The host name to which to connect.

hostAddress	back to summary
private InetAddress hostAddress The host's IP address, used in equals and hashCode. Computed on demand.

hostAddressKnown	back to summary
private boolean hostAddressKnown

password	back to summary
private String password The password to use when connecting.

port	back to summary
private int port The protocol port to connect to.

protocol	back to summary
private String protocol The protocol to use (ftp, http, nntp, imap, pop3 ... etc.) .

ref	back to summary
private String ref # reference.

username	back to summary
private String username The username to use when connecting

Constructor Detail

URLName	back to summary
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:String the protocol host:String the host name port:int the port number file:String the file username:String the user name password:String the password

URLName

back to summary

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:String: the protocol
host:String: the host name
port:int: the port number
file:String: the file
username:String: the user name
password:String: the password

URLName	back to summary
public URLName(URL url) Construct a URLName from a java.net.URL object. Parameters url:URL the URL

URLName

back to summary

public URLName(URL url)

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

Parameters

url:URL: the URL

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

URLName

back to summary

public URLName(String url)

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

Parameters

url:String: the URL string

Method Detail

_encode	back to summary
private static String _encode(String s)

decode back to summary

decode	back to summary
pack-priv static String decode(String s) Decodes a "x-www-form-urlencoded" to a `String`. Parameters s:String the `String` to decode Returns:String the newly decoded `String`

pack-priv static String decode(String s)

Decodes a "x-www-form-urlencoded" to a String.

Parameters

s:String: the String to decode

Returns:String

the newly decoded String

encode back to summary

encode	back to summary
pack-priv static String encode(String s) Translates a string into `x-www-form-urlencoded` format. Parameters s:String `String` to be translated. Returns:String the translated `String`.

pack-priv static String encode(String s)

Translates a string into x-www-form-urlencoded format.

Parameters

s:String: String to be translated.

Returns:String

the translated String.

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. 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:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

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:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

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

getFile

back to summary

public String getFile()

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

Returns:String: the file name of this URLName

getHost	back to summary
public String getHost() Returns the host of this URLName. Returns null if this URLName has no host. Returns:String the host name

getHost

back to summary

public String getHost()

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

Returns:String: the host name

getHostAddress	back to summary
private synchronized InetAddress getHostAddress() Get the IP address of our host. Look up the name the first time and remember that we've done so, whether the lookup fails or not.

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

getPassword

back to summary

public String getPassword()

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

Returns:String: the password

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

getPort

back to summary

public int getPort()

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

Returns:int: the port number

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

getProtocol

back to summary

public String getProtocol()

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

Returns:String: the protocol

getRef	back to summary
public String getRef() Returns the reference of this URLName. Returns null if this URLName has no reference. Returns:String the reference part of the URLName

getRef

back to summary

public String getRef()

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

Returns:String: the reference part of the URLName

getURL	back to summary
public URL getURL() throws MalformedURLException Constructs a URL from the URLName. Returns:URL the URL Exceptions MalformedURLException: if the URL is malformed

getURL

back to summary

public URL getURL() throws MalformedURLException

Constructs a URL from the URLName.

Returns:URL

the URL

Exceptions

MalformedURLException:: if the URL is malformed

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

getUsername

back to summary

public String getUsername()

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

Returns:String: the user name

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Compute the hash code for this URLName. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Compute the hash code for this URLName.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

indexOfAny	back to summary
private static int indexOfAny(String s, String any) Return the first index of any of the characters in "any" in "s", or -1 if none are found. This should be a method on String.

indexOfAny	back to summary
private static int indexOfAny(String s, String any, int start)

parseString	back to summary
protected void parseString(String url) Method which does all of the work of parsing the string. Parameters url:String the URL string to parse

parseString

back to summary

protected void parseString(String url)

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

Parameters

url:String: the URL string to parse

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Constructs a string representation of this URLName. Returns:String Doc from java.lang.Object.toString. a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Constructs a string representation of this URLName.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

public Class URLName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail