com.cloudhopper.commons.util

Class URL

java.lang.Object

com.cloudhopper.commons.util.URL

public class URL
extends Object

Represents a URL and its various properties. Not all properties are currently supported by this class A URL is of the form: protocol://[ username [: password ]@] host [: port ][/path][?query_string][#anchor] The best method for creating a URL is to use the URLParser class. While this utility class doesn't provide any more features yet than the internal Java URL class, the plan is to add those in the future. Also, this class and its associated parser internally use the modern StringBuilder class vs. the StringBuffer class and avoid any synchronization overhead.

Author:

joelauer (twitter: @jjlauer or http://twitter.com/jjlauer)

Constructor Summary

Constructors

Constructor and Description
URL()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object)
String	getHost() Gets the host such as "www.google.com" if the URL is "http://www.google.com"
String	getPassword() Gets the password such as "test" if the URL is "http://root:test@www.google.com/" or "t@st" if the URL is "http://root:t%40st@www.google.com/".
String	getPath() Gets the path such as "/" if the URL is "http://www.google.com/" or "/My Documents/index.html" if the URL is "http://www.google.com/My+Documents/index.html".
Integer	getPort() Gets the port such as 80 if the URL specifically included a port such as "http://www.google.com:80/".
String	getProtocol() Gets the protocol such as "http" if the URL is "http://www.google.com"
String	getQuery() Gets the query such as "id=1&pk=3" if the URL was "http://www.google.com/index.html?id=1&pk=3".
Properties	getQueryProperties()
String	getQueryProperty(String name)
String	getUsername() Gets the username such as "root" if the URL is "http://root@www.google.com/" or "ro@t" if the URL is "http://ro%40t@www.google.com/".
int	hashCode()
static void	parseQueryProperties(String q, Properties props) Tool function: queries a query string and adds the key/value pairs to the specified properties map
void	setHost(String host) Sets the host such as "www.google.com" if the URL is "http://www.google.com"
void	setPassword(String password) Sets the password such as "test" if the URL is "http://root:test@www.google.com/" or "t@st" if the URL is "http://root:t%40st@www.google.com/".
void	setPath(String path) Sets the path such as "/" if the URL is "http://www.google.com/" or "/My Documents/index.html" if the URL is "http://www.google.com/My+Documents/index.html".
void	setPort(Integer port) Sets the port such as 80 if the URL should specifically include a port such as "http://www.google.com:80/".
void	setProtocol(String protocol) Sets the protocol such as "http" if the URL is "http://www.google.com"
void	setQuery(String value)
void	setUsername(String username) Sets the username such as "root" if the URL is "http://root@www.google.com/" or "ro@t" if the URL is "http://ro%40t@www.google.com/".
String	toString() Builds and returns a properly encoded URL in its full string form such as "http://www.google.com/".

Methods inherited from class java.lang.Object

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

Constructor Detail

URL

public URL()

Method Detail

toString

public String toString()

Builds and returns a properly encoded URL in its full string form such as "http://www.google.com/". The URL will have all its values properly escaped such as a space " " being converted into "+" while the AT char "@" will be replaced by its % (percent) encoded equivalent.

Overrides:

toString in class Object

Returns:

The URL in its full string form

setProtocol

public void setProtocol(String protocol)

Sets the protocol such as "http" if the URL is "http://www.google.com"

Parameters:

protocol - The protocol or null if not set

getProtocol

public String getProtocol()

Gets the protocol such as "http" if the URL is "http://www.google.com"

Returns:

The protocol or null if not set

setUsername

public void setUsername(String username)

Sets the username such as "root" if the URL is "http://root@www.google.com/" or "ro@t" if the URL is "http://ro%40t@www.google.com/". The value should be in its decoded form (not URL encoded).

Parameters:

username - The username in URL-decoded form or null if not set

getUsername

public String getUsername()

Gets the username such as "root" if the URL is "http://root@www.google.com/" or "ro@t" if the URL is "http://ro%40t@www.google.com/". The value will be decoded from its "URL encoding" form if it contained characters that require escaping.

Returns:

The username in URL-decoded form or null if not set

setPassword

public void setPassword(String password)

Sets the password such as "test" if the URL is "http://root:test@www.google.com/" or "t@st" if the URL is "http://root:t%40st@www.google.com/". The value should be in its decoded form (not URL encoded).

Parameters:

username - The password in URL-decoded form or null if not set

getPassword

public String getPassword()

Gets the password such as "test" if the URL is "http://root:test@www.google.com/" or "t@st" if the URL is "http://root:t%40st@www.google.com/". The value will be decoded from its "URL encoding" form if it contained characters that require escaping.

Returns:

The password in URL-decoded form or null if not set

setHost

public void setHost(String host)

Sets the host such as "www.google.com" if the URL is "http://www.google.com"

getHost

public String getHost()

Gets the host such as "www.google.com" if the URL is "http://www.google.com"

Returns:

The host or null if not set

setPort

public void setPort(Integer port)

Sets the port such as 80 if the URL should specifically include a port such as "http://www.google.com:80/". If the URL should not include a port, set this value to null.

getPort

public Integer getPort()

Gets the port such as 80 if the URL specifically included a port such as "http://www.google.com:80/". If the URL did not include a port, this will return null such as the URL "http://www.google.com/"

Returns:

The port or null if not set

setPath

public void setPath(String path)

Sets the path such as "/" if the URL is "http://www.google.com/" or "/My Documents/index.html" if the URL is "http://www.google.com/My+Documents/index.html". The value should be in its decoded form (not URL encoded).

getPath

public String getPath()

Gets the path such as "/" if the URL is "http://www.google.com/" or "/My Documents/index.html" if the URL is "http://www.google.com/My+Documents/index.html". The value will be decoded from its "URL encoding" form if it contained characters that require escaping. If a path was not included after the host[:port] portion of the URL, then this value will be null.

Returns:

The path in URL-decoded form or null if not set

getQuery

public String getQuery()

Gets the query such as "id=1&pk=3" if the URL was "http://www.google.com/index.html?id=1&pk=3". The query is the entire part after a ?. If no query was set, this will be null.

Returns:

The query or null if not set

setQuery

public void setQuery(String value)
              throws MalformedURLException

Throws:

MalformedURLException

getQueryProperty

public String getQueryProperty(String name)

getQueryProperties

public Properties getQueryProperties()

parseQueryProperties

public static void parseQueryProperties(String q,
                        Properties props)
                                 throws MalformedURLException

Tool function: queries a query string and adds the key/value pairs to the specified properties map

Parameters:

q - String

toAddTo - Properties

Throws:

MalformedURLException

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object