Module org.refcodes.web

Package org.refcodes.web

Interface BaseUrlAccessor.BaseUrlMutator

All Known Subinterfaces:

BaseUrlAccessor.BaseUrlProperty

All Known Implementing Classes:

HttpClientContextBuilder

Enclosing interface:

BaseUrlAccessor

public static interface BaseUrlAccessor.BaseUrlMutator

Provides a mutator for a base URL (protocol, host, port, locator) property.

Method Summary

Modifier and Type	Method	Description
default void	setBaseUrl(String aBaseUrl)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given String.
default void	setBaseUrl(String aProtocol, String aHost)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default void	setBaseUrl(String aProtocol, String aHost, int aPort)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default void	setBaseUrl(String aProtocol, String aHost, int aPort, String aPath)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default void	setBaseUrl(String aProtocol, String aHost, String aPath)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
void	setBaseUrl(URL aBaseUrl)	Sets the base URL (protocol, host, port, path) for the base URL (protocol, host, port, path) property.
default void	setBaseUrl(org.refcodes.data.Scheme aScheme, String aHost)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default void	setBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default void	setBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
default void	setBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath)	Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.
void	setBaseUrl(Url aBaseUrl)	Sets the base Url (protocol, host, port, path) for the base URL (protocol, host, port, path) property.

Method Detail

setBaseUrl

void setBaseUrl(Url aBaseUrl)

Sets the base Url (protocol, host, port, path) for the base URL (protocol, host, port, path) property.

Parameters:

aBaseUrl - The base URL (protocol, host, port, path) to be stored by the local address property.

setBaseUrl

void setBaseUrl(URL aBaseUrl)

Sets the base URL (protocol, host, port, path) for the base URL (protocol, host, port, path) property.

Parameters:

aBaseUrl - The base URL (protocol, host, port, path) to be stored by the local address property.

setBaseUrl

default void setBaseUrl(String aBaseUrl)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given String.

Parameters:

aBaseUrl - The String representing the URL.

Throws:

MalformedURLException - in case the String cannot be converted to a valid (accepted) URL.

setBaseUrl

default void setBaseUrl(String aProtocol,
                        String aHost)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Parameters:

aProtocol - The protocol (e.g. HTTP or HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

setBaseUrl

default void setBaseUrl(String aProtocol,
                        String aHost,
                        int aPort)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Parameters:

aProtocol - The protocol (e.g. HTTP or HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPort - The port to be used when connecting to the host.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

setBaseUrl

default void setBaseUrl(org.refcodes.data.Scheme aScheme,
                        String aHost)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Parameters:

aScheme - The Scheme (e.g. Scheme.HTTP or Scheme.HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

setBaseUrl

default void setBaseUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        int aPort)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Parameters:

aScheme - The Scheme (e.g. Scheme.HTTP or Scheme.HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPort - The port to be used when connecting to the host.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

setBaseUrl

default void setBaseUrl(String aProtocol,
                        String aHost,
                        String aPath)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Parameters:

aProtocol - The protocol (e.g. HTTP or HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPath - The path on the host to which the base URL is to point to.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

setBaseUrl

default void setBaseUrl(String aProtocol,
                        String aHost,
                        int aPort,
                        String aPath)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Parameters:

aProtocol - The protocol (e.g. HTTP or HTTPS) to be used for the base URL.

aHost - The host to which the base 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 URL is to point to.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

setBaseUrl

default void setBaseUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        String aPath)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Parameters:

aScheme - The Scheme (e.g. Scheme.HTTP or Scheme.HTTPS) to be used for the base URL.

aHost - The host to which the base URL is to point to.

aPath - The path on the host to which the base URL is to point to.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.

setBaseUrl

default void setBaseUrl(org.refcodes.data.Scheme aScheme,
                        String aHost,
                        int aPort,
                        String aPath)
                 throws MalformedURLException

Same as setBaseUrl(URL) except that a MalformedURLException may occur when creating the URL instance from the given parameters.

Parameters:

aScheme - The Scheme (e.g. Scheme.HTTP or Scheme.HTTPS) to be used for the base URL.

aHost - The host to which the base 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 URL is to point to.

Throws:

MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.