Interface ProjectDocumentationUrlProvider

  • All Known Subinterfaces:
    NameBasedProjectDocumentationUrlProvider

    public interface ProjectDocumentationUrlProvider
    A provider that, given a project name will compute the eventual published URL, relative to a separately provided base URL.

    Implementations may annotate java bean-style getters with task input annotations for accurate up-to-date checks on projects.

    Since:
    2.1.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @NotNull java.lang.String createUrl​(@NotNull java.lang.String projectName, @NotNull java.lang.String projectPath)
      Create the relative, public-facing URL for the Javadoc for a certain project.
    • Method Detail

      • createUrl

        @NotNull
        @NotNull java.lang.String createUrl​(@NotNull
                                            @NotNull java.lang.String projectName,
                                            @NotNull
                                            @NotNull java.lang.String projectPath)
        Create the relative, public-facing URL for the Javadoc for a certain project.
        Parameters:
        projectName - plain name of the project (see Project.getName()
        projectPath - full, colon-separated path to this project (see Project.getPath())
        Returns:
        the relative, public-facing URL for the Javadoc for a certain project
        Since:
        2.1.0