Interface MavenProtocPlugin

All Superinterfaces:

MavenArtifact, ProtocPlugin

All Known Implementing Classes:

ImmutableMavenProtocPlugin, MavenProtocPluginBean

@Immutable
@Modifiable
public interface MavenProtocPlugin
extends MavenArtifact, ProtocPlugin

Implementation independent descriptor for a protoc plugin that can be resolved from a Maven repository.

Since:

2.0.0

Author:

Ashley Scopes

Method Summary

Modifier and Type	Method	Description
@Nullable List<String>	getJvmArgs()	Get the command line arguments to pass to the JVM.
@Nullable List<String>	getJvmConfigArgs()	Get the arguments to pass to the JVM to configure it.
@Nullable String	getMainClass()	The main class entrypoint to use if the plugin is not an assembled JAR.
@NonNull String	getVersion()	Get the version of the protoc plugin.

Methods inherited from interface io.github.ascopes.protobufmavenplugin.dependencies.MavenArtifact

getArtifactId, getClassifier, getGroupId, getType

Methods inherited from interface io.github.ascopes.protobufmavenplugin.plugins.ProtocPlugin

getOptions, getOrder, getOutputDirectory, isRegisterAsCompilationRoot, isSkip

Method Details

getVersion

@NonNull String getVersion()

Get the version of the protoc plugin.

This must be specified for plugins. The use of <dependencyManagement/> is ignored here.

Specified by:

getVersion in interface MavenArtifact

Returns:

the protoc plugin version to use.

getJvmArgs

@Nullable List<String> getJvmArgs()

Get the command line arguments to pass to the JVM.

This defaults to an empty list.

Returns:

the list of command line arguments to pass to the JVM.

Since:

2.6.0

getJvmConfigArgs

@Nullable List<String> getJvmConfigArgs()

Get the arguments to pass to the JVM to configure it.

Users can use this to control concerns such as heap memory controls, GC and JIT settings, and specifying additional JVM options.

Returns:

the list of command line arguments to pass to the JVM.

Since:

2.6.0

getMainClass

@Nullable String getMainClass()

The main class entrypoint to use if the plugin is not an assembled JAR.

Ignored in all other cases.

Returns:

the main class name.

Since:

2.5.0