Skip navigation links
A B C D E F G H I J L M N O P R S T U V 

A

accept(AbstractJavaSource<JavaClassSource>) - Method in class io.spine.tools.compiler.annotation.Annotator.TypeDeclarationAnnotation
 
AccessorTemplate - Class in io.spine.tools.compiler.field
A template of an accessor method generated by the Protobuf compiler for a Protobuf field in Java.
AccessorTemplates - Class in io.spine.tools.compiler.field
A factory of commonly used AccessorTemplate instances.
add(ModuleAnnotator.Job) - Method in class io.spine.tools.compiler.annotation.ModuleAnnotator.Builder
Adds a ModuleAnnotator.Job to execute.
addAnnotation(AnnotationTargetSource<?, ?>) - Method in class io.spine.tools.compiler.annotation.Annotator
Adds a fully qualified Annotator.annotation to the AnnotationTargetSource.
addConfigureSeverityAction() - Method in class io.spine.tools.compiler.check.SeverityConfigurer
Adds the action configuring Spine Error Prone check severities to the projectEvaluated stage of the project.
adder() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains add... template.
addErrorProneChecksDependency() - Method in class io.spine.tools.compiler.check.DependencyConfigurer
Adds the io.spine.tools.spine-errorprone-checks dependency to the project configuration.
allAdder() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains addAll... template.
allPutter() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains putAll... template.
annotate() - Method in class io.spine.tools.compiler.annotation.Annotator
Annotates the Java sources generated from Protobuf.
annotate(SourceFile) - Method in class io.spine.tools.compiler.annotation.Annotator
Rewrites the file applying Annotator.TypeDeclarationAnnotation.
annotate() - Method in class io.spine.tools.compiler.annotation.ModuleAnnotator
Executes the annotation jobs.
annotate(Descriptors.FileDescriptor) - Method in class io.spine.tools.compiler.annotation.OptionAnnotator
Annotates the Java sources generated from the specified file descriptor.
annotateMessageTypes(Descriptors.Descriptor, Descriptors.FileDescriptor) - Method in class io.spine.tools.compiler.annotation.OptionAnnotator
Annotates message class and MessageOrBuilder interface that correspond to the passed type.
annotateMultipleFiles(Descriptors.FileDescriptor) - Method in class io.spine.tools.compiler.annotation.OptionAnnotator
Annotates the Java sources generated from the specified file descriptor if java_multiple_files proto file option is true.
annotateOneFile(Descriptors.FileDescriptor) - Method in class io.spine.tools.compiler.annotation.OptionAnnotator
Annotates the Java sources generated from the specified file descriptor if java_multiple_files proto file option is set to false.
Annotator - Class in io.spine.tools.compiler.annotation
Abstract base class for the annotators of the generated Java sources.
Annotator(ClassName, ImmutableList<Descriptors.FileDescriptor>, Path) - Constructor for class io.spine.tools.compiler.annotation.Annotator
 
Annotator.TypeDeclarationAnnotation - Class in io.spine.tools.compiler.annotation
An annotation function, that annotates the type declaration, which is represented by AbstractJavaSource.
AnnotatorFactory - Interface in io.spine.tools.compiler.annotation
A factory for Annotators.
ApiOption - Class in io.spine.tools.compiler.annotation
A set of Protobuf options marking an API element.
apply(Project) - Method in class io.spine.tools.gradle.compiler.CleaningPlugin
 
apply(Project) - Method in class io.spine.tools.gradle.compiler.ColumnGenPlugin
Applies the plug-in to a project.
apply(Project) - Method in class io.spine.tools.gradle.compiler.DescriptorSetMergerPlugin
 
apply(Project) - Method in class io.spine.tools.gradle.compiler.ErrorProneChecksPlugin
Applies the plugin to the given Project.
apply(Project) - Method in class io.spine.tools.gradle.compiler.ModelCompilerPlugin
 
apply(Project) - Method in class io.spine.tools.gradle.compiler.ProtoAnnotatorPlugin
 
