URL (cat.inspiracio:url-parser 0.0.0 API)

java.lang.Object
- cat.inspiracio.url.URL

All Implemented Interfaces:

URLUtils, Serializable
```
public class URL
extends Object
implements Serializable, URLUtils
```
A proper java bean for a URL of the http protocol. Has getters and setters for Java bean style. Also has methods for fluid style. Intended to implement https://url.spec.whatwg.org/.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`URL()` Makes a new URL, initially empty.
`URL(String url)` Parses a URL from a string.
`URL(String url, String base)` http://www.w3.org/TR/url/#dom-url Not implemented.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addParameter(String key, String value)` Adds a parameter.
`URL`	`clone()` Deep clone of the URL.
`static String`	`domainToASCII(String domain)` Not implemented
`static String`	`domainToUnicode(String domain)` Not implemented
`boolean`	`endsWith(String suffix)` Does the path end with this suffix?
`boolean`	`equals(Object o)` Equality as URL: if there is no port, uses default port for the scheme ignores parameter order
`String`	`extension()`
`URL`	`extension(String e)`
`String`	`fragment()`
`URL`	`fragment(String f)`
`String`	`getExtension()` Gets the extension, without leading "." or null if there is none.
`String`	`getFragment()`
`String`	`getHash()` Gets the fragment, with initial "#", or empty string.
`String`	`getHost()` If non-standard port, returns server and post.
`String`	`getHostname()`
`String`	`getHref()`
`String`	`getMimeType()` Guesses the MIME type, or null
`String`	`getOrigin()` http://www.w3.org/TR/url/#concept-url-origin
`String`	`getParameter(String key)` Gets the first parameter value for this key, or null.
`URLParameters`	`getParameters()` May return empty parameters, but never null.
`List<String>`	`getParameters(String key)` Gets all parameter values for this key, or null.
`String`	`getPassword()`
`String`	`getPath()`
`String`	`getPathname()`
`String`	`getPort()` Gets the string representing the port that was put explicitly in the URL, or "".
`String`	`getProtocol()` Like "http:", with ":" at the end.
`String`	`getScheme()`
`String`	`getSearch()` Gets the query string, with initial "?", or null.
`URLSearchParams`	`getSearchParams()`
`String`	`getServer()`
`String`	`getUsername()`
`String`	`hash()`
`URL`	`hash(String h)`
`String`	`host()`
`URL`	`host(String h)`
`String`	`hostname()`
`URL`	`hostname(String n)`
`String`	`mimeType()`
`String`	`origin()`
`String`	`parameter(String key)`
`URL`	`parameter(String key, String value)`
`URLParameters`	`parameters()`
`List<String>`	`parameters(String key)`
`URL`	`parameters(URLParameters ps)` Sets all parameters.
`String`	`password()`
`URL`	`password(String p)`
`String`	`path()`
`URL`	`path(String p)`
`URL`	`pop()` To pop a url’s path, if url’s scheme is not "file" or url’s path does not contain a single string that is a normalized Windows drive letter, remove url’s path’s last string, if any.
`int`	`port()` Gets the port, as int.
`URL`	`port(int p)`
`String`	`protocol()`
`URL`	`protocol(String p)`
`URL`	`removeFragment()`
`URL`	`removeParameter(String key)`
`URL`	`removeParameters()`
`String`	`scheme()`
`URL`	`scheme(String s)`
`String`	`server()`
`URL`	`server(String s)`
`void`	`setExtension(String extension)`
`void`	`setFragment(String f)`
`void`	`setHash(String h)` Sets the fragment.
`void`	`setHost(String h)` Sets server and maybe also port.
`void`	`setHostname(String n)`
`void`	`setHref(String input)` Sets the URL to the URL parsed from input.
`void`	`setParameter(String key, String value)` Sets a parameter.
`void`	`setParameters(URLParameters ps)` Sets all parameters.
`void`	`setPassword(String p)`
`void`	`setPath(String p)` Sets the path.
`void`	`setPathname(String p)`
`void`	`setPort(int p)`
`void`	`setPort(String s)`
`void`	`setProtocol(String p)`
`void`	`setScheme(String s)`
`void`	`setSearch(String s)`
`void`	`setSearchParams(URLSearchParams ps)`
`void`	`setServer(String s)`
`void`	`setUsername(String u)`
`String`	`toString()` The complete URL as String.
`String`	`username()`
`URL`	`username(String u)`

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

- Constructor Detail
  - URL
