- 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 forUrl
(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 UrlBuilder
toUrl()
Creates an emptyUrlBuilder
, make sure to set required attributes for a valid URL.UrlBuilder
toUrl(String aUrl)
Constructs anUrlBuilder
from the provided URLString
.UrlBuilder
toUrl(String aProtocol, String aHost)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(String aProtocol, String aHost, int aPort)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(String aProtocol, String aHost, int aPort, String aPath)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(String aProtocol, String aHost, int aPort, String aPath, FormFields aQueryFields)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(String aProtocol, String aHost, int aPort, String aPath, FormFields aQueryFields, String aFragment)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(String aProtocol, String aHost, String aPath)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(String aProtocol, String aHost, String aPath, FormFields aQueryFields)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(String aProtocol, String aHost, String aPath, FormFields aQueryFields, String aFragment)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(URL aURL)
Constructs anUrlBuilder
from the providedURL
instance.UrlBuilder
toUrl(org.refcodes.data.Scheme aScheme, String aHost)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath, FormFields aQueryFields)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath, FormFields aQueryFields, String aFragment)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath, FormFields aQueryFields)
Constructs anUrlBuilder
with the common attributes.UrlBuilder
toUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath, FormFields aQueryFields, String aFragment)
Constructs anUrlBuilder
with the common attributes.
-
-
-
Method Detail
-
toUrl
public UrlBuilder toUrl()
Creates an emptyUrlBuilder
, 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 anUrlBuilder
from the provided URLString
.- Parameters:
aUrl
- The URLString
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 anUrlBuilder
from the providedURL
instance.- Parameters:
aURL
- TheURL
to be used.- Returns:
- The accordingly constructed
UrlBuilder
instance.
-
toUrl
public UrlBuilder toUrl(org.refcodes.data.Scheme aScheme, String aHost)
Constructs anUrlBuilder
with the common attributes.- Parameters:
aScheme
- TheScheme
(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 anUrlBuilder
with the common attributes.- Parameters:
aScheme
- TheScheme
(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 anUrlBuilder
with the common attributes.- Parameters:
aScheme
- TheScheme
(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 anUrlBuilder
with the common attributes.- Parameters:
aScheme
- TheScheme
(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 anUrlBuilder
with the common attributes.- Parameters:
aScheme
- TheScheme
(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 anUrlBuilder
with the common attributes.- Parameters:
aProtocol
- The protocolString
(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 anUrlBuilder
with the common attributes.- Parameters:
aProtocol
- The protocolString
(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 anUrlBuilder
with the common attributes.- Parameters:
aProtocol
- The protocolString
(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 anUrlBuilder
with the common attributes.- Parameters:
aProtocol
- The protocolString
(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 anUrlBuilder
with the common attributes.- Parameters:
aProtocol
- The protocolString
(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 anUrlBuilder
with the common attributes.- Parameters:
aScheme
- TheScheme
(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 anUrlBuilder
with the common attributes.- Parameters:
aScheme
- TheScheme
(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 anUrlBuilder
with the common attributes.- Parameters:
aScheme
- TheScheme
(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 anUrlBuilder
with the common attributes.- Parameters:
aProtocol
- The protocolString
(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 anUrlBuilder
with the common attributes.- Parameters:
aProtocol
- The protocolString
(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 anUrlBuilder
with the common attributes.- Parameters:
aProtocol
- The protocolString
(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.
-
-