Url (inversion-api 0.9.27 API)

java.lang.Object
- io.inversion.utils.Url

```
public class Url
extends java.lang.Object
```
Utility class for parsing and working with HTTP(S) URLs.
Not for use with non HTTP(S) urls.
A number of different utility methods are provided to make it simple to find or remove different query string keys.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`host` The url host.
`protected java.lang.String`	`original` The url string as supplied to the constructor, with 'http://localhost/' prepended if the constructor url arg did not contain a host
`protected JSNode`	`params` A case insensitive map of query string name/value pairs that preserves iteration order
`protected Path`	`path` The part of the url after the host/port before the query string.
`protected int`	`port` The url port number if a custom port was provided
`protected java.lang.String`	`protocol` The url protocol, either http or https

Constructor Summary

Constructors
Constructor and Description

Url(java.lang.String url)
Parses url into its protocol, host, port, path and query string param parts.

Constructors
Constructor and Description
`Url(java.lang.String url)` Parses `url` into its protocol, host, port, path and query string param parts.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`clearParams(java.lang.String... tokens)` Removes any param that has one of `tokens` as a whole word case insensitive substring in the key.
`boolean`	`equals(java.lang.Object url)` Checks url equality based on type and toString equality
`java.lang.String`	`findKey(java.lang.String... tokens)` Finds a key that has any one of `tokens` as a whole word case insensitive substring
`java.lang.String`	`findKeyValue(java.lang.String... tokens)` Finds the value associated with `findKey(tokens)`
`java.lang.String`	`getDomain()`
`java.lang.String`	`getFile()` Gets the last url path part if it exists
`java.lang.String`	`getHost()`
`java.lang.String`	`getOriginal()`
`java.lang.String`	`getParam(java.lang.String key)` Gets the param value with `key` based on a case insensitive match.
`java.util.Map<java.lang.String,java.lang.String>`	`getParams()`
`Path`	`getPath()`
`int`	`getPort()`
`java.lang.String`	`getProtocol()`
`java.lang.String`	`getQuery()` Deprecated. replaced by `getQueryString()`
`java.lang.String`	`getQueryString()` Generates a URL encode query string for `params`
`void`	`replaceParam(java.lang.String key, java.lang.String value)` Replaces any existing param that has `key` as a whole word case insensitive substring in its key.
`static java.lang.String`	`toQueryString(java.util.Map params)` Creates a UTF-8 url encoded query string, not including a leading "?" with key value pairs separated by a '&'
`java.lang.String`	`toString()` Generates a string string representation of this url with any query string parameters URL encoded and port number included only if it differs from the standard protocol port.
`Url`	`withHost(java.lang.String host)`
`Url`	`withParam(java.lang.String name, java.lang.String value)` Adds name/value to `params` overwriting any preexisting key/value pair on a key case insensitive basis.
`Url`	`withParams(java.util.Map<java.lang.String,java.lang.String> newParams)` Adds all key/value pairs from `newParams` to `params` overwriting any exiting keys on a case insensitive basis
`Url`	`withParams(java.lang.String... nvpairs)`
`Url`	`withPath(Path path)`
`Url`	`withPort(int port)`
`Url`	`withProtocol(java.lang.String protocol)`
`Url`	`withQueryString(java.lang.String queryString)` Parses `queryString` and replace `params`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - original
```
protected final java.lang.String original
```
    The url string as supplied to the constructor, with 'http://localhost/' prepended if the constructor url arg did not contain a host
  - protocol
```
protected java.lang.String protocol
```
    The url protocol, either http or https
  - host
```
protected java.lang.String host
```
    The url host.
  - port
```
protected int port
```
    The url port number if a custom port was provided
  - path
```
protected Path path
```
    The part of the url after the host/port before the query string.
  - params
```
protected JSNode params
```
    A case insensitive map of query string name/value pairs that preserves iteration order
    Implementation Node: paramsis not actually JSON, JSNode is used as the map implementation here simply because it is an affective case insensitive map that preserves the original key case key iteration order.
- Constructor Detail
  - Url
```
public Url(java.lang.String url)
```
    Parses url into its protocol, host, port, path and query string param parts.
    If url does not start with "http://" or "https://" then "http://localhost/" will be prepended.
    
    Parameters:
    
    url - url string
- Method Detail
  - toQueryString
```
public static java.lang.String toQueryString(java.util.Map params)
```
    Creates a UTF-8 url encoded query string, not including a leading "?" with key value pairs separated by a '&'
    
    Parameters:
    
    params - the key/value pairs to encode
    
    Returns:
    
    a UTF-8 url encoded query string
    
    See Also:
    
    URLEncoder.encode(String, String)
  - toString
```
public java.lang.String toString()
```
    Generates a string string representation of this url with any query string parameters URL encoded and port number included only if it differs from the standard protocol port.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    the string representation of this url
  - equals