apply(Project) - Method in class io.spine.tools.gradle.compiler.RejectionGenPlugin
Applies the plug-in to a project.
as(ClassName) - Method in class io.spine.tools.compiler.annotation.ModuleAnnotator.JobBuilder
Builds an instance of Job.

B

beta() - Static method in class io.spine.tools.compiler.annotation.ApiOption
Obtains an option which marks beta API.
beta - Variable in class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
betaClassName() - Method in class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
build() - Method in class io.spine.tools.compiler.annotation.ModuleAnnotator.Builder
Creates a new instance of ModuleAnnotator.

C

ClassNamePattern - Class in io.spine.tools.compiler.annotation
A pattern matching qualified names of Java classes.
CleaningPlugin - Class in io.spine.tools.gradle.compiler
Plugin which performs additional cleanup of the Spine-generated folders.
CleaningPlugin() - Constructor for class io.spine.tools.gradle.compiler.CleaningPlugin
 
clearer() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains clear... template.
CodeGenAnnotations - Class in io.spine.tools.gradle.compiler
Type names of Java annotations used to mark generated code.
CodeGenAnnotations() - Constructor for class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
ColumnGenPlugin - Class in io.spine.tools.gradle.compiler
A plugin that generates helper interfaces for declaring entity columns.
ColumnGenPlugin() - Constructor for class io.spine.tools.gradle.compiler.ColumnGenPlugin
 
columns - Variable in class io.spine.tools.gradle.compiler.Extension
 
columns(Closure<?>) - Method in class io.spine.tools.gradle.compiler.Extension
 
columns(Action<? super GeneratedColumns>) - Method in class io.spine.tools.gradle.compiler.Extension
 
configureProtocPlugins(NamedDomainObjectContainer<ExecutableLocator>, Project) - Method in class io.spine.tools.gradle.compiler.JavaProtocConfigurationPlugin
 
countGetter() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains get...Count template.
createFieldAnnotator(ClassName, ApiOption) - Method in interface io.spine.tools.compiler.annotation.AnnotatorFactory
 
createFieldAnnotator(ClassName, ApiOption) - Method in class io.spine.tools.compiler.annotation.DefaultAnnotatorFactory
 
createFileAnnotator(ClassName, ApiOption) - Method in interface io.spine.tools.compiler.annotation.AnnotatorFactory
 
createFileAnnotator(ClassName, ApiOption) - Method in class io.spine.tools.compiler.annotation.DefaultAnnotatorFactory
 
createFor(Configuration) - Static method in class io.spine.tools.compiler.check.DependencyConfigurer
Create the DependencyConfigurer for the given project Configuration.
createMessageAnnotator(ClassName, ApiOption) - Method in interface io.spine.tools.compiler.annotation.AnnotatorFactory
 
createMessageAnnotator(ClassName, ApiOption) - Method in class io.spine.tools.compiler.annotation.DefaultAnnotatorFactory
 
createMethodAnnotator(ClassName, ImmutableSet<MethodPattern>) - Method in interface io.spine.tools.compiler.annotation.AnnotatorFactory
 
createMethodAnnotator(ClassName, ImmutableSet<MethodPattern>) - Method in class io.spine.tools.compiler.annotation.DefaultAnnotatorFactory
 
createPatternAnnotator(ClassName, ClassNamePattern) - Method in interface io.spine.tools.compiler.annotation.AnnotatorFactory
 
createPatternAnnotator(ClassName, ClassNamePattern) - Method in class io.spine.tools.compiler.annotation.DefaultAnnotatorFactory
 
createServiceAnnotator(ClassName, ApiOption) - Method in interface io.spine.tools.compiler.annotation.AnnotatorFactory
 
createServiceAnnotator(ClassName, ApiOption) - Method in class io.spine.tools.compiler.annotation.DefaultAnnotatorFactory
 
customizeTask(GenerateProtoTask) - Method in class io.spine.tools.gradle.compiler.JavaProtocConfigurationPlugin
 

D