```
public URL()
```
    Makes a new URL, initially empty.
  - URL
```
public URL(String url)
```
    Parses a URL from a string. Null is like empty string.
  - URL
```
public URL(String url,
   String base)
```
    http://www.w3.org/TR/url/#dom-url Not implemented.
- Method Detail
  - clone
```
public URL clone()
```
    Deep clone of the URL.
    
    Overrides:
    
    clone in class Object
  - getScheme
```
public String getScheme()
```
  - setScheme
```
public void setScheme(String s)
```
  - scheme
```
public String scheme()
```
  - scheme
```
public URL scheme(String s)
```
  - setProtocol
```
public void setProtocol(String p)
```
    Specified by:
    
    setProtocol in interface URLUtils
  - protocol
```
public URL protocol(String p)
```
  - getProtocol
```
public String getProtocol()
```
    Like "http:", with ":" at the end. If there is no scheme, returns ":". http://www.w3.org/TR/url/#dom-urlutils-protocol
    
    Specified by:
    
    getProtocol in interface URLUtils
  - protocol
```
public String protocol()
```
  - setUsername
```
public void setUsername(String u)
```
    Specified by:
    
    setUsername in interface URLUtils
  - username
```
public URL username(String u)
```
  - getUsername
```
public String getUsername()
```
    Specified by:
    
    getUsername in interface URLUtils
  - username
```
public String username()
```
  - setPassword
```
public void setPassword(String p)
```
    Specified by:
    
    setPassword in interface URLUtils
  - password
```
public URL password(String p)
```
  - getPassword
```
public String getPassword()
```
    Specified by:
    
    getPassword in interface URLUtils
  - password
```
public String password()
```
  - getServer
```
public String getServer()
```
  - setServer
```
public void setServer(String s)
```
  - server
```
public String server()
```
  - server
```
public URL server(String s)
```
  - setHostname
```
public void setHostname(String n)
```
    Specified by:
    
    setHostname in interface URLUtils
  - getHostname
```
public String getHostname()
```
    Specified by:
    
    getHostname in interface URLUtils
  - hostname
```
public URL hostname(String n)
```
  - hostname
```
public String hostname()
```
  - getPort
```
public String getPort()
```
    Gets the string representing the port that was put explicitly in the URL, or "".
    
    Specified by:
    
    getPort in interface URLUtils
  - setPort
```
public void setPort(int p)
```
    Specified by:
    
    setPort in interface URLUtils
  - setPort
```
public void setPort(String s)
```
    Specified by:
    
    setPort in interface URLUtils
  - port
```
public int port()
```
    Gets the port, as int. If the port has not been set explicitly, returns the default port for the scheme. If there is no scheme or the scheme has no default port, returns 0 as bad value.
    
    Specified by:
    
    port in interface URLUtils
  - port
```
public URL port(int p)
```
  - setHost
```
public void setHost(String h)
```
    Sets server and maybe also port. partial implementation: no IPs
    
    Specified by:
    
    setHost in interface URLUtils
  - host
```
public URL host(String h)
```
  - getHost
```
public String getHost()
```
    If non-standard port, returns server and post.
    
    Specified by:
    
    getHost in interface URLUtils
  - host
```
public String host()
```
  - getOrigin
```
public String getOrigin()
```
    http://www.w3.org/TR/url/#concept-url-origin
    
    Specified by:
    
    getOrigin in interface URLUtils
  - origin
```
public String origin()
```
  - setPath
```
public void setPath(String p)
```
    Sets the path. An absolute path starts with "/".
  - getPath
```
public String getPath()
```
  - path
```
public String path()
```
  - path
```
public URL path(String p)
```
  - setPathname
```
public void setPathname(String p)
```
    Specified by:
    
    setPathname in interface URLUtils
  - getPathname
```
public String getPathname()
```
    Specified by:
    
    getPathname in interface URLUtils
  - pop
```
public URL pop()
```
    To pop a url’s path, if url’s scheme is not "file" or url’s path does not contain a single string that is a normalized Windows drive letter, remove url’s path’s last string, if any. Not clear whether the resulting URL should end in "/" or not. I'll leave the final "/".
  - getExtension
```
public String getExtension()
```
    Gets the extension, without leading "." or null if there is none.
  - extension
```
public String extension()
```
  - setExtension
```
public void setExtension(String extension)
```
    Parameters:
    extension - Like "html", without leading "." If the extension is null, removes the exception.
  - extension
```
public URL extension(String e)
```
  - getParameter
