er.extensions.foundation
Class ERXMutableURL

java.lang.Object
  er.extensions.foundation.ERXMutableURL

public class ERXMutableURL
extends Object

ERXMutableURL provides a mutable model of a URL, including support for storing relative "URLs" in addition to the traditional absolute URL provided by the core Java URL object.

Author:

mschrag

Constructor Summary

ERXMutableURL()
Constructs a blank ERXMutableURL.

ERXMutableURL(String str)
Constructs an ERXMutableURL with all of the properties of the given external form of a URL.

ERXMutableURL(URL url)
Constructs an ERXMutableURL with all of the properties of the given URL.

Method Summary

void	addQueryParameter(String key, String value) Adds an additional query parameter to this URL.
void	addQueryParameters(NSDictionary<String,? extends Object> queryParameters) Adds additional query parameters to this URL from those defined in the given NSDictionary.
void	addQueryParameters(String queryParameters) Appends the query parameters of this URL with the given k=v&k2=v2 format string.
void	addQueryParametersMap(Map<String,String> queryParameters) Adds additional query parameters to this URL from those defined in the given Map.
void	clearQueryParameters() Clears the query parameters of this URL.
boolean	containsQueryParameter(String key) Returns true if the given key is a query parameter key in this URL.
String	host() Returns the host of this URL.
boolean	isAbsolute() Returns true if this is an absolute URL.
boolean	isFullyQualified() Returns true if there is a host defined for this URL.
static void	main(String[] args)
String	path() Returns the path of this URL.
Integer	port() Returns the port of this URL (can be null).
String	protocol() Returns the protocol of this URL.
String	queryParameter(String key) Returns the first query parameter for the given key.
Map<String,List<String>>	queryParameters() Returns the query parameters of this URL as a Map.
List<String>	queryParameters(String key) Returns the query parameters for the given key.
String	queryParametersAsString() Returns the query parameters of this URL as a String (in x=y&a=b syntax).
protected void	queryParametersAsString(StringBuffer sb)
String	ref() Returns the ref of this URL.
void	removeQueryParameter(String key) Removes the query parameters with the given key.
void	removeQueryParameter(String key, String value) Removes the query parameter value for the given key for multivalue parameters.
void	setHost(String host) Sets the host of this URL.
void	setPath(String path) Sets the path of this URL.
void	setPort(Integer port) Sets the port of this URL.
void	setProtocol(String protocol) Sets the protocol of this URL (http, https, etc).
void	setQueryParameter(String key, String value) Sets the given query parameter to the given value.
void	setQueryParameters(NSDictionary<String,? extends Object> queryParameters) Replaces the query parameters of this URL with those defined in the given NSDictionary.
void	setQueryParameters(String queryParameters) Replaces the query parameters of this URL with the given k=v&k2=v2 format string.
void	setQueryParametersMap(Map<String,List<String>> queryParameters) Replaces the query parameters of this URL with those defined in the given Map.
void	setRef(String ref) Sets the ref of this URL (the #whatever part).
void	setURL(String str) Sets the contents of this ERXMutableURL to be the same as the given URL external form.
void	setURL(URL url) Sets the contents of this ERXMutableURL to be the same as the given URL.
String	toExternalForm() Returns a String form of this URL.
String	toString()
URL	toURL() Returns a java.net.URL object of this URL (which might fail if you have a relative URL).
Map<String,String>	uniqueQueryParameters() Returns the query parameters of this URL as a Map uniqued by key (which avoids multivalue properties at the expense of predictability).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ERXMutableURL

public ERXMutableURL()

Constructs a blank ERXMutableURL.

ERXMutableURL

public ERXMutableURL(URL url)
              throws MalformedURLException

Constructs an ERXMutableURL with all of the properties of the given URL.

Parameters:

url - the URL to copy data from

Throws:

MalformedURLException - if the URL is invalid

ERXMutableURL

public ERXMutableURL(String str)
              throws MalformedURLException

Constructs an ERXMutableURL with all of the properties of the given external form of a URL.

Parameters:

str - a URL external form

Throws:

MalformedURLException - if the URL is invalid

Method Detail

setURL

public void setURL(URL url)
            throws MalformedURLException

Sets the contents of this ERXMutableURL to be the same as the given URL.

Parameters:

url - the url to copy the contents from

Throws:

MalformedURLException - if the URL is malformed

setURL

public void setURL(String str)
            throws MalformedURLException

Sets the contents of this ERXMutableURL to be the same as the given URL external form.

Parameters:

str - the external form of a URL to copy the contents from

Throws:

MalformedURLException - if the external form of the URL is malformed

isFullyQualified

public boolean isFullyQualified()

Returns true if there is a host defined for this URL.

Returns:

true if there is a host defined for this URL

isAbsolute

public boolean isAbsolute()

Returns true if this is an absolute URL.

Returns:

true if this is an absolute URL

setProtocol

public void setProtocol(String protocol)

Sets the protocol of this URL (http, https, etc).

Parameters:

protocol - the new protocol

protocol

public String protocol()

Returns the protocol of this URL.

Returns:

the protocol of this URL

setHost

public void setHost(String host)

Sets the host of this URL.

Parameters:

host - the host of this URL

host

public String host()

Returns the host of this URL.

Returns:

the host of this URL

setPath

public void setPath(String path)

Sets the path of this URL.

Parameters:

path - the path of this URL

path

public String path()

Returns the path of this URL.

Returns:

the path of this URL

setPort

public void setPort(Integer port)

Sets the port of this URL.

Parameters:

port - the port of this URL

port

public Integer port()

Returns the port of this URL (can be null).

Returns:

the port of this URL (can be null)

setRef

public void setRef(String ref)

Sets the ref of this URL (the #whatever part).

Parameters:

ref - the ref of this URL (the #whatever part)

ref

public String ref()

Returns the ref of this URL.

Returns:

the ref of this URL

setQueryParameters

public void setQueryParameters(String queryParameters)
                        throws MalformedURLException

Replaces the query parameters of this URL with the given k=v&k2=v2 format string.

Parameters:

queryParameters - the query parameters

Throws:

MalformedURLException - if the string is malformed

addQueryParameters

public void addQueryParameters(String queryParameters)
                        throws MalformedURLException

Appends the query parameters of this URL with the given k=v&k2=v2 format string.

Parameters:

queryParameters - the query parameters

Throws:

MalformedURLException - if the string is malformed

setQueryParametersMap

public void setQueryParametersMap(Map<String,List<String>> queryParameters)

Replaces the query parameters of this URL with those defined in the given Map.

Parameters:

queryParameters - the new query parameters

clearQueryParameters

public void clearQueryParameters()

Clears the query parameters of this URL.

setQueryParameters

public void setQueryParameters(NSDictionary<String,? extends Object> queryParameters)

Replaces the query parameters of this URL with those defined in the given NSDictionary.

Parameters:

queryParameters - the new query parameters

addQueryParameters

public void addQueryParameters(NSDictionary<String,? extends Object> queryParameters)

Adds additional query parameters to this URL from those defined in the given NSDictionary.

Parameters:

queryParameters - the new query parameters

addQueryParametersMap

public void addQueryParametersMap(Map<String,String> queryParameters)

Adds additional query parameters to this URL from those defined in the given Map.

Parameters:

queryParameters - the new query parameters

addQueryParameter

public void addQueryParameter(String key,
                              String value)

Adds an additional query parameter to this URL.

Parameters:

key - the key of the new parameter

value - the value of the new parameter

containsQueryParameter

public boolean containsQueryParameter(String key)

Returns true if the given key is a query parameter key in this URL.

Parameters:

key - the key of the parameter to lookup

Returns:

true if the given key is a query parameter key in this URL

removeQueryParameter

public void removeQueryParameter(String key)

Removes the query parameters with the given key.

Parameters:

key - the key of the query parameters to remove

removeQueryParameter

public void removeQueryParameter(String key,
                                 String value)

Removes the query parameter value for the given key for multivalue parameters.

Parameters:

key - the key of the query parameters to lookup

value - the value to remove.

queryParameters

public Map<String,List<String>> queryParameters()

Returns the query parameters of this URL as a Map.

Returns:

the query parameters of this URL as a Map

uniqueQueryParameters

public Map<String,String> uniqueQueryParameters()

Returns the query parameters of this URL as a Map uniqued by key (which avoids multivalue properties at the expense of predictability).

Returns:

the query parameters of this URL as a Map

queryParameters

public List<String> queryParameters(String key)

Returns the query parameters for the given key.

Parameters:

key - the key to lookup

Returns:

the query parmeters for the given key

queryParameter

public String queryParameter(String key)

Returns the first query parameter for the given key.

Parameters:

key - the key to lookup

Returns:

the first query parmeter for the given key

setQueryParameter

public void setQueryParameter(String key,
                              String value)

Sets the given query parameter to the given value.

Parameters:

key - the key to set

value - the value to set it to

toExternalForm

public String toExternalForm()

Returns a String form of this URL.

Returns:

a String form of this URL

queryParametersAsString

public String queryParametersAsString()

Returns the query parameters of this URL as a String (in x=y&a=b syntax).

Returns:

the query parameters of this URL as a String

queryParametersAsString

protected void queryParametersAsString(StringBuffer sb)

toURL

public URL toURL()
          throws MalformedURLException

Returns a java.net.URL object of this URL (which might fail if you have a relative URL).

Returns:

a java.net.URL that represents this URL

Throws:

MalformedURLException - if this URL cannot be represented as a java.net.URL

toString

public String toString()

Overrides:

toString in class Object

main

public static void main(String[] args)
                 throws MalformedURLException

Throws:

MalformedURLException