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 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​(java.net.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​(java.lang.String aBaseUrl)
                       throws java.net.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:
        java.net.MalformedURLException - in case the String cannot be converted to a valid (accepted) URL.
      • withBaseUrl

        default B withBaseUrl​(java.lang.String aProtocol,
                              java.lang.String aHost)
                       throws java.net.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:
        java.net.MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.
      • withBaseUrl

        default B withBaseUrl​(org.refcodes.data.Scheme aScheme,
                              java.lang.String aHost)
                       throws java.net.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:
        java.net.MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.
      • withBaseUrl

        default B withBaseUrl​(java.lang.String aProtocol,
                              java.lang.String aHost,
                              java.lang.String aPath)
                       throws java.net.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:
        java.net.MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.
      • withBaseUrl

        default B withBaseUrl​(org.refcodes.data.Scheme aScheme,
                              java.lang.String aHost,
                              java.lang.String aPath)
                       throws java.net.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:
        java.net.MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.
      • withBaseUrl

        default B withBaseUrl​(java.lang.String aProtocol,
                              java.lang.String aHost,
                              int aPort)
                       throws java.net.MalformedURLException
        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:
        java.net.MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.
      • withBaseUrl

        default B withBaseUrl​(org.refcodes.data.Scheme aScheme,
                              java.lang.String aHost,
                              int aPort)
                       throws java.net.MalformedURLException
        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:
        java.net.MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.
      • withBaseUrl

        default B withBaseUrl​(java.lang.String aProtocol,
                              java.lang.String aHost,
                              int aPort,
                              java.lang.String aPath)
                       throws java.net.MalformedURLException
        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:
        java.net.MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.
      • withBaseUrl

        default B withBaseUrl​(org.refcodes.data.Scheme aScheme,
                              java.lang.String aHost,
                              int aPort,
                              java.lang.String aPath)
                       throws java.net.MalformedURLException
        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:
        java.net.MalformedURLException - in case the parameters cannot be converted to a valid (accepted) URL.