java.lang.Object
- org.refcodes.web.UrlSugar

```
public class UrlSugar
extends Object
```
Declarative syntactic sugar which may be statically imported in order to allow declarative definitions for Url (Url.UrlBuilder) creation and tweaking: import static org.refcodes.web.UrlSugar.*;

Constructor Summary

Constructors
Constructor Description

UrlSugar()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Url.UrlBuilder`	`toUrl()`	Creates an empty `Url.UrlBuilder`, make sure to set required attributes for a valid URL.
`Url.UrlBuilder`	`toUrl(String aUrl)`	Constructs an `Url.UrlBuilder` from the provided URL `String`.
`Url.UrlBuilder`	`toUrl(String aProtocol, String aHost)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(String aProtocol, String aHost, int aPort)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(String aProtocol, String aHost, int aPort, String aPath)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(String aProtocol, String aHost, int aPort, String aPath, FormFields aQueryFields)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(String aProtocol, String aHost, int aPort, String aPath, FormFields aQueryFields, String aFragment)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(String aProtocol, String aHost, String aPath)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(String aProtocol, String aHost, String aPath, FormFields aQueryFields)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(String aProtocol, String aHost, String aPath, FormFields aQueryFields, String aFragment)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(URL aURL)`	Constructs an `Url.UrlBuilder` from the provided `URL` instance.
`Url.UrlBuilder`	`toUrl(org.refcodes.data.Scheme aScheme, String aHost)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath, FormFields aQueryFields)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath, FormFields aQueryFields, String aFragment)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath, FormFields aQueryFields)`	Constructs an `Url.UrlBuilder` with the common attributes.
`Url.UrlBuilder`	`toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath, FormFields aQueryFields, String aFragment)`	Constructs an `Url.UrlBuilder` with the common attributes.

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

- Constructor Detail
  - UrlSugar
```
public UrlSugar()
```
- Method Detail
  - toUrl
```
public Url.UrlBuilder toUrl()
```
    Creates an empty Url.UrlBuilder, make sure to set required attributes for a valid URL.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aUrl)
                     throws MalformedURLException
```
    Constructs an Url.UrlBuilder from the provided URL String.
    
    Parameters:
    
    aUrl - The URL String to be parsed.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
    
    Throws:
    
    MalformedURLException - in case the provided URL is considered being malformed.
  - toUrl
```
public Url.UrlBuilder toUrl(URL aURL)
```
    Constructs an Url.UrlBuilder from the provided URL instance.
    
    Parameters:
    
    aURL - The URL to be used.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                            String aHost)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                            String aHost,
                            int aPort)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPort - The port to be used when connecting to the host.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                            String aHost,
                            int aPort,
                            String aPath)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPort - The port to be used when connecting to the host.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                            String aHost,
                            int aPort,
                            String aPath,
                            FormFields aQueryFields)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPort - The port to be used when connecting to the host.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    aQueryFields - The Query-Fields to be used for the HTTP Query-String.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                            String aHost,
                            int aPort,
                            String aPath,
                            FormFields aQueryFields,
                            String aFragment)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPort - The port to be used when connecting to the host.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    aQueryFields - The Query-Fields to be used for the HTTP Query-String.
    
    aFragment - The fragment to be set.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aProtocol,
                            String aHost)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aProtocol - The protocol String (e.g. "http://" or "https://") to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aProtocol,
                            String aHost,
                            int aPort)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aProtocol - The protocol String (e.g. "http://" or "https://") to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPort - The port to be used when connecting to the host.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aProtocol,
                            String aHost,
                            int aPort,
                            String aPath)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aProtocol - The protocol String (e.g. "http://" or "https://") to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPort - The port to be used when connecting to the host.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aProtocol,
                            String aHost,
                            int aPort,
                            String aPath,
                            FormFields aQueryFields)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aProtocol - The protocol String (e.g. "http://" or "https://") to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPort - The port to be used when connecting to the host.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    aQueryFields - The Query-Fields to be used for the HTTP Query-String.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aProtocol,
                            String aHost,
                            int aPort,
                            String aPath,
                            FormFields aQueryFields,
                            String aFragment)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aProtocol - The protocol String (e.g. "http://" or "https://") to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPort - The port to be used when connecting to the host.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    aQueryFields - The Query-Fields to be used for the HTTP Query-String.
    
    aFragment - The fragment to be set.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                            String aHost,
                            String aPath)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                            String aHost,
                            String aPath,
                            FormFields aQueryFields)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    aQueryFields - The Query-Fields to be used for the HTTP Query-String.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                            String aHost,
                            String aPath,
                            FormFields aQueryFields,
                            String aFragment)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aScheme - The Scheme (e.g. HTTP or HTTPS) to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    aQueryFields - The Query-Fields to be used for the HTTP Query-String.
    
    aFragment - The fragment to be set.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aProtocol,
                            String aHost,
                            String aPath)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aProtocol - The protocol String (e.g. "http://" or "https://") to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aProtocol,
                            String aHost,
                            String aPath,
                            FormFields aQueryFields)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aProtocol - The protocol String (e.g. "http://" or "https://") to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    aQueryFields - The Query-Fields to be used for the HTTP Query-String.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.
  - toUrl
```
public Url.UrlBuilder toUrl(String aProtocol,
                            String aHost,
                            String aPath,
                            FormFields aQueryFields,
                            String aFragment)
```
    Constructs an Url.UrlBuilder with the common attributes.
    
    Parameters:
    
    aProtocol - The protocol String (e.g. "http://" or "https://") to be used for the destination URL.
    
    aHost - The host to which the destination URL is to point to.
    
    aPath - The path on the host to which the base destination URL is to point to.
    
    aQueryFields - The Query-Fields to be used for the HTTP Query-String.
    
    aFragment - The fragment to be set.
    
    Returns:
    
    The accordingly constructed Url.UrlBuilder instance.

Class UrlSugar

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

UrlSugar

Method Detail

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl

toUrl