Class: Builder

bitbucket/util/navbuilder. Builder

new Builder()

A Builder of URLs. All methods in the Builder API will return a subclass of this and will include these methods.

NOTE: The Builder constructor is not exposed. A new Builder can be created through
bitbucket/util/navbuilder.newBuilder.

Source:

Methods

addPathComponents(component) → {bitbucket/util/navbuilder.Builder}

Return a new builder with more path components appended to the URL.

Parameters:
Name Type Argument Description
component string <repeatable>

A path component to append.
Source:
Returns:
Type
bitbucket/util/navbuilder.Builder

build() → {string}

Source:
Returns:

relative URL. See bitbucket/util/navbuilder.PathAndQuery.buildRelative

Type
string

buildAbsolute() → {string}

Source:
Returns:

absolute URL. See bitbucket/util/navbuilder.PathAndQuery.buildAbsolute

Type
string

buildNoContext() → {string}

Source:
Returns:

relative URL with not application context. Useful when calling libraries that add
the context automatically. See bitbucket/util/navbuilder.PathAndQuery.buildRelNoContext

Type
string

parse() → {bitbucket/util/navbuilder.Uri}

Source:
Returns:

URI object formed by the builder.

Type
bitbucket/util/navbuilder.Uri

withFragment(anchor) → {bitbucket/util/navbuilder.Builder}

Sets the hash (#) portion of the output URL for this builder.

Parameters:
Name Type Description
anchor string

The hash portion of the URL.
Source:
Returns:
Type
bitbucket/util/navbuilder.Builder

withParams(params) → {bitbucket/util/navbuilder.Builder}

Sets query string parameters for the output URL of this builder.

Parameters:
Name Type Description
params Object

A map of parameter name to value. Previous params with the same names will be overwritten.
Source:
Returns:
Type
bitbucket/util/navbuilder.Builder