com.thoughtworks.go.plugin.api.info

Interface PluginDescriptor.About

Enclosing interface:

PluginDescriptor

public static interface PluginDescriptor.About

Plugin author information.

Author:

Go Team

Method Summary

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

Method Detail

name

String name()

Author name.

Returns:

a string containing the name.

version

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

String targetGoVersion()

Target Go version.

Returns:

a string containing the version of Go for which the plugin is intended.

description

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

List<String> targetOperatingSystems()

Operating systems on which this plugin can run.

Returns:

a list of valid operating system name strings.