io.spine.tools.gradle.compiler

Class Extension

java.lang.Object

io.spine.tools.gradle.GradleExtension

io.spine.tools.gradle.compiler.Extension

public class Extension
extends io.spine.tools.gradle.GradleExtension

A configuration for the ModelCompilerPlugin.

Field Summary

Fields

Modifier and Type	Field and Description
io.spine.tools.protoc.GeneratedColumns	columns
java.util.List<java.lang.String>	dirsToClean The absolute paths to directories to delete.
java.lang.String	dirToClean The absolute path to directory to delete.
io.spine.tools.protoc.GeneratedFields	fields
CodeGenAnnotations	generateAnnotations
boolean	generateValidatingBuilders
boolean	generateValidation
io.spine.code.gen.Indent	indent The indent for the generated code in the validating builders.
io.spine.tools.protoc.GeneratedInterfaces	interfaces
java.util.List<java.lang.String>	internalClassPatterns
java.util.List<java.lang.String>	internalMethodNames
java.lang.String	mainDescriptorSetPath The absolute path to the main Protobuf descriptor set file.
java.lang.String	mainGenGrpcDir The absolute path to the main gRPC services directory, generated basing on Protobuf definitions.
java.lang.String	mainGenProtoDir The absolute path to the main Java sources directory, generated basing on Protobuf definitions.
java.lang.String	mainProtoSrcDir The absolute path to the main Protobuf source directory.
java.lang.String	mainTargetGenResourcesDir The absolute path to the main target generated resources directory.
io.spine.tools.protoc.GeneratedMethods	methods
io.spine.tools.protoc.GeneratedNestedClasses	nestedClasses
Severity	spineCheckSeverity The severity of the Spine-custom Error Prone checks.
java.lang.String	targetGenColumnsRootDir The absolute path to the main target generated columns root directory.
java.lang.String	targetGenRejectionsRootDir The absolute path to the main target generated rejections root directory.
java.lang.String	targetTestGenColumnsRootDir The absolute path to the test target generated columns root directory.
java.lang.String	targetTestGenRejectionsRootDir The absolute path to the test target generated rejections root directory.
java.lang.String	testDescriptorSetPath The absolute path to the test Protobuf descriptor set file.
java.lang.String	testGenGrpcDir The absolute path to the test gRPC services directory, generated basing on Protobuf definitions.
java.lang.String	testGenProtoDir The absolute path to the test Java sources directory, generated basing on Protobuf definitions.
java.lang.String	testProtoSrcDir The absolute path to the test Protobuf source directory.
java.lang.String	testTargetGenResourcesDir The absolute path to the test target generated resources directory.

Constructor Summary

Constructors

Constructor and Description
Extension()

Method Summary

Modifier and Type	Method and Description
void	columns(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedColumns> action)
void	columns(groovy.lang.Closure<?> closure)
protected io.spine.code.fs.java.DefaultJavaProject	defaultProject(org.gradle.api.Project project)
void	fields(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedFields> action)
void	fields(groovy.lang.Closure<?> closure)
void	generateAnnotations(org.gradle.api.Action<? super CodeGenAnnotations> action)
void	generateAnnotations(groovy.lang.Closure<?> closure)
static CodeGenAnnotations	getCodeGenAnnotations(org.gradle.api.Project project)
static io.spine.tools.protoc.GeneratedColumns	getColumns(org.gradle.api.Project project)
static java.util.List<java.lang.String>	getDirsToClean(org.gradle.api.Project project)
static io.spine.tools.protoc.GeneratedFields	getFields(org.gradle.api.Project project)
static io.spine.code.gen.Indent	getIndent(org.gradle.api.Project project)
static io.spine.tools.protoc.GeneratedInterfaces	getInterfaces(org.gradle.api.Project project)
static com.google.common.collect.ImmutableSet<java.lang.String>	getInternalClassPatterns(org.gradle.api.Project project)
static com.google.common.collect.ImmutableSet<java.lang.String>	getInternalMethodNames(org.gradle.api.Project project)
static java.io.File	getMainDescriptorSet(org.gradle.api.Project project)
static java.lang.String	getMainGenGrpcDir(org.gradle.api.Project project)
static java.lang.String	getMainGenProtoDir(org.gradle.api.Project project)
static java.lang.String	getMainProtoSrcDir(org.gradle.api.Project project)
static java.lang.String	getMainTargetGenResourcesDir(org.gradle.api.Project project)
static io.spine.tools.protoc.GeneratedMethods	getMethods(org.gradle.api.Project project)
static io.spine.tools.protoc.GeneratedNestedClasses	getNestedClasses(org.gradle.api.Project project)
static @Nullable Severity	getSpineCheckSeverity(org.gradle.api.Project project)
static java.lang.String	getTargetGenColumnsRootDir(org.gradle.api.Project project)
static java.lang.String	getTargetGenRejectionsRootDir(org.gradle.api.Project project)
static java.lang.String	getTargetTestGenColumnsRootDir(org.gradle.api.Project project)
static java.lang.String	getTargetTestGenRejectionsRootDir(org.gradle.api.Project project)
static java.io.File	getTestDescriptorSet(org.gradle.api.Project project)
static java.lang.String	getTestGenGrpcDir(org.gradle.api.Project project)
static java.lang.String	getTestGenProtoDir(org.gradle.api.Project project)
static java.lang.String	getTestProtoSrcDir(org.gradle.api.Project project)
static java.lang.String	getTestTargetGenResourcesDir(org.gradle.api.Project project)
void	interfaces(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedInterfaces> action)
void	interfaces(groovy.lang.Closure<?> closure)
void	methods(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedMethods> action)
void	methods(groovy.lang.Closure<?> closure)
void	nestedClasses(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedNestedClasses> action)
void	nestedClasses(groovy.lang.Closure<?> closure)
void	setIndent(int indent)
static boolean	shouldGenerateValidatingBuilders(org.gradle.api.Project project)
static boolean	shouldGenerateValidation(org.gradle.api.Project project)
static java.util.Optional<java.lang.String>	spineDir(org.gradle.api.Project project)

