Module org.refcodes.web

Package org.refcodes.web

Class UrlSugar

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 (UrlBuilder) creation and tweaking: import static org.refcodes.web.UrlSugar.*;

Constructor Summary

Constructors

Constructor	Description
UrlSugar()

Method Summary

Modifier and Type	Method	Description
UrlBuilder	toUrl()	Creates an empty UrlBuilder, make sure to set required attributes for a valid URL.
UrlBuilder	toUrl(String aUrl)	Constructs an UrlBuilder from the provided URL String.
UrlBuilder	toUrl(String aProtocol, String aHost)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(String aProtocol, String aHost, int aPort)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(String aProtocol, String aHost, int aPort, String aPath)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(String aProtocol, String aHost, int aPort, String aPath, FormFields aQueryFields)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(String aProtocol, String aHost, int aPort, String aPath, FormFields aQueryFields, String aFragment)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(String aProtocol, String aHost, String aPath)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(String aProtocol, String aHost, String aPath, FormFields aQueryFields)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(String aProtocol, String aHost, String aPath, FormFields aQueryFields, String aFragment)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(URL aURL)	Constructs an UrlBuilder from the provided URL instance.
UrlBuilder	toUrl(org.refcodes.data.Scheme aScheme, String aHost)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath, FormFields aQueryFields)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath, FormFields aQueryFields, String aFragment)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath, FormFields aQueryFields)	Constructs an UrlBuilder with the common attributes.
UrlBuilder	toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath, FormFields aQueryFields, String aFragment)	Constructs an 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 UrlBuilder toUrl()

Creates an empty UrlBuilder, make sure to set required attributes for a valid URL.

Returns:

The accordingly constructed UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aUrl)
                 throws MalformedURLException

Constructs an UrlBuilder from the provided URL String.

Parameters:

aUrl - The URL String to be parsed.

Returns:

The accordingly constructed UrlBuilder instance.

Throws:

MalformedURLException - in case the provided URL is considered being malformed.

toUrl

public UrlBuilder toUrl(URL aURL)

Constructs an UrlBuilder from the provided URL instance.

Parameters:

aURL - The URL to be used.

Returns:

The accordingly constructed UrlBuilder instance.

toUrl

public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                        String aHost)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        int aPort)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        int aPort,
                        String aPath)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        int aPort,
                        String aPath,
                        FormFields aQueryFields)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        int aPort,
                        String aPath,
                        FormFields aQueryFields,
                        String aFragment)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aProtocol,
                        String aHost)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aProtocol,
                        String aHost,
                        int aPort)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aProtocol,
                        String aHost,
                        int aPort,
                        String aPath)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aProtocol,
                        String aHost,
                        int aPort,
                        String aPath,
                        FormFields aQueryFields)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aProtocol,
                        String aHost,
                        int aPort,
                        String aPath,
                        FormFields aQueryFields,
                        String aFragment)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        String aPath)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        String aPath,
                        FormFields aQueryFields)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        String aPath,
                        FormFields aQueryFields,
                        String aFragment)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aProtocol,
                        String aHost,
                        String aPath)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aProtocol,
                        String aHost,
                        String aPath,
                        FormFields aQueryFields)

Constructs an 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 UrlBuilder instance.

toUrl

public UrlBuilder toUrl(String aProtocol,
                        String aHost,
                        String aPath,
                        FormFields aQueryFields,
                        String aFragment)

Constructs an 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 UrlBuilder instance.