Package org.refcodes.net

Interface Url.UrlBuilder

All Superinterfaces:

org.refcodes.mixin.CredentialsAccessor, org.refcodes.mixin.CredentialsAccessor.CredentialsBuilder<Url.UrlBuilder>, org.refcodes.mixin.CredentialsAccessor.CredentialsMutator, org.refcodes.mixin.CredentialsAccessor.CredentialsProperty, org.refcodes.mixin.Dumpable, FragmentAccessor, FragmentAccessor.FragmentBuilder<Url.UrlBuilder>, FragmentAccessor.FragmentMutator, FragmentAccessor.FragmentProperty, HostAccessor, HostAccessor.HostBuilder<Url.UrlBuilder>, HostAccessor.HostMutator, HostAccessor.HostProperty, org.refcodes.mixin.IdentityAccessor, org.refcodes.mixin.IdentityAccessor.IdentityBuilder<Url.UrlBuilder>, org.refcodes.mixin.IdentityAccessor.IdentityMutator, org.refcodes.mixin.IdentityAccessor.IdentityProperty, IpAddressAccessor, IpAddressAccessor.IpAddressBuilder<Url.UrlBuilder>, IpAddressAccessor.IpAddressMutator, IpAddressAccessor.IpAddressProperty, org.refcodes.mixin.PathAccessor, org.refcodes.mixin.PathAccessor.PathBuilder<Url.UrlBuilder>, org.refcodes.mixin.PathAccessor.PathMutator, org.refcodes.mixin.PathAccessor.PathProperty, org.refcodes.mixin.PortAccessor, org.refcodes.mixin.PortAccessor.PortBuilder<Url.UrlBuilder>, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty, QueryFieldsAccessor, QueryFieldsAccessor.QueryFieldsBuilder<Url.UrlBuilder>, QueryFieldsAccessor.QueryFieldsMutator, QueryFieldsAccessor.QueryFieldsProperty, SchemeAccessor, SchemeAccessor.SchemeBuilder<Url.UrlBuilder>, SchemeAccessor.SchemeMutator, SchemeAccessor.SchemeProperty, org.refcodes.mixin.SecretAccessor, org.refcodes.mixin.SecretAccessor.SecretBuilder<Url.UrlBuilder>, org.refcodes.mixin.SecretAccessor.SecretMutator, org.refcodes.mixin.SecretAccessor.SecretProperty, Url

All Known Implementing Classes:

UrlBuilderImpl

Enclosing interface:

Url

public static interface Url.UrlBuilder
extends Url, SchemeAccessor.SchemeProperty, SchemeAccessor.SchemeBuilder<Url.UrlBuilder>, HostAccessor.HostProperty, HostAccessor.HostBuilder<Url.UrlBuilder>, IpAddressAccessor.IpAddressProperty, IpAddressAccessor.IpAddressBuilder<Url.UrlBuilder>, org.refcodes.mixin.PortAccessor.PortProperty, org.refcodes.mixin.PortAccessor.PortBuilder<Url.UrlBuilder>, org.refcodes.mixin.PathAccessor.PathProperty, org.refcodes.mixin.PathAccessor.PathBuilder<Url.UrlBuilder>, QueryFieldsAccessor.QueryFieldsProperty, QueryFieldsAccessor.QueryFieldsBuilder<Url.UrlBuilder>, FragmentAccessor.FragmentProperty, FragmentAccessor.FragmentBuilder<Url.UrlBuilder>, org.refcodes.mixin.CredentialsAccessor.CredentialsProperty, org.refcodes.mixin.CredentialsAccessor.CredentialsBuilder<Url.UrlBuilder>

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.CredentialsAccessor

org.refcodes.mixin.CredentialsAccessor.CredentialsBuilder<B extends org.refcodes.mixin.CredentialsAccessor.CredentialsBuilder<B>>, org.refcodes.mixin.CredentialsAccessor.CredentialsMutator, org.refcodes.mixin.CredentialsAccessor.CredentialsProperty

Nested classes/interfaces inherited from interface org.refcodes.net.FragmentAccessor

