Package com.atlassian.bitbucket.nav

Interface NavBuilder.Builder<B extends NavBuilder.Builder<B>>

All Known Subinterfaces:
NavBuilder.AddonMarketplace, NavBuilder.AddonRequests, NavBuilder.Addons, NavBuilder.Admin, NavBuilder.BrowseRepoResource, NavBuilder.Commit, NavBuilder.CommitComment, NavBuilder.Compare, NavBuilder.Compare.CommitsBuilder, NavBuilder.Compare.DiffBuilder, NavBuilder.CompareBuilder<T>, NavBuilder.CreateProject, NavBuilder.CreatePullRequest, NavBuilder.CreateRepo, NavBuilder.Dashboard, NavBuilder.Database, NavBuilder.DeleteGroup, NavBuilder.DeleteUser, NavBuilder.GettingStarted, NavBuilder.GitAdmin, NavBuilder.GlobalListRepos, NavBuilder.Groups, NavBuilder.JiraCloudIntegration, NavBuilder.KeysAndTokens, NavBuilder.Licensing, NavBuilder.ListBranches, NavBuilder.ListCommits, NavBuilder.ListForks, NavBuilder.ListProjects, NavBuilder.ListPullRequests, NavBuilder.ListRepos, NavBuilder.ListTags, NavBuilder.Login, NavBuilder.Mesh, NavBuilder.NavigationStep<B>, NavBuilder.PagedBuilder<B>, NavBuilder.PathBuilder<B>, NavBuilder.PluginServlets, NavBuilder.Profile, NavBuilder.Project, NavBuilder.ProjectAutoDeclineSettings, NavBuilder.ProjectAutoMergeSettings, NavBuilder.ProjectDefaultTasksSettings, NavBuilder.ProjectDelete, NavBuilder.ProjectHooks, NavBuilder.ProjectMergeChecks, NavBuilder.ProjectMergeStrategySettings, NavBuilder.ProjectPermissions, NavBuilder.ProjectPullRequestTemplateSettings, NavBuilder.ProjectReviewerGroupSettings, NavBuilder.ProjectSecretScanning, NavBuilder.ProjectSettings, NavBuilder.PullRequest, NavBuilder.PullRequestActivity, NavBuilder.PullRequestBuilds, NavBuilder.PullRequestComment, NavBuilder.PullRequestCommit, NavBuilder.PullRequestOverview, NavBuilder.PullRequestRepoSettings, NavBuilder.Repo, NavBuilder.RepoArchive, NavBuilder.RepoAttachment, NavBuilder.RepoAttachmentMetadata, NavBuilder.RepoAutoDeclineSettings, NavBuilder.RepoAutoMergeSettings, NavBuilder.RepoBuilds, NavBuilder.RepoDefaultTasksSettings, NavBuilder.RepoDelete, NavBuilder.RepoFork, NavBuilder.RepoHooks, NavBuilder.RepoMergeChecks, NavBuilder.RepoMergeStrategySettings, NavBuilder.RepoPermissions, NavBuilder.RepoPullRequestTemplateSettings, NavBuilder.RepoPushLog, NavBuilder.RepoRequiredBuildsSettings, NavBuilder.RepoReviewerGroupsSettings, NavBuilder.RepoSecretScanning, NavBuilder.RepoSettings, NavBuilder.Rest, NavBuilder.RestAdmin, NavBuilder.RestHook, NavBuilder.RestHooks, NavBuilder.RestUser, NavBuilder.RestUsers, NavBuilder.RevisionBrowse, NavBuilder.RevisionBuilds, NavBuilder.Tmp, NavBuilder.UserAccount, NavBuilder.Users, NavBuilder.ViewGroup, NavBuilder.ViewUser
Enclosing interface:
NavBuilder
public static interface NavBuilder.Builder<B extends NavBuilder.Builder<B>>
Base interface for all terminal builders (builders which can produce a url)

  • Method Details

    • withParam

      B withParam(@Nonnull String name, String value)
      Parameters:
      name - the name of the parameter
      value - the value of the parameter
      Returns:
      a builder with the supplied name and value parameters. Overwrites any previous parameter of the same name.

    • buildRelative

      String buildRelative()
      Returns:
      the url path without scheme, host, port etc e.g. /webappcontext/rest/of/url

    • buildRelNoContext

      String buildRelNoContext()
      Returns:
      the url path without scheme, host, port etc or webapp context e.g. /rest/of/url

    • buildAbsolute

      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.

    • buildConfigured

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