-
- All Superinterfaces:
BaseUrlAccessor
,BaseUrlAccessor.BaseUrlMutator
- All Known Implementing Classes:
HttpClientContextBuilder
- Enclosing interface:
- BaseUrlAccessor
public static interface BaseUrlAccessor.BaseUrlProperty extends BaseUrlAccessor, BaseUrlAccessor.BaseUrlMutator
Provides a base URL (protocol, host, port, path) property.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.refcodes.web.BaseUrlAccessor
BaseUrlAccessor.BaseUrlBuilder<B extends BaseUrlAccessor.BaseUrlBuilder<B>>, BaseUrlAccessor.BaseUrlMutator, BaseUrlAccessor.BaseUrlProperty
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default String
letBaseUrl(String aBaseUrl)
This method stores and passes through the given argument, which is very useful for builder APIs.default Url
letBaseUrl(String aProtocol, String aHost)
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.default Url
letBaseUrl(String aProtocol, String aHost, int aPort)
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.default Url
letBaseUrl(String aProtocol, String aHost, int aPort, String aPath)
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.default Url
letBaseUrl(String aProtocol, String aHost, String aPath)
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.default URL
letBaseUrl(URL aBaseUrl)
This method stores and passes through the given arguments, which is very useful for builder APIs.default Url
letBaseUrl(org.refcodes.data.Scheme aScheme, String aHost)
This method stores and passes through (being produced to anUrl
) the given arguments, which is very useful for builder APIs.default Url
letBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort)
This method stores and passes through (being produced to anUrl
) the given arguments, which is very useful for builder APIs.default Url
letBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath)
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.default Url
letBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath)
This method stores and passes through (being produced to anUrl
) the given arguments, which is very useful for builder APIs.default Url
letBaseUrl(Url aBaseUrl)
This method stores and passes through the given argument, which is very useful for builder APIs.-
Methods inherited from interface org.refcodes.web.BaseUrlAccessor
getBaseUrl
-
Methods inherited from interface org.refcodes.web.BaseUrlAccessor.BaseUrlMutator
setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl, setBaseUrl
-
-
-
-
Method Detail
-
letBaseUrl
default Url letBaseUrl(org.refcodes.data.Scheme aScheme, String aHost) throws MalformedURLException
This method stores and passes through (being produced to anUrl
) the given arguments, which is very useful for builder APIs.- Parameters:
aScheme
- TheScheme
(e.g.Scheme.HTTP
orScheme.HTTPS
) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.- Returns:
- The produced value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot beMalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default Url letBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort) throws MalformedURLException
This method stores and passes through (being produced to anUrl
) the given arguments, which is very useful for builder APIs.- Parameters:
aScheme
- TheScheme
(e.g.Scheme.HTTP
orScheme.HTTPS
) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPort
- The port to be used when connecting to the host.- Returns:
- The produced value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default String letBaseUrl(String aBaseUrl) throws MalformedURLException
This method stores and passes through the given argument, which is very useful for builder APIs.- Parameters:
aBaseUrl
- TheString
representing theURL
.- Returns:
- The value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default Url letBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, String aPath) throws MalformedURLException
This method stores and passes through (being produced to anUrl
) the given arguments, which is very useful for builder APIs.- Parameters:
aScheme
- TheScheme
(e.g.Scheme.HTTP
orScheme.HTTPS
) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPath
- The path on the host to which the baseURL
is to point to.- Returns:
- The produced value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default Url letBaseUrl(Url aBaseUrl) throws MalformedURLException
This method stores and passes through the given argument, which is very useful for builder APIs.- Parameters:
aBaseUrl
- The base URL (protocol, host, port, path) to be stored by the local address property.- Returns:
- The value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default URL letBaseUrl(URL aBaseUrl) throws MalformedURLException
This method stores and passes through the given arguments, which is very useful for builder APIs.- Parameters:
aBaseUrl
- The base URL (protocol, host, port, path) to be stored by the local address property.- Returns:
- The passed value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default Url letBaseUrl(String aProtocol, String aHost) throws MalformedURLException
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.- Parameters:
aProtocol
- The protocol (e.g. HTTP or HTTPS) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.- Returns:
- The produced value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default Url letBaseUrl(String aProtocol, String aHost, int aPort) throws MalformedURLException
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.- Parameters:
aProtocol
- The protocol (e.g. HTTP or HTTPS) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPort
- The port to be used when connecting to the host.- Returns:
- The produced value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default Url letBaseUrl(String aProtocol, String aHost, String aPath) throws MalformedURLException
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.- Parameters:
aProtocol
- The protocol (e.g. HTTP or HTTPS) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPath
- The path on the host to which the baseURL
is to point to.- Returns:
- The produced value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default Url letBaseUrl(String aProtocol, String aHost, int aPort, String aPath) throws MalformedURLException
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.- Parameters:
aProtocol
- The protocol (e.g. HTTP or HTTPS) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPort
- The port to be used when connecting to the host.aPath
- The path on the host to which the baseURL
is to point to.- Returns:
- The produced value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
letBaseUrl
default Url letBaseUrl(org.refcodes.data.Scheme aScheme, String aHost, int aPort, String aPath) throws MalformedURLException
This method stores and passes through (being produced to anURL
) the given arguments, which is very useful for builder APIs.- Parameters:
aScheme
- TheScheme
(e.g.Scheme.HTTP
orScheme.HTTPS
) to be used for the baseURL
.aHost
- The host to which the baseURL
is to point to.aPort
- The port to be used when connecting to the host.aPath
- The path on the host to which the baseURL
is to point to.- Returns:
- The produced value to be used in conclusive processing steps.
- Throws:
MalformedURLException
- in case the parameters cannot be converted to a valid (accepted)URL
.
-
-