public interface

ScmUrlFormatter

com.atlassian.bitbucket.scm.ScmUrlFormatter

Class Overview

Formats an appropriate URL for a given repository.

URL formatters are associated with specific SCM request handlers, which are associated with specific protocols:

The formatted URL, which used by the associated SCM, should produce a request which the associated request handler will be able to process.

Summary

Public Methods
@Nonnull URI format(ScmUrlRequest request)

Public Methods

@Nonnull public URI format (ScmUrlRequest request)

Parameters
request a request describing the repository and base URL to use when formatting
Returns
  • the formatted URL, which may never be null
Throws
URISyntaxException if URL formatting fails