FragmentAccessor.FragmentBuilder<B extends FragmentAccessor.FragmentBuilder<?>>, FragmentAccessor.FragmentMutator, FragmentAccessor.FragmentProperty

Nested classes/interfaces inherited from interface org.refcodes.net.HostAccessor

HostAccessor.HostBuilder<B extends HostAccessor.HostBuilder<?>>, HostAccessor.HostMutator, HostAccessor.HostProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.IdentityAccessor

org.refcodes.mixin.IdentityAccessor.IdentityBuilder<B extends org.refcodes.mixin.IdentityAccessor.IdentityBuilder<B>>, org.refcodes.mixin.IdentityAccessor.IdentityMutator, org.refcodes.mixin.IdentityAccessor.IdentityProperty

Nested classes/interfaces inherited from interface org.refcodes.net.IpAddressAccessor

IpAddressAccessor.IpAddressBuilder<B extends IpAddressAccessor.IpAddressBuilder<B>>, IpAddressAccessor.IpAddressMutator, IpAddressAccessor.IpAddressProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.PathAccessor

org.refcodes.mixin.PathAccessor.PathBuilder<B extends org.refcodes.mixin.PathAccessor.PathBuilder<?>>, org.refcodes.mixin.PathAccessor.PathMutator, org.refcodes.mixin.PathAccessor.PathProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.PortAccessor

org.refcodes.mixin.PortAccessor.PortBuilder<B extends org.refcodes.mixin.PortAccessor.PortBuilder<B>>, org.refcodes.mixin.PortAccessor.PortMutator, org.refcodes.mixin.PortAccessor.PortProperty

Nested classes/interfaces inherited from interface org.refcodes.net.QueryFieldsAccessor

QueryFieldsAccessor.QueryFieldsBuilder<B extends QueryFieldsAccessor.QueryFieldsBuilder<?>>, QueryFieldsAccessor.QueryFieldsMutator, QueryFieldsAccessor.QueryFieldsProperty

Nested classes/interfaces inherited from interface org.refcodes.net.SchemeAccessor

SchemeAccessor.SchemeBuilder<B extends SchemeAccessor.SchemeBuilder<B>>, SchemeAccessor.SchemeMutator, SchemeAccessor.SchemeProperty

Nested classes/interfaces inherited from interface org.refcodes.mixin.SecretAccessor

org.refcodes.mixin.SecretAccessor.SecretBuilder<B extends org.refcodes.mixin.SecretAccessor.SecretBuilder<B>>, org.refcodes.mixin.SecretAccessor.SecretMutator, org.refcodes.mixin.SecretAccessor.SecretProperty

Nested classes/interfaces inherited from interface org.refcodes.net.Url

Url.UrlBuilder

Method Summary

Modifier and Type	Method	Description
default void	fromUrl(String aUrl)	USes the given String to set the Url's state.
default void	fromURL(URL aUrl)
default Url.UrlBuilder	withCidrNotation(String aCidrNotation)	Constructs the IP-Address from the given String and sets it for the IP-Address property.
default Url.UrlBuilder	withFragment(String aFragment)	Sets the fragment to use and returns this builder as of the builder pattern.
default Url.UrlBuilder	withHost(String aHost)	Sets the host to use and returns this builder as of the builder pattern.
default Url.UrlBuilder	withIdentity(String aIdentity)
default Url.UrlBuilder	withIpAddress(int[] aIpAddress)	Sets the IP-Address for the IP-Address property.
default Url.UrlBuilder	withPath(String aPath)
default Url.UrlBuilder	withPort(int aPort)
default Url.UrlBuilder	withProtocol(String aProtocol)	Sets the protocol for the URL scheme.
default Url.UrlBuilder	withQueryFields(FormFields aQueryFields)	Sets the request Query-Fields to use and returns this builder as of the Builder-Pattern.
default Url.UrlBuilder	withScheme(org.refcodes.data.Scheme aScheme)	Sets the UrlScheme for the URL scheme.
default Url.UrlBuilder	withSecret(String aSecret)

Methods inherited from interface org.refcodes.mixin.Dumpable

toDump, toDump

Methods inherited from interface org.refcodes.net.FragmentAccessor

getFragment

