Package net.kyori.indra.gradle

Class IndraPluginPublishingExtensionImpl

    • Constructor Summary

      Constructors 
      Constructor Description
      IndraPluginPublishingExtensionImpl​(org.gradle.api.model.ObjectFactory objects, org.gradle.plugin.devel.GradlePluginDevelopmentExtension publishingExtension, @Nullable com.gradle.publish.PluginBundleExtension pluginBundleExtension)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      @NotNull org.gradle.api.provider.ListProperty<java.lang.String> bundleTags()
      Get tags to be included on the plugin bundle.
      void plugin​(@NotNull java.lang.String id, @NotNull java.lang.String mainClass, @NotNull java.lang.String displayName, @Nullable java.lang.String description, @Nullable java.util.List<java.lang.String> tags)
      Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.
      @NotNull org.gradle.api.provider.Property<java.lang.String> pluginIdBase()
      A property providing the base id that indra-declared plugin ids are relative to.
      @NotNull org.gradle.api.provider.Property<java.lang.String> website()
      Get the website to link to from this plugin's page on the plugin portal.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • IndraPluginPublishingExtensionImpl

        @Inject
public IndraPluginPublishingExtensionImpl​(org.gradle.api.model.ObjectFactory objects,
                                          org.gradle.plugin.devel.GradlePluginDevelopmentExtension publishingExtension,
                                          @Nullable
                                          @Nullable com.gradle.publish.PluginBundleExtension pluginBundleExtension)

    • Method Detail

      • bundleTags

        @NotNull
public @NotNull org.gradle.api.provider.ListProperty<java.lang.String> bundleTags()
        Description copied from interface: IndraPluginPublishingExtension
        Get tags to be included on the plugin bundle.
        Specified by:
        bundleTags in interface IndraPluginPublishingExtension
        Returns:
        a property providing the tags used for the overall bundle on the plugin portal

      • pluginIdBase

        @NotNull
public @NotNull org.gradle.api.provider.Property<java.lang.String> pluginIdBase()
        Description copied from interface: IndraPluginPublishingExtension
        A property providing the base id that indra-declared plugin ids are relative to.
        Specified by:
        pluginIdBase in interface IndraPluginPublishingExtension
        Returns:
        the base for relative plugin ids

      • website

        @NotNull
public @NotNull org.gradle.api.provider.Property<java.lang.String> website()
        Description copied from interface: IndraPluginPublishingExtension
        Get the website to link to from this plugin's page on the plugin portal.
        Specified by:
        website in interface IndraPluginPublishingExtension
        Returns:
        the website property

      • plugin

        public void plugin​(@NotNull
                   @NotNull java.lang.String id,
                   @NotNull
                   @NotNull java.lang.String mainClass,
                   @NotNull
                   @NotNull java.lang.String displayName,
                   @Nullable
                   @Nullable java.lang.String description,
                   @Nullable
                   @Nullable java.util.List<java.lang.String> tags)
        Description copied from interface: IndraPluginPublishingExtension
        Register a plugin to have marker validated, and to be deployed to the Gradle Plugin Portal.

        The id is relative to IndraPluginPublishingExtension.pluginIdBase(), which is by default the project's group id. Main class is absolute.

        If no tags are set on the global plugin bundle, then the first provided set of tags will be applied.

        Specified by:
        plugin in interface IndraPluginPublishingExtension
        Parameters:
        id - the relative plugin id
        mainClass - the fully qualified name of the plugin class
        displayName - the display name for the plugin on the Gradle Plugin Portal
        description - the plugin description
        tags - tags used for the plugin on the plugin portal