```
public boolean equals(java.lang.Object url)
```
    Checks url equality based on type and toString equality
    
    Overrides:
    
    equals in class java.lang.Object
    
    Returns:
    
    true if url is a Url with a matching toString
  - getDomain
```
public java.lang.String getDomain()
```
  - getQueryString
```
public java.lang.String getQueryString()
```
    Generates a URL encode query string for params
    
    Returns:
    
    a URL encoded query string if params.size() is @gt; 0 else empty string
    
    See Also:
    
    toQueryString(Map)
  - getQuery
```
public java.lang.String getQuery()
```
    Deprecated. replaced by getQueryString()
  - getHost
```
public java.lang.String getHost()
```
  - withHost
```
public Url withHost(java.lang.String host)
```
  - getPort
```
public int getPort()
```
  - withPort
```
public Url withPort(int port)
```
  - getProtocol
```
public java.lang.String getProtocol()
```
  - withProtocol
```
public Url withProtocol(java.lang.String protocol)
```
  - getPath
```
public Path getPath()
```
  - withPath
```
public Url withPath(Path path)
```
  - getFile
```
public java.lang.String getFile()
```
    Gets the last url path part if it exists
    
    Returns:
    
    path.last() if it exists otherwise null
  - withQueryString
```
public Url withQueryString(java.lang.String queryString)
```
    Parses queryString and replace params
    
    Parameters:
    
    queryString - query prams to add
    
    Returns:
    
    this
  - withParams
```
public Url withParams(java.util.Map<java.lang.String,java.lang.String> newParams)
```
    Adds all key/value pairs from newParams to params overwriting any exiting keys on a case insensitive basis
    
    Parameters:
    
    newParams - name/value pairs to add to the query string params map
    
    Returns:
    
    this
  - withParam
```
public Url withParam(java.lang.String name,
                     java.lang.String value)
```
    Adds name/value to params overwriting any preexisting key/value pair on a key case insensitive basis.
    
    Parameters:
    
    name - the key to add or overwrite, may not be null
    
    value - the value, may be null
    
    Returns:
    
    this
  - withParams
```
public Url withParams(java.lang.String... nvpairs)
```
  - replaceParam
```
public void replaceParam(java.lang.String key,
                         java.lang.String value)
```
    Replaces any existing param that has key as a whole word case insensitive substring in its key.
    If the key/value pair "eq(dog,Fido)" = null is in the map replaceParam("DOG", "Fifi") would cause it to be removed and the pair "DOG" / "Fifi" would be added.
    
    Parameters:
    
    key - the key to add overwrite, may not be null, also used a a regex whole world case insensitive token to search for other keys to remove.
    
    value - the value, may be null
    
    See Also:
    
    Utils.containsToken(java.lang.String, java.lang.String)
  - clearParams
```
public java.lang.String clearParams(java.lang.String... tokens)
```
    Removes any param that has one of tokens as a whole word case insensitive substring in the key.
    
    Parameters:
    
    tokens - string tokens when found in a param key will cause them to be removed
    
    Returns:
    
    the first value found that contained any one of tokens
    
    See Also:
    
    Utils.containsToken(java.lang.String, java.lang.String)
  - findKey
```
public java.lang.String findKey(java.lang.String... tokens)
```
    Finds a key that has any one of tokens as a whole word case insensitive substring
    
    Parameters:
    
    tokens - substrings to search params.keySet() for
    
    Returns:
    
    the first param key that has anyone of tokens as a whole word case insensitive substring
  - findKeyValue
```
public java.lang.String findKeyValue(java.lang.String... tokens)
```
    Finds the value associated with findKey(tokens)
    
    Parameters:
    
    tokens - substrings to search params.keySet() for
    
    Returns:
    
    the value for the first param key that has anyone of tokens as a whole word case insensitive substring
    
    See Also:
    
    findKey(String...)
  - getParam
```
public java.lang.String getParam(java.lang.String key)
```
    Gets the param value with key based on a case insensitive match.
    
    Parameters:
    
    key - the key to get
    
    Returns:
    
    the param value for key based on a case insensitive match.
  - getParams
```
public java.util.Map<java.lang.String,java.lang.String> getParams()
```
    Returns:
    
    a new case insensitive order preserving map copy of params
  - getOriginal
```
public java.lang.String getOriginal()
```
    Returns:
    
    the url string used in constructing this Url.

Class Url

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

original

protocol

host

port

path

params

Constructor Detail

Url

Method Detail

toQueryString

toString

equals

getDomain

getQueryString

getQuery

getHost

withHost

getPort

withPort

getProtocol

withProtocol

getPath

withPath

getFile

withQueryString

withParams

withParam

withParams

replaceParam

clearParams

findKey

findKeyValue

getParam

getParams

getOriginal