Package com.thoughtworks.go.plugin.api.info

Interface PluginDescriptor.About

Enclosing interface:
PluginDescriptor
public static interface PluginDescriptor.About
Plugin author information.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String description()
    Plugin Description.
    java.lang.String name()
    Author name.
    java.lang.String targetGoVersion()
    Target Go version.
    java.util.List<java.lang.String> targetOperatingSystems()
    Operating systems on which this plugin can run.
    PluginDescriptor.Vendor vendor()
    Plugin vendor details.
    java.lang.String version()
    Provides version of the plugin which will be used by plugin authors to provide meaningful version for the plugin.

  • Method Details

    • name

      java.lang.String name()
      Author name.
      Returns:
      a string containing the name.

    • version

      java.lang.String version()
      Provides version of the plugin which will be used by plugin authors to provide meaningful version for the plugin. It will be used for display purpose by Go.
      Returns:
      a string containing the plugin version.

    • targetGoVersion

      java.lang.String targetGoVersion()
      Target Go version.
      Returns:
      a string containing the version of Go for which the plugin is intended.

    • description

      java.lang.String description()
      Plugin Description.
      Returns:
      a string containing the plugin description.

    • vendor

      PluginDescriptor.Vendor vendor()
      Plugin vendor details.
      Returns:
      an object containing the plugin vendor details.

    • targetOperatingSystems

      java.util.List<java.lang.String> targetOperatingSystems()
      Operating systems on which this plugin can run.
      Returns:
      a list of valid operating system name strings.