```
public String getParameter(String key)
```
    Gets the first parameter value for this key, or null.
  - parameter
```
public String parameter(String key)
```
  - getParameters
```
public List<String> getParameters(String key)
```
    Gets all parameter values for this key, or null.
  - parameters
```
public List<String> parameters(String key)
```
  - addParameter
```
public void addParameter(String key,
                String value)
```
    Adds a parameter. Setting a parameter to null removes it.
  - setParameter
```
public void setParameter(String key,
                String value)
```
    Sets a parameter. Overwrites the parameter if it is already set. Setting a parameter to null removes it.
  - parameter
```
public URL parameter(String key,
            String value)
```
  - getParameters
```
public URLParameters getParameters()
```
    May return empty parameters, but never null.
  - parameters
```
public URLParameters parameters()
```
  - setParameters
```
public void setParameters(URLParameters ps)
```
    Sets all parameters. Passing null removes all parameters.
  - parameters
```
public URL parameters(URLParameters ps)
```
    Sets all parameters. Passing null removes all parameters.
  - removeParameter
```
public URL removeParameter(String key)
```
  - removeParameters
```
public URL removeParameters()
```
  - setSearchParams
```
public void setSearchParams(URLSearchParams ps)
```
    Specified by:
    
    setSearchParams in interface URLUtils
  - getSearchParams
```
public URLSearchParams getSearchParams()
```
    Specified by:
    
    getSearchParams in interface URLUtils
  - setSearch
```
public void setSearch(String s)
```
    Specified by:
    
    setSearch in interface URLUtils
  - getSearch
```
public String getSearch()
```
    Gets the query string, with initial "?", or null. http://www.w3.org/TR/url/#dom-urlutils-search ?key=value&key=value
    
    Specified by:
    
    getSearch in interface URLUtils
  - endsWith
```
public boolean endsWith(String suffix)
```
    Does the path end with this suffix?
  - fragment
```
public String fragment()
```
  - getFragment
```
public String getFragment()
```
  - setFragment
```
public void setFragment(String f)
```
  - fragment
```
public URL fragment(String f)
```
  - removeFragment
```
public URL removeFragment()
```
  - setHash
```
public void setHash(String h)
```
    Sets the fragment. Setting it to empty string or null removes the fragment.
    
    Specified by:
    
    setHash in interface URLUtils
    
    Parameters:
    h - New fragment. If it doesn't start with "#", the initial "#" is assumed.
  - hash
```
public URL hash(String h)
```
  - getHash
```
public String getHash()
```
    Gets the fragment, with initial "#", or empty string.
    
    Specified by:
    
    getHash in interface URLUtils
  - hash
```
public String hash()
```
  - toString
```
public String toString()
```
    The complete URL as String. Username and password are shown, encoded. If the port is standard, it will not appear. The parameters appear in the order they were inserted.
    
    Overrides:
    
    toString in class Object
  - setHref
```
public void setHref(String input)
```
    Sets the URL to the URL parsed from input. Parsing may fail.
    
    Specified by:
    
    setHref in interface URLUtils
  - getHref
```
public String getHref()
```
    Specified by:
    
    getHref in interface URLUtils
  - getMimeType
```
public String getMimeType()
```
    Guesses the MIME type, or null
  - mimeType
```
public String mimeType()
```
  - equals
```
public boolean equals(Object o)
```
    Equality as URL:
    - if there is no port, uses default port for the scheme
    - ignores parameter order
    Overrides:
    
    equals in class Object
  - domainToASCII
```
public static String domainToASCII(String domain)
```
    Not implemented
  - domainToUnicode
```
public static String domainToUnicode(String domain)
```
    Not implemented

Class URL

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

URL

URL

URL

Method Detail

clone

getScheme

setScheme

scheme

scheme

setProtocol

protocol

getProtocol

protocol

setUsername

username

getUsername

username

setPassword

password

getPassword

password

getServer

setServer

server

server

setHostname

getHostname

hostname

hostname

getPort

setPort

setPort

port

port

setHost

host

getHost

host

getOrigin

origin

setPath

getPath

path

path

setPathname

getPathname

pop

getExtension

extension

setExtension

extension

getParameter

parameter

getParameters

parameters

addParameter

setParameter

parameter

getParameters

parameters

setParameters

parameters

removeParameter

removeParameters

setSearchParams

getSearchParams

setSearch

getSearch

endsWith

fragment

getFragment

setFragment

fragment

removeFragment

setHash