Summary: Methods | [Expand All]
public static interface

NavBuilder.Builder

com.atlassian.bitbucket.nav.NavBuilder.Builder<B extends com.atlassian.bitbucket.nav.NavBuilder.Builder>
Known Indirect Subclasses

Class Overview

Base interface for all terminal builders (builders which can produce a url)

Summary

Public Methods
String buildAbsolute()
String buildConfigured()
String buildRelNoContext()
String buildRelative()
Builder<B> withParam(String name, String value)

Public Methods

public String buildAbsolute ()

Returns
  • the full url including scheme, host, port etc and webapp context e.g. http://localhost:7990/bitbucket/rest/of/url all components up to and including the webapp context will be taken from the context HTTP request (if one is present) or otherwise taken the configured base URL of the server.

public String buildConfigured ()

Returns
  • the same as buildAbsolute(), but will ignore any context HTTP request, and always use the server's configured base URL

public String buildRelNoContext ()

Returns
  • the url path without scheme, host, port etc or webapp context e.g. /rest/of/url

public String buildRelative ()

Returns
  • the url path without scheme, host, port etc e.g. /webappcontext/rest/of/url

public Builder<B> withParam (String name, String value)

Returns
  • a builder with the supplied name and value parameters. Overwrites any previous parameter of the same name.