Methods inherited from interface org.refcodes.net.FragmentAccessor.FragmentMutator

setFragment

Methods inherited from interface org.refcodes.net.HostAccessor

getHost

Methods inherited from interface org.refcodes.net.HostAccessor.HostMutator

setHost

Methods inherited from interface org.refcodes.mixin.IdentityAccessor

getIdentity

Methods inherited from interface org.refcodes.mixin.IdentityAccessor.IdentityMutator

setIdentity

Methods inherited from interface org.refcodes.net.IpAddressAccessor

getIpAddress, toCidrNotation

Methods inherited from interface org.refcodes.net.IpAddressAccessor.IpAddressMutator

fromCidrNotation, setIpAddress

Methods inherited from interface org.refcodes.mixin.PathAccessor

getPath

Methods inherited from interface org.refcodes.mixin.PathAccessor.PathMutator

setPath

Methods inherited from interface org.refcodes.mixin.PortAccessor

getPort

Methods inherited from interface org.refcodes.mixin.PortAccessor.PortMutator

setPort

Methods inherited from interface org.refcodes.net.QueryFieldsAccessor

getQueryFields

Methods inherited from interface org.refcodes.net.QueryFieldsAccessor.QueryFieldsMutator

setQueryFields

Methods inherited from interface org.refcodes.net.SchemeAccessor

getScheme, toProtocol

Methods inherited from interface org.refcodes.net.SchemeAccessor.SchemeMutator

setProtocol, setScheme

Methods inherited from interface org.refcodes.mixin.SecretAccessor

getSecret

Methods inherited from interface org.refcodes.mixin.SecretAccessor.SecretMutator

setSecret

Methods inherited from interface org.refcodes.net.Url

toHost, toHttpUrl, toLocator, toURL

Method Detail

fromUrl

default void fromUrl(String aUrl)
              throws MalformedURLException

USes the given String to set the Url's state.

Parameters:

aUrl - The URL from which to determine the state.

Throws:

MalformedURLException - in case the provided URL is considered being malformed.

fromURL

default void fromURL(URL aUrl)

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.

withProtocol

default Url.UrlBuilder withProtocol(String aProtocol)

Sets the protocol for the URL scheme.

Specified by:

withProtocol in interface SchemeAccessor.SchemeBuilder<Url.UrlBuilder>

Parameters:

aProtocol - The protocol to be stored by the URL scheme.

Returns:

The builder for applying multiple build operations.

withHost

default Url.UrlBuilder withHost(String aHost)

Sets the host to use and returns this builder as of the builder pattern.

Specified by:

withHost in interface HostAccessor.HostBuilder<Url.UrlBuilder>

Parameters:

aHost - The host to be stored by the host property.

Returns:

This HostAccessor.HostBuilder instance to continue configuration.

withIpAddress

default Url.UrlBuilder withIpAddress(int[] aIpAddress)

Sets the IP-Address for the IP-Address property.

Specified by:

withIpAddress in interface IpAddressAccessor.IpAddressBuilder<Url.UrlBuilder>

Parameters:

aIpAddress - The IP-Address to be stored by the IP-Address property.

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>

withPath

default Url.UrlBuilder withPath(String aPath)

Specified by:

withPath in interface org.refcodes.mixin.PathAccessor.PathBuilder<Url.UrlBuilder>

withQueryFields

default Url.UrlBuilder withQueryFields(FormFields aQueryFields)

Sets the request Query-Fields to use and returns this builder as of the Builder-Pattern.

Specified by:

withQueryFields in interface QueryFieldsAccessor.QueryFieldsBuilder<Url.UrlBuilder>

Parameters:

aQueryFields - The request Query-Fields to be stored by the form fields property.

Returns:

This FormFieldsAccessor.FormFieldsBuilder instance to continue configuration.

withFragment

default Url.UrlBuilder withFragment(String aFragment)

Sets the fragment to use and returns this builder as of the builder pattern.

Specified by:

withFragment in interface FragmentAccessor.FragmentBuilder<Url.UrlBuilder>

Parameters:

aFragment - The fragment to be stored by the fragment property.

Returns:

This FragmentAccessor.FragmentBuilder 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>