DefaultAnnotatorFactory - Class in io.spine.tools.compiler.annotation
The default implementation of the AnnotatorFactory.
defaultProject(Project) - Method in class io.spine.tools.gradle.compiler.Extension
 
deleteDirs(List<String>) - Static method in class io.spine.tools.compiler.DirectoryCleaner
Deletes directories with the passed names.
DependencyConfigurer - Class in io.spine.tools.compiler.check
Adds a spine-errorprone-checks dependency to the given project Configuration.
descriptors() - Method in class io.spine.tools.compiler.annotation.Annotator
Obtains the list of file descriptors from which the annotated Java code is generated.
DescriptorSetMergerPlugin - Class in io.spine.tools.gradle.compiler
A Gradle plugin which merges the descriptor file with all the descriptor files from the project runtime classpath.
DescriptorSetMergerPlugin() - Constructor for class io.spine.tools.gradle.compiler.DescriptorSetMergerPlugin
 
DirectoryCleaner - Class in io.spine.tools.compiler
Custom FileVisitor which recursively deletes the contents of the walked folder.
dirsToClean - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute paths to directories to delete.
dirToClean - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to directory to delete.

E

EntityWithColumnsSpec - Class in io.spine.tools.compiler.gen.column
A type spec of the interface which declares entity columns.
EntityWithColumnsSpec(MessageType) - Constructor for class io.spine.tools.compiler.gen.column.EntityWithColumnsSpec
 
equals(Object) - Method in class io.spine.tools.compiler.annotation.ClassNamePattern
equals(Object) - Method in class io.spine.tools.compiler.annotation.MethodPattern
 
equals(Object) - Method in class io.spine.tools.compiler.field.AccessorTemplate
 
ErrorProneChecksExtension - Class in io.spine.tools.gradle.compiler
The Error Prone Checks plugin extension.
ErrorProneChecksExtension() - Constructor for class io.spine.tools.gradle.compiler.ErrorProneChecksExtension
 
ErrorProneChecksPlugin - Class in io.spine.tools.gradle.compiler
A Gradle plugin which configures the project to run Spine-custom Error Prone checks during the compilation stage.
ErrorProneChecksPlugin() - Constructor for class io.spine.tools.gradle.compiler.ErrorProneChecksPlugin
 
execute(AnnotatorFactory) - Method in interface io.spine.tools.compiler.annotation.ModuleAnnotator.Job
Executes this job.
experimental() - Static method in class io.spine.tools.compiler.annotation.ApiOption
Obtains an option which marks experimental API.
experimental - Variable in class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
experimentalClassName() - Method in class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
Extension - Class in io.spine.tools.gradle.compiler
A configuration for the ModelCompilerPlugin.
Extension() - Constructor for class io.spine.tools.gradle.compiler.Extension
 
extensionName() - Static method in class io.spine.tools.gradle.compiler.ErrorProneChecksPlugin
 
extensionName() - Static method in class io.spine.tools.gradle.compiler.ModelCompilerPlugin
Obtains the extension name of the plugin.

F

fields - Variable in class io.spine.tools.gradle.compiler.Extension
 
fields(Closure<?>) - Method in class io.spine.tools.gradle.compiler.Extension
 
fields(Action<? super GeneratedFields>) - Method in class io.spine.tools.gradle.compiler.Extension
 
FieldType - Interface in io.spine.tools.compiler.field.type
The type information of a field for a code-generation.
forField(FieldName, FieldType) - Static method in class io.spine.tools.compiler.field.GeneratedAccessors
Creates an instance of GeneratedAccessors for the given field.
format(FieldName) - Method in class io.spine.tools.compiler.field.AccessorTemplate
Formats an accessor method name based on this template and the given field name.

G

generateAnnotations - Variable in class io.spine.tools.gradle.compiler.Extension
 
generateAnnotations(Closure<?>) - Method in class io.spine.tools.gradle.compiler.Extension
 
generateAnnotations(Action<? super CodeGenAnnotations>) - Method in class io.spine.tools.gradle.compiler.Extension
 
