com.adaptris.util

Class URLString

java.lang.Object

com.adaptris.util.URLString

All Implemented Interfaces:

java.io.Serializable

public class URLString
extends java.lang.Object
implements java.io.Serializable

A Simple URL parser, that can parse any given URL into it's constituent parts.

A URL should be in the form <protocol>://<user:password>@<host:port>/<path>#ref Example:

• smtp://user%40btinternet.com:password@mail.btinternet.com/
• http://myname:password@localhost:8080/thisURL

Does almost the same thing as URLName but is serializable so it can be used over JMX. The only difference is within the getURL() method where a / prefix will be added to the file name for non file url.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	fullURL The full version of the URL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	URLString()
	URLString(java.io.File file) Construct a URLString from a java.io.File object.
	URLString(java.lang.String url) Construct a URLString from the string.
	URLString(java.lang.String protocol, java.lang.String host, int port, java.lang.String file, java.lang.String username, java.lang.String password) Creates a URLString object from the specified protocol, host, port number, file, username, and password.
	URLString(java.net.URL url) Construct a URLString from a java.net.URL object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getFile() Returns the file name of this URLString.
java.lang.String	getHost() Returns the host of this URLString.
java.lang.String	getPassword() Returns the password of this URLString.
int	getPort() Returns the port number of this URLString.
java.lang.String	getProtocol() Returns the protocol of this URLString.
java.lang.String	getRef() Returns the reference of this URLString.
java.net.URL	getURL() Constructs a URL from the URLString.
java.lang.String	getUsername() Returns the user name of this URLString.
int	hashCode() Compute the hash code for this URLString.
java.lang.String	toString() Constructs a string representation of this URLString.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

fullURL

protected java.lang.String fullURL

The full version of the URL

Constructor Detail

URLString

protected URLString()

URLString

public URLString(java.lang.String protocol,
                 java.lang.String host,
                 int port,
                 java.lang.String file,
                 java.lang.String username,
                 java.lang.String password)

Creates a URLString 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.

URLString

public URLString(java.net.URL url)

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

URLString

public URLString(java.io.File file)
          throws java.net.MalformedURLException

Construct a URLString from a java.io.File object.

Throws:

java.net.MalformedURLException

URLString

public URLString(java.lang.String url)

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

Method Detail

toString

public java.lang.String toString()

Constructs a string representation of this URLString.

Overrides:

toString in class java.lang.Object

getPort

public int getPort()

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

getProtocol

public java.lang.String getProtocol()

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

getFile

public java.lang.String getFile()

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

getRef

public java.lang.String getRef()

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

getHost

public java.lang.String getHost()

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

getUsername

public java.lang.String getUsername()

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

getPassword

public java.lang.String getPassword()

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

getURL

public java.net.URL getURL()
                    throws java.net.MalformedURLException

Constructs a URL from the URLString.

Throws:

java.net.MalformedURLException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Compute the hash code for this URLString.

Overrides:

hashCode in class java.lang.Object