Interface ParameterDescriptionProviderContext


  • public interface ParameterDescriptionProviderContext
    Provide some context for parameter description rendering, like project, build configuration, template
    Since:
    2022.03
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      SBuildType getBuildType()
      Returns the build configuration if the parameter is rendered in a build configuration context; null if this information is not available
      BuildTypeTemplate getBuildTypeTemplate()
      Returns the build configuration template if the parameter is rendered in the template context; null if this information is not available
      SProject getProject()
      Returns the project if the parameter is rendered in a project context; null if this information is not available
    • Method Detail

      • getProject

        @Nullable
        SProject getProject()
        Returns the project if the parameter is rendered in a project context; null if this information is not available
        Returns:
        see above
      • getBuildType

        @Nullable
        SBuildType getBuildType()
        Returns the build configuration if the parameter is rendered in a build configuration context; null if this information is not available
        Returns:
        see above
      • getBuildTypeTemplate

        @Nullable
        BuildTypeTemplate getBuildTypeTemplate()
        Returns the build configuration template if the parameter is rendered in the template context; null if this information is not available
        Returns:
        see above