Package com.atlassian.bitbucket.scm

Interface ScmUrlFormatter

public interface ScmUrlFormatter
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.

  • Method Summary

    Modifier and Type
    Method
    Description
    URI
    format(ScmUrlRequest request)
     

  • Method Details

    • format

      @Nonnull URI format(@Nonnull ScmUrlRequest request) throws URISyntaxException
      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