Package org.refcodes.net

Interface Url.UrlBuilder

    • Method Detail

      • fromURL

        default void fromURL​(URL aUrl)
        USes the given URL to set the Url's state.
        Parameters:
        aUrl - The URL from which to determine the state.

      • withScheme

        default Url.UrlBuilder withScheme​(org.refcodes.data.Scheme aScheme)
        Sets the UrlScheme for the URL scheme.
        Specified by:
        withScheme in interface SchemeAccessor.SchemeBuilder<Url.UrlBuilder>
        Parameters:
        aScheme - The UrlScheme to be stored by the URL scheme.
        Returns:
        The builder for applying multiple build operations.

      • withCidrNotation

        default Url.UrlBuilder withCidrNotation​(String aCidrNotation)
        Constructs the IP-Address from the given String and sets it for the IP-Address property. The String must be provided in CIDR notation as of "https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation".
        Specified by:
        withCidrNotation in interface IpAddressAccessor.IpAddressBuilder<Url.UrlBuilder>
        Parameters:
        aCidrNotation - The IP-Address String in CIDR notation to be converted and stored by the IP-Address property.
        Returns:
        The builder for applying multiple build operations.

      • withPort

        default Url.UrlBuilder withPort​(int aPort)
        Specified by:
        withPort in interface org.refcodes.mixin.PortAccessor.PortBuilder<Url.UrlBuilder>

      • appendToPath

        default void appendToPath​(String aPathElement)
        Appends a path element to the path.
        Parameters:
        aPathElement - The path element to be appended.

      • appendToPath

        default void appendToPath​(String... aPathElements)
        Appends multiple path elements to the path, automatically adding the path separator "/" as required.
        Parameters:
        aPathElements - The path elements to be appended.

      • withAppendToPath

        default Url.UrlBuilder withAppendToPath​(String aPath)
        Appends a path element to the path as of the Builder-Pattern.
        Parameters:
        aPath - The path element to be appended.
        Returns:
        This Url.UrlBuilder instance to continue configuration.

      • withAppendToPath

        default Url.UrlBuilder withAppendToPath​(String... aPathElements)
        Appends multiple path elements to the path, automatically adding the path separator "/" as required as of the Builder-Pattern.
        Parameters:
        aPathElements - The path elements to be appended.
        Returns:
        This Url.UrlBuilder instance to continue configuration.

      • addToQueryFields

        default void addToQueryFields​(String aField,
                              String aValue)
        Adds a value to the list of values associated with the given Query-Field (key).
        Parameters:
        aField - The Query-Field (key) of which's list of values a value is to be added.
        aValue - The value to be added to the list of values associated to the given Query-Field (key).

      • addToQueryFields

        default void addToQueryFields​(String aField,
                              String... aValues)
        Adds values to the list of values associated with the given Query-Field (key).
        Parameters:
        aField - The Query-Field (key) of which's list of values the values are to be added.
        aValues - The values to be added to the list of values associated to the given Query-Field (key).

      • withAddToQueryFields

        default Url.UrlBuilder withAddToQueryFields​(String aField,
                                            String aValue)
        Adds a value to the list of values associated with the given Query-Field (key) and returns this builder as of the Builder-Pattern.
        Parameters:
        aField - The Query-Field (key) of which's list of values a value is to be added.
        aValue - The value to be added to the list of values associated to the given Query-Field (key).
        Returns:
        This Url.UrlBuilder instance to continue configuration.

      • withAddToQueryFields

        default Url.UrlBuilder withAddToQueryFields​(String aField,
                                            String... aValues)
        Adds values to the list of values associated with the given Query-Field (key) and returns this builder as of the Builder-Pattern.
        Parameters:
        aField - The Query-Field (key) of which's list of values the values are to be added.
        aValues - The values to be added to the list of values associated to the given Query-Field (key).
        Returns:
        This Url.UrlBuilder instance to continue configuration.

      • withIdentity

        default Url.UrlBuilder withIdentity​(String aIdentity)
        Specified by:
        withIdentity in interface org.refcodes.mixin.IdentityAccessor.IdentityBuilder<Url.UrlBuilder>

      • withSecret

        default Url.UrlBuilder withSecret​(String aSecret)
        Specified by:
        withSecret in interface org.refcodes.mixin.SecretAccessor.SecretBuilder<Url.UrlBuilder>