Methods inherited from class io.spine.tools.gradle.GradleExtension

defaultMainDescriptor, defaultTestDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

mainTargetGenResourcesDir

public java.lang.String mainTargetGenResourcesDir

The absolute path to the main target generated resources directory.

mainProtoSrcDir

public java.lang.String mainProtoSrcDir

The absolute path to the main Protobuf source directory.

mainGenProtoDir

public java.lang.String mainGenProtoDir

The absolute path to the main Java sources directory, generated basing on Protobuf definitions.

mainGenGrpcDir

public java.lang.String mainGenGrpcDir

The absolute path to the main gRPC services directory, generated basing on Protobuf definitions.

testTargetGenResourcesDir

public java.lang.String testTargetGenResourcesDir

The absolute path to the test target generated resources directory.

testProtoSrcDir

public java.lang.String testProtoSrcDir

The absolute path to the test Protobuf source directory.

testGenProtoDir

public java.lang.String testGenProtoDir

The absolute path to the test Java sources directory, generated basing on Protobuf definitions.

testGenGrpcDir

public java.lang.String testGenGrpcDir

The absolute path to the test gRPC services directory, generated basing on Protobuf definitions.

mainDescriptorSetPath

public java.lang.String mainDescriptorSetPath

The absolute path to the main Protobuf descriptor set file.

The file must have the .desc extension.

testDescriptorSetPath

public java.lang.String testDescriptorSetPath

The absolute path to the test Protobuf descriptor set file.

The file must have the .desc extension.

targetGenRejectionsRootDir

public java.lang.String targetGenRejectionsRootDir

The absolute path to the main target generated rejections root directory.

targetTestGenRejectionsRootDir

public java.lang.String targetTestGenRejectionsRootDir

The absolute path to the test target generated rejections root directory.

targetGenColumnsRootDir

public java.lang.String targetGenColumnsRootDir

The absolute path to the main target generated columns root directory.

targetTestGenColumnsRootDir

public java.lang.String targetTestGenColumnsRootDir

The absolute path to the test target generated columns root directory.

dirToClean

public java.lang.String dirToClean

The absolute path to directory to delete.

Either this property OR dirsToClean property is used.

indent

public io.spine.code.gen.Indent indent

The indent for the generated code in the validating builders.

dirsToClean

public java.util.List<java.lang.String> dirsToClean

The absolute paths to directories to delete.

Either this property OR dirToClean property is used.

spineCheckSeverity

public Severity spineCheckSeverity

The severity of the Spine-custom Error Prone checks.

If this value is not set, the default severities are used, which are specific for the each check.

May be overridden by the values provided by the ErrorProneChecksExtension.

generateAnnotations

public final CodeGenAnnotations generateAnnotations

interfaces

public final io.spine.tools.protoc.GeneratedInterfaces interfaces

methods

public final io.spine.tools.protoc.GeneratedMethods methods

nestedClasses

public final io.spine.tools.protoc.GeneratedNestedClasses nestedClasses

columns

public final io.spine.tools.protoc.GeneratedColumns columns

fields

public final io.spine.tools.protoc.GeneratedFields fields

generateValidatingBuilders

public boolean generateValidatingBuilders

generateValidation

@Beta
public boolean generateValidation