GeneratedAccessors - Class in io.spine.tools.compiler.field
Property accessor methods generated by the Protobuf compiler.
generatedAccessorTemplates() - Method in interface io.spine.tools.compiler.field.type.FieldType
Obtains the templates of the generated Java accessors for a field of this type.
generatedAccessorTemplates() - Method in class io.spine.tools.compiler.field.type.MapFieldType
 
generatedAccessorTemplates() - Method in class io.spine.tools.compiler.field.type.RepeatedFieldType
 
generatedAccessorTemplates() - Method in class io.spine.tools.compiler.field.type.SingularFieldType
 
generatedFilesBaseDir(Project) - Method in class io.spine.tools.gradle.compiler.JavaProtocConfigurationPlugin
 
generateValidatingBuilders - Variable in class io.spine.tools.gradle.compiler.Extension
 
generateValidation - Variable in class io.spine.tools.gradle.compiler.Extension
 
getCodeGenAnnotations(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getColumns(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getDirsToClean(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getFields(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getIndent(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getInterfaces(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getInternalClassPatterns(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getInternalMethodNames(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getMainDescriptorSet(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getMainDescriptorSet(Project) - Method in class io.spine.tools.gradle.compiler.JavaProtocConfigurationPlugin
 
getMainGenGrpcDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getMainGenProtoDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getMainProtoSrcDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getMainTargetGenResourcesDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getMethods(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getNestedClasses(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getSpineCheckSeverity(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTargetGenColumnsRootDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTargetGenRejectionsRootDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTargetTestGenColumnsRootDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTargetTestGenRejectionsRootDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getter() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains get... template.
getTestDescriptorSet(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTestDescriptorSet(Project) - Method in class io.spine.tools.gradle.compiler.JavaProtocConfigurationPlugin
 
getTestGenGrpcDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTestGenProtoDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTestProtoSrcDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTestTargetGenResourcesDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
getTypeName() - Method in interface io.spine.tools.compiler.field.type.FieldType
Obtains the TypeName for the field.
getTypeName() - Method in class io.spine.tools.compiler.field.type.MapFieldType
 
getTypeName() - Method in class io.spine.tools.compiler.field.type.RepeatedFieldType
 
getTypeName() - Method in class io.spine.tools.compiler.field.type.SingularFieldType
 
getUseValidatingBuilder(Project) - Static method in class io.spine.tools.gradle.compiler.ErrorProneChecksExtension
 

H

hashCode() - Method in class io.spine.tools.compiler.annotation.ClassNamePattern
 
hashCode() - Method in class io.spine.tools.compiler.annotation.MethodPattern
 
hashCode() - Method in class io.spine.tools.compiler.field.AccessorTemplate
 

I

indent - Variable in class io.spine.tools.gradle.compiler.Extension
The indent for the generated code in the validating builders.
initFor(Project) - Static method in class io.spine.tools.compiler.check.PreprocessorConfigurer
Create the PreprocessorConfigurer instance for the given project.
initFor(Project) - Static method in class io.spine.tools.compiler.check.SeverityConfigurer
Create the SeverityConfigurer instance for the given project.
interfaces - Variable in class io.spine.tools.gradle.compiler.Extension
 
interfaces(Closure<?>) - Method in class io.spine.tools.gradle.compiler.Extension
 
interfaces(Action<? super GeneratedInterfaces>) - Method in class io.spine.tools.gradle.compiler.Extension
 
internal() - Static method in class io.spine.tools.compiler.annotation.ApiOption
Obtains an option which marks internal API.
internal - Variable in class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
internalClassName() - Method in class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
internalClassPatterns - Variable in class io.spine.tools.gradle.compiler.Extension
 
internalMethodNames - Variable in class io.spine.tools.gradle.compiler.Extension
 
io.spine.tools.compiler - package io.spine.tools.compiler
Contains Spine Model Compiler and associated utilities.
io.spine.tools.compiler.annotation - package io.spine.tools.compiler.annotation
Contains classes and interfaces for applying annotations on Java files, which are generated from Protobuf definitions.
io.spine.tools.compiler.check - package io.spine.tools.compiler.check
Classes containing logic of the ErrorProneChecksPlugin.
io.spine.tools.compiler.field - package io.spine.tools.compiler.field
Contains classes working with Java fields generated from Protobuf.
io.spine.tools.compiler.field.type - package io.spine.tools.compiler.field.type
Classes for working with different proto field types.
io.spine.tools.compiler.gen - package io.spine.tools.compiler.gen
Classes for JavaPoet-based code generation.
io.spine.tools.compiler.gen.column - package io.spine.tools.compiler.gen.column
Classes for generating code for entity columns.
io.spine.tools.compiler.gen.rejection - package io.spine.tools.compiler.gen.rejection
Classes for generating code for rejections.
io.spine.tools.gradle.compiler - package io.spine.tools.gradle.compiler
Spine Gradle plugins for code generation and build-time Protobuf model validation.

J

JavaProtocConfigurationPlugin - Class in io.spine.tools.gradle.compiler
A Gradle plugin that performs additional protoc configurations relevant for Java projects.
JavaProtocConfigurationPlugin() - Constructor for class io.spine.tools.gradle.compiler.JavaProtocConfigurationPlugin
 

L

listGetter() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains get...List template.

M

mainDescriptorFile(Project) - Method in class io.spine.tools.gradle.compiler.ColumnGenPlugin
 
mainDescriptorFile(Project) - Method in class io.spine.tools.gradle.compiler.RejectionGenPlugin
 
mainDescriptorSetPath - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the main Protobuf descriptor set file.
mainGenGrpcDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the main gRPC services directory, generated basing on Protobuf definitions.
mainGenProtoDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the main Java sources directory, generated basing on Protobuf definitions.
mainProtoSrcDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the main Protobuf source directory.
mainTargetGenResourcesDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the main target generated resources directory.
MapFieldType - Class in io.spine.tools.compiler.field.type
Represents map field type.
mapGetter() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains get...Map template.
MethodPattern - Class in io.spine.tools.compiler.annotation
A pattern matching a method signature.
methods - Variable in class io.spine.tools.gradle.compiler.Extension
 
methods(Closure<?>) - Method in class io.spine.tools.gradle.compiler.Extension
 
methods(Action<? super GeneratedMethods>) - Method in class io.spine.tools.gradle.compiler.Extension
 
ModelCompilerPlugin - Class in io.spine.tools.gradle.compiler
Spine Model Compiler Gradle plugin.
ModelCompilerPlugin() - Constructor for class io.spine.tools.gradle.compiler.ModelCompilerPlugin
 
ModuleAnnotator - Class in io.spine.tools.compiler.annotation
A source code annotation facade.
ModuleAnnotator.Builder - Class in io.spine.tools.compiler.annotation
A builder for the ModuleAnnotator instances.
ModuleAnnotator.Job - Interface in io.spine.tools.compiler.annotation
A job of the annotator.
ModuleAnnotator.JobBuilder - Class in io.spine.tools.compiler.annotation
A builder of ModuleAnnotator.Job instances.

N

name() - Method in class io.spine.tools.compiler.gen.NoArgMethod
 
names() - Method in class io.spine.tools.compiler.field.GeneratedAccessors
Obtains all the names of the accessor methods.
nestedClasses - Variable in class io.spine.tools.gradle.compiler.Extension
 
nestedClasses(Closure<?>) - Method in class io.spine.tools.gradle.compiler.Extension
 
nestedClasses(Action<? super GeneratedNestedClasses>) - Method in class io.spine.tools.gradle.compiler.Extension
 
newBuilder() - Static method in class io.spine.tools.compiler.annotation.ModuleAnnotator
Creates a new instance of Builder for ModuleAnnotator instances.
newInstance(File, Path, Path) - Static method in class io.spine.tools.compiler.annotation.DefaultAnnotatorFactory
 
NoArgMethod - Class in io.spine.tools.compiler.gen
A reference to a method with no arguments.
NoArgMethod(String) - Constructor for class io.spine.tools.compiler.gen.NoArgMethod
 

O

of(FieldDeclaration) - Static method in interface io.spine.tools.compiler.field.type.FieldType
Creates a an instances basing on the type of the field.
option() - Method in class io.spine.tools.compiler.annotation.OptionAnnotator
Obtains the Protobuf API option to transform into a Java annotation.
OptionAnnotator<D extends com.google.protobuf.Descriptors.GenericDescriptor> - Class in io.spine.tools.compiler.annotation
An Annotator which annotates Java sources basing on a given Protobuf option.
OptionAnnotator(ClassName, ApiOption, ImmutableList<Descriptors.FileDescriptor>, Path) - Constructor for class io.spine.tools.compiler.annotation.OptionAnnotator
 

P

packageName() - Method in class io.spine.tools.compiler.gen.column.EntityWithColumnsSpec
 
packageName() - Method in class io.spine.tools.compiler.gen.rejection.RejectionSpec
 
postVisitDirectory(Path, IOException) - Method in class io.spine.tools.compiler.DirectoryCleaner
 
prefix(String) - Static method in class io.spine.tools.compiler.field.AccessorTemplate
Creates a new template with the given prefix and an empty postfix.
prefixAndPostfix(String, String) - Static method in class io.spine.tools.compiler.field.AccessorTemplate
Creates a new template with the given prefix and postfix.
PreprocessorConfigurer - Class in io.spine.tools.compiler.check
A helper that sets up and configures the preprocessor dependency for the Project.
primarySetterTemplate() - Method in interface io.spine.tools.compiler.field.type.FieldType
Obtains the setter prefix for the field.
primarySetterTemplate() - Method in class io.spine.tools.compiler.field.type.MapFieldType
Returns "putAll" setter prefix, used to initialize a map field using a protobuf message builder.
primarySetterTemplate() - Method in class io.spine.tools.compiler.field.type.RepeatedFieldType
Returns "addAll" setter prefix, used to initialize a repeated field using with a call to Protobuf message builder.
primarySetterTemplate() - Method in class io.spine.tools.compiler.field.type.SingularFieldType
Returns "set" setter template used to initialize a singular field using a Protobuf message builder.
ProtoAnnotatorPlugin - Class in io.spine.tools.gradle.compiler
A plugin that annotates generated Java sources from .proto files.
ProtoAnnotatorPlugin() - Constructor for class io.spine.tools.gradle.compiler.ProtoAnnotatorPlugin
 
putter() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains put... template.

R

RejectionGenPlugin - Class in io.spine.tools.gradle.compiler
Plugin which generates Rejections declared in rejections.proto files.
RejectionGenPlugin() - Constructor for class io.spine.tools.gradle.compiler.RejectionGenPlugin
 
RejectionSpec - Class in io.spine.tools.compiler.gen.rejection
A spec for a generated rejection type.
RejectionSpec(RejectionType) - Constructor for class io.spine.tools.compiler.gen.rejection.RejectionSpec
Creates a new instance.
remover() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains remove... template.
RepeatedFieldType - Class in io.spine.tools.compiler.field.type
Represents repeated field type.
rewriteSource(SourceFile, SourceVisitor<T>) - Method in class io.spine.tools.compiler.annotation.Annotator
Rewrites a generated Java source with the specified relative path after applying a SourceVisitor.

S

setAnnotatorFactory(AnnotatorFactory) - Method in class io.spine.tools.compiler.annotation.ModuleAnnotator.Builder
 
setIndent(int) - Method in class io.spine.tools.gradle.compiler.Extension
 
setInternalAnnotation(ClassName) - Method in class io.spine.tools.compiler.annotation.ModuleAnnotator.Builder
Specifies the internal annotation class name.
setInternalMethodNames(ImmutableSet<String>) - Method in class io.spine.tools.compiler.annotation.ModuleAnnotator.Builder
Sets names of methods to be annotated as internal.
setInternalPatterns(ImmutableSet<String>) - Method in class io.spine.tools.compiler.annotation.ModuleAnnotator.Builder
Sets patters for Java classes to be annotated as internal.
setter() - Static method in class io.spine.tools.compiler.field.AccessorTemplates
Obtains set... template.
setupPreprocessorConfig() - Method in class io.spine.tools.compiler.check.PreprocessorConfigurer
Creates the annotationProcessor config for the project if it does not exist.
Severity - Enum in io.spine.tools.gradle.compiler
The severity of the Spine Error Prone Checks.
SeverityConfigurer - Class in io.spine.tools.compiler.check
The helper for the Spine-custom Error Prone checks configuration of the Project.
shouldAnnotate(D) - Method in class io.spine.tools.compiler.annotation.OptionAnnotator
Tells whether the generated program elements from the specified descriptor should be annotated.
shouldGenerateValidatingBuilders(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
shouldGenerateValidation(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 
signature() - Method in class io.spine.tools.compiler.gen.NoArgMethod
 
SingularFieldType - Class in io.spine.tools.compiler.field.type
Represents singular field type.
spi() - Static method in class io.spine.tools.compiler.annotation.ApiOption
Obtains an option which marks beta service provider interface elements.
spi - Variable in class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
spiClassName() - Method in class io.spine.tools.gradle.compiler.CodeGenAnnotations
 
spineCheckSeverity - Variable in class io.spine.tools.gradle.compiler.Extension
The severity of the Spine-custom Error Prone checks.
spineDir(Project) - Static method in class io.spine.tools.gradle.compiler.Extension
 

T

targetGenColumnsRootDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the main target generated columns root directory.
targetGenRejectionsRootDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the main target generated rejections root directory.
targetTestGenColumnsRootDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the test target generated columns root directory.
targetTestGenRejectionsRootDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the test target generated rejections root directory.
testDescriptorFile(Project) - Method in class io.spine.tools.gradle.compiler.ColumnGenPlugin
 
testDescriptorFile(Project) - Method in class io.spine.tools.gradle.compiler.RejectionGenPlugin
 
testDescriptorSetPath - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the test Protobuf descriptor set file.
testGenGrpcDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the test gRPC services directory, generated basing on Protobuf definitions.
testGenProtoDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the test Java sources directory, generated basing on Protobuf definitions.
testProtoSrcDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the test Protobuf source directory.
testTargetGenResourcesDir - Variable in class io.spine.tools.gradle.compiler.Extension
The absolute path to the test target generated resources directory.
toString() - Method in class io.spine.tools.compiler.annotation.ApiOption
 
toString() - Method in class io.spine.tools.compiler.annotation.ClassNamePattern
 
toString() - Method in class io.spine.tools.compiler.annotation.MethodPattern
 
toString() - Method in class io.spine.tools.compiler.field.AccessorTemplate
 
toString() - Method in class io.spine.tools.compiler.field.type.MapFieldType
 
toString() - Method in class io.spine.tools.compiler.field.type.RepeatedFieldType
 
translate(ApiOption) - Static method in class io.spine.tools.compiler.annotation.ModuleAnnotator
TypeDeclarationAnnotation() - Constructor for class io.spine.tools.compiler.annotation.Annotator.TypeDeclarationAnnotation
 
typeSpec() - Method in class io.spine.tools.compiler.gen.column.EntityWithColumnsSpec
 
typeSpec() - Method in class io.spine.tools.compiler.gen.rejection.RejectionSpec
 

U

useValidatingBuilder - Variable in class io.spine.tools.gradle.compiler.ErrorProneChecksExtension
 

V

valueOf(String) - Static method in enum io.spine.tools.gradle.compiler.Severity
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.spine.tools.gradle.compiler.Severity
Returns an array containing the constants of this enum type, in the order they are declared.
visitFile(Path, BasicFileAttributes) - Method in class io.spine.tools.compiler.DirectoryCleaner
 
visitFileFailed(Path, IOException) - Method in class io.spine.tools.compiler.DirectoryCleaner
 
A B C D E F G H I J L M N O P R S T U V 
Skip navigation links