UrlFormatter (Gerrit Review Plugin API Documentation)

All Known Implementing Classes:

DefaultUrlFormatter
```
public interface UrlFormatter
```
Formats URLs to different parts of the Gerrit API and UI.
By default, these gerrit URLs are formed by adding suffixes to the web URL. The interface centralizes these conventions, and also allows introducing different, custom URL schemes.
Unfortunately, Gerrit operates in modes for which there is no canonical URL. This can be in standalone utilities that have no HTTP server (eg. index upgrade commands), in servers that run SSH only, or in a HTTP/SSH server that is accessed over SSH without canonical web URL configured.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Optional<String>`	`getChangeViewUrl(Project.NameKey project, Change.Id id)` Returns the URL for viewing a change.
`default Optional<String>`	`getDocUrl(String page, String anchor)` Returns a URL pointing to a documentation page, at a given named anchor.
`default Optional<String>`	`getInlineCommentView(Change change, int patchsetId, String filename, short side, int startLine)` Returns the URL for viewing a comment in a file in a given patch set of a change.
`default Optional<String>`	`getPatchFileView(Change change, int patchsetId, String filename)` Returns the URL for viewing a file in a given patch set of a change.
`default Optional<String>`	`getRestUrl(String suffix)` Returns a REST API URL for a given suffix (eg.
`default Optional<String>`	`getSettingsUrl()` Returns a URL pointing to a section of the settings page.
`default Optional<String>`	`getSettingsUrl(String section)` Returns a URL pointing to a section of the settings page, or the settings page if `section` is null.
`Optional<String>`	`getWebUrl()` The canonical base URL where this Gerrit installation can be reached.

Method Detail

getWebUrl
```
Optional<String> getWebUrl()
```
The canonical base URL where this Gerrit installation can be reached.
For the default implementations below to work, it must end in "/".

getChangeViewUrl

default Optional<String> getChangeViewUrl(Project.NameKey project,
                                          Change.Id id)

Returns the URL for viewing a change.

getPatchFileView

default Optional<String> getPatchFileView(Change change,
                                          int patchsetId,
                                          String filename)

Returns the URL for viewing a file in a given patch set of a change.

getInlineCommentView

default Optional<String> getInlineCommentView(Change change,
                                              int patchsetId,
                                              String filename,
                                              short side,
                                              int startLine)

Returns the URL for viewing a comment in a file in a given patch set of a change.

getSettingsUrl
```
default Optional<String> getSettingsUrl()
```
Returns a URL pointing to a section of the settings page.

getSettingsUrl
```
default Optional<String> getSettingsUrl(String section)
```
Returns a URL pointing to a section of the settings page, or the settings page if section is null.

getDocUrl

default Optional<String> getDocUrl(String page,
                                   String anchor)

Returns a URL pointing to a documentation page, at a given named anchor.

getRestUrl
```
default Optional<String> getRestUrl(String suffix)
```
Returns a REST API URL for a given suffix (eg. "accounts/self/details")

Interface UrlFormatter