Module org.refcodes.web

Package org.refcodes.web

Interface BaseUrlAccessor.BaseUrlBuilder<B extends BaseUrlAccessor.BaseUrlBuilder<B>>

Type Parameters:

B - The builder to return in order to be able to apply multiple build operations.

All Known Subinterfaces:

HttpClientContext.HttpClientContextBuilder

All Known Implementing Classes:

HttpClientContextBuilderImpl

Enclosing interface:

BaseUrlAccessor

public static interface BaseUrlAccessor.BaseUrlBuilder<B extends BaseUrlAccessor.BaseUrlBuilder<B>>

Provides a builder method for a base URL (protocol, host, port, path) property returning the builder for applying multiple build operations.

Method Summary

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

Method Detail

withBaseUrl

B withBaseUrl(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.

Returns:

The builder for applying multiple build operations.

withBaseUrl

B withBaseUrl(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.

Returns:

The builder for applying multiple build operations.

withBaseUrl

default B withBaseUrl(String aBaseUrl)
               throws MalformedURLException

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

Parameters:

aBaseUrl - The String representing the URL.

Returns:

The builder for applying multiple build operations.

Throws:

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

withBaseUrl

default B withBaseUrl(String aProtocol,
                      String aHost)
               throws MalformedURLException

Same as withBaseUrl(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.

Returns:

The builder for applying multiple build operations.

Throws:

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

withBaseUrl

default B withBaseUrl(org.refcodes.data.Scheme aScheme,
                      String aHost)
               throws MalformedURLException

Same as withBaseUrl(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.

Returns:

The builder for applying multiple build operations.

Throws:

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

withBaseUrl

default B withBaseUrl(String aProtocol,
                      String aHost,
                      String aPath)
               throws MalformedURLException

Same as withBaseUrl(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.

Returns:

The builder for applying multiple build operations.

Throws:

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

withBaseUrl

default B withBaseUrl(org.refcodes.data.Scheme aScheme,
                      String aHost,
                      String aPath)
               throws MalformedURLException

Same as withBaseUrl(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.

Returns:

The builder for applying multiple build operations.

Throws:

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

withBaseUrl

default B withBaseUrl(String aProtocol,
                      String aHost,
                      int aPort)
               throws MalformedURLException

Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int).

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.

Returns:

The builder for applying multiple build operations.

Throws:

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

withBaseUrl

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

Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int).

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.

Returns:

The builder for applying multiple build operations.

Throws:

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

withBaseUrl

default B withBaseUrl(String aProtocol,
                      String aHost,
                      int aPort,
                      String aPath)
               throws MalformedURLException

Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(String, String, int, String).

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.

Returns:

The builder for applying multiple build operations.

Throws:

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

withBaseUrl

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

Builder method for BaseUrlAccessor.BaseUrlMutator.setBaseUrl(Scheme, String, int, String).

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.

Returns:

The builder for applying multiple build operations.

Throws:

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