internalClassPatterns

public java.util.List<java.lang.String> internalClassPatterns

internalMethodNames

public java.util.List<java.lang.String> internalMethodNames

Constructor Detail

Extension

public Extension()

Method Detail

defaultProject

protected io.spine.code.fs.java.DefaultJavaProject defaultProject(org.gradle.api.Project project)

Specified by:

defaultProject in class io.spine.tools.gradle.GradleExtension

getMainProtoSrcDir

public static java.lang.String getMainProtoSrcDir(org.gradle.api.Project project)

getMainTargetGenResourcesDir

public static java.lang.String getMainTargetGenResourcesDir(org.gradle.api.Project project)

getMainGenGrpcDir

public static java.lang.String getMainGenGrpcDir(org.gradle.api.Project project)

getMainGenProtoDir

public static java.lang.String getMainGenProtoDir(org.gradle.api.Project project)

getTestTargetGenResourcesDir

public static java.lang.String getTestTargetGenResourcesDir(org.gradle.api.Project project)

getTestProtoSrcDir

public static java.lang.String getTestProtoSrcDir(org.gradle.api.Project project)

getTestGenGrpcDir

public static java.lang.String getTestGenGrpcDir(org.gradle.api.Project project)

getTestGenProtoDir

public static java.lang.String getTestGenProtoDir(org.gradle.api.Project project)

getMainDescriptorSet

public static java.io.File getMainDescriptorSet(org.gradle.api.Project project)

getTestDescriptorSet

public static java.io.File getTestDescriptorSet(org.gradle.api.Project project)

getTargetGenRejectionsRootDir

public static java.lang.String getTargetGenRejectionsRootDir(org.gradle.api.Project project)

getTargetTestGenRejectionsRootDir

public static java.lang.String getTargetTestGenRejectionsRootDir(org.gradle.api.Project project)

getTargetGenColumnsRootDir

public static java.lang.String getTargetGenColumnsRootDir(org.gradle.api.Project project)

getTargetTestGenColumnsRootDir

public static java.lang.String getTargetTestGenColumnsRootDir(org.gradle.api.Project project)

getIndent

public static io.spine.code.gen.Indent getIndent(org.gradle.api.Project project)

setIndent

public void setIndent(int indent)

getDirsToClean

public static java.util.List<java.lang.String> getDirsToClean(org.gradle.api.Project project)

getSpineCheckSeverity

public static @Nullable Severity getSpineCheckSeverity(org.gradle.api.Project project)

generateAnnotations

public void generateAnnotations(groovy.lang.Closure<?> closure)

generateAnnotations

public void generateAnnotations(org.gradle.api.Action<? super CodeGenAnnotations> action)

interfaces

public void interfaces(groovy.lang.Closure<?> closure)

interfaces

public void interfaces(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedInterfaces> action)

methods

public void methods(groovy.lang.Closure<?> closure)

methods

public void methods(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedMethods> action)

nestedClasses

public void nestedClasses(groovy.lang.Closure<?> closure)

nestedClasses

public void nestedClasses(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedNestedClasses> action)

columns

public void columns(groovy.lang.Closure<?> closure)

columns

public void columns(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedColumns> action)

fields

public void fields(groovy.lang.Closure<?> closure)

fields

public void fields(org.gradle.api.Action<? super io.spine.tools.protoc.GeneratedFields> action)

getCodeGenAnnotations

public static CodeGenAnnotations getCodeGenAnnotations(org.gradle.api.Project project)

getInterfaces

public static io.spine.tools.protoc.GeneratedInterfaces getInterfaces(org.gradle.api.Project project)

getMethods

public static io.spine.tools.protoc.GeneratedMethods getMethods(org.gradle.api.Project project)

getNestedClasses

public static io.spine.tools.protoc.GeneratedNestedClasses getNestedClasses(org.gradle.api.Project project)

getColumns

public static io.spine.tools.protoc.GeneratedColumns getColumns(org.gradle.api.Project project)

getFields

public static io.spine.tools.protoc.GeneratedFields getFields(org.gradle.api.Project project)

shouldGenerateValidatingBuilders

public static boolean shouldGenerateValidatingBuilders(org.gradle.api.Project project)

shouldGenerateValidation

public static boolean shouldGenerateValidation(org.gradle.api.Project project)

getInternalClassPatterns

public static com.google.common.collect.ImmutableSet<java.lang.String> getInternalClassPatterns(org.gradle.api.Project project)

getInternalMethodNames

public static com.google.common.collect.ImmutableSet<java.lang.String> getInternalMethodNames(org.gradle.api.Project project)

spineDir

public static java.util.Optional<java.lang.String> spineDir(org.gradle.api.Project project)