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
default @Nullable DependencyResolutionDepth	getDependencyResolutionDepth()	The dependency resolution depth.
@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.

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

getArtifactId, getClassifier, getGroupId, getType, getVersion

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

getOptions, getOrder, isSkip

Method Details

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

getDependencyResolutionDepth

@Derived
default @Nullable DependencyResolutionDepth getDependencyResolutionDepth()

The dependency resolution depth.

This cannot be changed for this type of plugin.

Specified by:

getDependencyResolutionDepth in interface MavenArtifact

Returns:

null, always.

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