Index (plugin-base 1.8.2 API)

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

A

allowNoDependencies() - Method in class io.spine.tools.gradle.GradleTask.Builder: States that the task dependencies will be added to the task later.
apply(Project) - Method in class io.spine.tools.gradle.PluginScript
apply(GradlePlugin<?>) - Method in class io.spine.tools.gradle.project.PlugableProject
apply(PluginScript) - Method in class io.spine.tools.gradle.project.PlugableProject
apply(GradlePlugin<?>) - Method in interface io.spine.tools.gradle.project.PluginTarget: Applies the given plugin.
apply(PluginScript) - Method in interface io.spine.tools.gradle.project.PluginTarget: Applies the given plugin script.
apply(Project) - Method in class io.spine.tools.gradle.ProtocConfigurationPlugin
applyNowTo(Project) - Method in class io.spine.tools.gradle.GradleTask.Builder: Builds an instance of GradleTask and inserts it to the project build lifecycle according to the "before" and "after" tasks specified in the builder.
applyToAll(Project, Action<Project>) - Static method in class io.spine.tools.gradle.ProjectHierarchy: Applies the given action to all the available projects in the hierarchy defined by the given root project.
Artifact - Class in io.spine.tools.gradle: A Maven-style remote artifact specification.
Artifact.Builder - Class in io.spine.tools.gradle: A builder for the Artifact instances.

B

BaseTaskName - Enum in io.spine.tools.gradle: Names of Gradle tasks defined by the base plugin.
build() - Method in class io.spine.tools.gradle.Artifact.Builder: Creates a new instance of Artifact.

C

className() - Method in class io.spine.tools.gradle.GradlePlugin: Obtains the fully qualified name of the implementation class.
closure(ConsumerClosure.Action<? super T>) - Static method in class io.spine.tools.groovy.ConsumerClosure: Creates a new closure with the given action.
CodeGenerationAction - Class in io.spine.tools.gradle: Abstract base for code generation actions.
CodeGenerationAction(Project, Supplier<FileSet>, Supplier<String>, Supplier<String>) - Constructor for class io.spine.tools.gradle.CodeGenerationAction: Creates a new instance.
compile(Artifact) - Method in interface io.spine.tools.gradle.project.Dependant: Adds a new dependency within the compile configuration.
compile(String) - Method in interface io.spine.tools.gradle.project.Dependant: Adds a new dependency within the compile configuration.
ConfigurationName - Enum in io.spine.tools.gradle: The names of Gradle configurations used by the Spine model compiler plugin.
configureProtocPlugins(NamedDomainObjectContainer<ExecutableLocator>, Project) - Method in class io.spine.tools.gradle.ProtocConfigurationPlugin: Adds plugins related to the protoc.
ConsumerClosure<T> - Class in io.spine.tools.groovy: An implementation of Groovy Closure which calls a given Consumer function with a passed parameter and returns no value.
ConsumerClosure.Action<T> - Interface in io.spine.tools.groovy: An action to execute upon the closure argument.
customizeTask(GenerateProtoTask) - Method in class io.spine.tools.gradle.ProtocConfigurationPlugin: Allows subclasses to specify additional generation task settings.

D

declaredIn(Resource) - Static method in class io.spine.tools.gradle.PluginScript
defaultMainDescriptor(Project) - Method in class io.spine.tools.gradle.GradleExtension
defaultProject(Project) - Method in class io.spine.tools.gradle.GradleExtension
defaultTestDescriptor(Project) - Method in class io.spine.tools.gradle.GradleExtension
depend(ConfigurationName, String) - Method in interface io.spine.tools.gradle.project.Dependant: Adds a new dependency within a given configuration.
depend(ConfigurationName, String) - Method in class io.spine.tools.gradle.project.DependantProject
Dependant - Interface in io.spine.tools.gradle.project: Manages the dependencies of a Gradle project.
DependantProject - Class in io.spine.tools.gradle.project: A Dependant implemented on top of a DependencyHandler of a project.
Dependency - Interface in io.spine.tools.gradle: A Maven-style dependency specification.
DependencyVersions - Class in io.spine.tools.gradle: Versions of the dependencies that are used by Spine plugins.
dependsOn(Task, Task) - Static method in class io.spine.tools.gradle.TaskDependencies: Checks whether a given Gradle task depends on another Gradle task.
dependsOn(Task, TaskName) - Static method in class io.spine.tools.gradle.TaskDependencies: Checks whether a given Gradle task depends on another Gradle task with the specified name.
DirectoryPattern - Class in io.spine.tools.code.structure: A pattern to match a directory.

E

equals(Object) - Method in class io.spine.tools.code.structure.DirectoryPattern
equals(Object) - Method in class io.spine.tools.code.structure.ExternalModule
equals(Object) - Method in class io.spine.tools.gradle.Artifact
equals(Object) - Method in class io.spine.tools.gradle.GradlePlugin
equals(Object) - Method in class io.spine.tools.gradle.GradleTask
equals(Object) - Method in class io.spine.tools.gradle.ThirdPartyDependency
exclude(Dependency) - Method in interface io.spine.tools.gradle.project.Dependant: Excludes the given dependency from the project.
exclude(Dependency) - Method in class io.spine.tools.gradle.project.DependantProject
ExternalModule - Class in io.spine.tools.code.structure: An external library module used in a project.
ExternalModule(String, Collection<DirectoryPattern>) - Constructor for class io.spine.tools.code.structure.ExternalModule: Creates a new instance.

F

fileInModule(FileReference) - Method in class io.spine.tools.code.structure.ExternalModule: Obtains the file reference within this module.
fileSafeId() - Method in class io.spine.tools.gradle.Artifact: Prints this spec in the same way as Artifact.notation() but with _ (underscore symbol) instead of any other separator characters.
force(Artifact) - Method in interface io.spine.tools.gradle.project.Dependant: Forces all project configurations to fetch the particular dependency version.
force(String) - Method in interface io.spine.tools.gradle.project.Dependant: Forces all project configurations to fetch the particular dependency version.
force(Artifact) - Method in class io.spine.tools.gradle.project.DependantProject
force(String) - Method in class io.spine.tools.gradle.project.DependantProject
from(Dependency) - Static method in class io.spine.tools.gradle.Artifact: Creates a new Artifact from the given Dependency
from(Task) - Static method in class io.spine.tools.gradle.GradleTask: Creates a new instance from the specified Task.
from(Project) - Static method in class io.spine.tools.gradle.project.DependantProject: Creates a new instance of DependantProject for the given project.
fromPlain(String) - Static method in class io.spine.tools.groovy.GStrings: Deprecated.

Creates a new GString equivalent to the given Java string.

G

generatedFilesBaseDir(Project) - Method in class io.spine.tools.gradle.ProtocConfigurationPlugin: Obtains the location of the generated directory of the specified project.
GeneratedSourceRoot - Class in io.spine.tools.gradle: A root directory to generate source code into.
GeneratedSourceSet - Class in io.spine.tools.gradle: The generated code directory which belongs to a certain source set.
get() - Static method in class io.spine.tools.gradle.DependencyVersions: Obtains the DependencyVersions instance.
getIndent(Project) - Method in class io.spine.tools.gradle.CodeGenerationAction: Obtains indentation configuration from the project.
getMainDescriptorSet(Project) - Method in class io.spine.tools.gradle.ProtocConfigurationPlugin: Obtains the merged descriptor set file of the main module.
getName() - Method in class io.spine.tools.gradle.GradleTask: Obtains task name.
getProject() - Method in class io.spine.tools.gradle.GradleTask: Obtains the project of the task.
getTask() - Method in class io.spine.tools.gradle.GradleTask: Obtains the Gradle task itself.
getTestDescriptorSet(Project) - Method in class io.spine.tools.gradle.ProtocConfigurationPlugin: Obtains the merged descriptor set file of the test module.
GradleExtension - Class in io.spine.tools.gradle: An abstract base for creating Gradle extensions.
GradleExtension() - Constructor for class io.spine.tools.gradle.GradleExtension
GradlePlugin> - Class in io.spine.tools.gradle: An identifier of a Gradle plugin.
gradlePlugin() - Static method in class io.spine.tools.gradle.ProtobufDependencies: Obtains the ID of the Protobuf Gradle plugin.
GradleTask - Class in io.spine.tools.gradle: Utility wrapper around the Gradle tasks created.
GradleTask.Builder - Class in io.spine.tools.gradle: A builder for GradleTask.
groupId() - Method in interface io.spine.tools.gradle.Dependency: Obtains the Maven group ID of this dependency.
groupId() - Method in class io.spine.tools.gradle.ThirdPartyDependency
grpc() - Method in class io.spine.tools.gradle.DependencyVersions: Obtains the version of gRPC.
grpc() - Method in class io.spine.tools.gradle.GeneratedSourceSet: Obtains the root directory for Java sources generated by the gRPC Protobuf compiler.
GStrings - Class in io.spine.tools.groovy: Deprecated.
Since the latest changes in the Protobuf Gradle plugin, usage of Groovy strings in Java or Kotlin becomes obsolete. This factory will be removed in a future release.

H

hashCode() - Method in class io.spine.tools.code.structure.DirectoryPattern
hashCode() - Method in class io.spine.tools.code.structure.ExternalModule
hashCode() - Method in class io.spine.tools.gradle.Artifact
hashCode() - Method in class io.spine.tools.gradle.GradlePlugin
hashCode() - Method in class io.spine.tools.gradle.GradleTask
hashCode() - Method in class io.spine.tools.gradle.ThirdPartyDependency

I

implementation(String) - Method in interface io.spine.tools.gradle.project.Dependant: Adds a new dependency within the implementation configuration.
implementationClass() - Method in class io.spine.tools.gradle.GradlePlugin: Obtains the implementation class of this plugin.
implementedIn(Class) - Static method in class io.spine.tools.gradle.GradlePlugin: Creates a new instance with the given implementation class.
indent() - Method in class io.spine.tools.gradle.CodeGenerationAction: Obtains indentation to be used for code generation.
insertAfterAllTasks(TaskName) - Method in class io.spine.tools.gradle.GradleTask.Builder: Inserts tasks which will precede the new one.
insertAfterTask(TaskName) - Method in class io.spine.tools.gradle.GradleTask.Builder: Specify a task which will precede the new one.
insertBeforeTask(TaskName) - Method in class io.spine.tools.gradle.GradleTask.Builder: Specify a task which will follow the new one.
io.spine.tools.code.structure - package io.spine.tools.code.structure: Classes which work with source code directory structure.
io.spine.tools.gradle - package io.spine.tools.gradle: Base classes and interfaces for Spine Gradle plugins.
io.spine.tools.gradle.project - package io.spine.tools.gradle.project: Contains classes working with the Gradle Project.
io.spine.tools.groovy - package io.spine.tools.groovy: This package contains components supporting Groovy interoperability.
isApplied(GradlePlugin<?>) - Method in class io.spine.tools.gradle.project.PlugableProject
isApplied(GradlePlugin<?>) - Method in interface io.spine.tools.gradle.project.PluginTarget: Checks if the given plugin is already applied.
isNotApplied(GradlePlugin<?>) - Method in interface io.spine.tools.gradle.project.PluginTarget: Checks if the given plugin is not applied yet.
isTestsTask(GenerateProtoTask) - Static method in class io.spine.tools.gradle.ProtocConfigurationPlugin

J

java() - Method in class io.spine.tools.gradle.GeneratedSourceSet: Obtains the root directory for Java sources generated by the Protobuf compiler.
JavadocPrettifierTaskName - Enum in io.spine.tools.gradle: Names of Gradle tasks defined by the Javadoc Prettifier plugin.
JavaTaskName - Enum in io.spine.tools.gradle: Names of Gradle tasks defined by the java plugin.

L

logMissingDescriptorSetFile(File) - Method in class io.spine.tools.gradle.SpinePlugin

M

mainDescriptorFile(Project) - Method in class io.spine.tools.gradle.ProtoPlugin: Obtains the descriptor set file for the main scope.
mainProtoFiles(Project) - Method in class io.spine.tools.gradle.ProtoPlugin: Obtains Protobuf files for the main scope.
ModelCompilerTaskName - Enum in io.spine.tools.gradle: Names of Gradle tasks defined by the Spine Model Compiler plugin.
ModelVerifierTaskName - Enum in io.spine.tools.gradle: Names of Gradle tasks defined by the Spine Model Verifier plugin.

N

name() - Method in class io.spine.tools.code.structure.ExternalModule: Obtains the name of the module.
name() - Method in interface io.spine.tools.gradle.Dependency: Obtains the name of this dependency.
name() - Method in interface io.spine.tools.gradle.TaskName: The value of the name.
name() - Method in class io.spine.tools.gradle.ThirdPartyDependency
newBuilder() - Static method in class io.spine.tools.gradle.Artifact: Creates a new instance of Builder for Artifact instances.
newTask(TaskName, Action<Task>) - Method in class io.spine.tools.gradle.SpinePlugin: Create a new instance of GradleTask.Builder.
notation() - Method in class io.spine.tools.gradle.Artifact: Prints this spec into a single string.

O

of(String) - Static method in class io.spine.tools.code.structure.DirectoryPattern: Creates a new instance.
of(Project) - Static method in class io.spine.tools.gradle.GeneratedSourceRoot: Obtains the generated source code root directory of the given project.
of(Project) - Static method in class io.spine.tools.gradle.project.ProjectSourceSuperset: Creates a new instance of ProjectSourceSuperset for the given project.
ofVersion(String) - Method in interface io.spine.tools.gradle.Dependency: Compiles an Artifact for this dependency.

P

path() - Method in interface io.spine.tools.gradle.TaskName: Obtains this task name as a path.
PlugableProject - Class in io.spine.tools.gradle.project: An implementation of PluginTarget based on a Gradle Project.
PlugableProject(Project) - Constructor for class io.spine.tools.gradle.project.PlugableProject
PluginId - Class in io.spine.tools.gradle: An identifier of a Gradle plugin.
PluginId(String) - Constructor for class io.spine.tools.gradle.PluginId
PluginScript - Class in io.spine.tools.gradle: A Gradle project plugin implemented in a .gradle script.
PluginTarget - Interface in io.spine.tools.gradle.project: A target of Gradle plugin application.
predefinedModules() - Static method in class io.spine.tools.code.structure.ExternalModule: All the modules in ExternalModule.spineWeb() and ExternalModule.spineUsers().
project() - Method in class io.spine.tools.gradle.CodeGenerationAction: Obtains the project for which the code is generated.
ProjectHierarchy - Class in io.spine.tools.gradle: A utility class for working with the Gradle project hierarchy.
ProjectSourceSuperset - Class in io.spine.tools.gradle.project: A SourceSuperset implementation based on source sets of a Gradle project.
protobuf() - Method in class io.spine.tools.gradle.DependencyVersions: Obtains the version of Protobuf.
protobufCompiler() - Static method in class io.spine.tools.gradle.ProtobufDependencies
ProtobufDependencies - Class in io.spine.tools.gradle: A factory of Protobuf-related artifact specs.
protobufLite() - Static method in class io.spine.tools.gradle.ProtobufDependencies: Obtains the ThirdPartyDependency on the Protobuf Lite Java runtime library.
ProtobufTaskName - Enum in io.spine.tools.gradle: Names of Gradle tasks defined by the Protobuf Gradle plugin.
ProtocConfigurationPlugin - Class in io.spine.tools.gradle: An abstract base for Gradle plugins that configure Protobuf compilation.
ProtocConfigurationPlugin() - Constructor for class io.spine.tools.gradle.ProtocConfigurationPlugin
ProtocPluginName - Enum in io.spine.tools.gradle: Names of known Protobuf compiler plugins.
ProtoDartTaskName - Enum in io.spine.tools.gradle: Names of Gradle tasks defined by the Spine Protobuf Dart plugin.
protoFiles() - Method in class io.spine.tools.gradle.CodeGenerationAction: Obtains the Protobuf files to be processed.
ProtoJsTaskName - Enum in io.spine.tools.gradle: Names of Gradle tasks defined by the Spine Protobuf JS plugin.
ProtoPlugin - Class in io.spine.tools.gradle: A plugin performing code-generation based on a .proto files.
ProtoPlugin() - Constructor for class io.spine.tools.gradle.ProtoPlugin
protoSrcDir() - Method in class io.spine.tools.gradle.CodeGenerationAction: Obtains directory with source proto files.
provides(FileReference) - Method in class io.spine.tools.code.structure.ExternalModule: Checks if the module provides the referenced file.

R

register(GeneratedSourceRoot) - Method in class io.spine.tools.gradle.project.ProjectSourceSuperset
register(GeneratedSourceRoot) - Method in interface io.spine.tools.gradle.project.SourceSuperset: Marks the given directory as a generated code root dir.
removeForcedDependency(Dependency) - Method in interface io.spine.tools.gradle.project.Dependant: Removes a forced dependency from resolution strategies of all project configurations.
removeForcedDependency(String) - Method in interface io.spine.tools.gradle.project.Dependant: Removes a forced dependency from resolution strategies of all project configurations.
removeForcedDependency(Dependency) - Method in class io.spine.tools.gradle.project.DependantProject
removeForcedDependency(String) - Method in class io.spine.tools.gradle.project.DependantProject
resolve(Supplier<String>) - Static method in class io.spine.tools.gradle.SpinePlugin: Resolves an absolute file name obtained as a string from the passed supplier.
resources() - Method in class io.spine.tools.gradle.GeneratedSourceSet: Obtains the root directory for resources generated by the Model Compiler plugin.

S

setClassifier(String) - Method in class io.spine.tools.gradle.Artifact.Builder
setExtension(String) - Method in class io.spine.tools.gradle.Artifact.Builder
setGroup(String) - Method in class io.spine.tools.gradle.Artifact.Builder
setName(String) - Method in class io.spine.tools.gradle.Artifact.Builder
setVersion(String) - Method in class io.spine.tools.gradle.Artifact.Builder
SourceScope - Enum in io.spine.tools.gradle: A name of a source set scope.
sourceSet(String) - Method in class io.spine.tools.gradle.GeneratedSourceRoot: Obtains the generated code directory which belongs to the source set with the given name.
SourceSuperset - Interface in io.spine.tools.gradle.project: A set of source sets of a project.
spine() - Method in class io.spine.tools.gradle.GeneratedSourceSet: Obtains the root directory for Java sources generated by the Model Compiler plugin.
SPINE_TOOLS_GROUP - Static variable in class io.spine.tools.gradle.Artifact: The artifact group used for Spine tools.
spineBase() - Method in class io.spine.tools.gradle.DependencyVersions: Obtains the version of Spine base, Spine model-compiler plugin, and Spine Protoc plugin.
SpinePlugin - Class in io.spine.tools.gradle: Abstract base for Spine plugins.
SpinePlugin() - Constructor for class io.spine.tools.gradle.SpinePlugin
spineUsers() - Static method in class io.spine.tools.code.structure.ExternalModule: The Spine Users module.
spineWeb() - Static method in class io.spine.tools.code.structure.ExternalModule: The Spine Web module.

T

targetDir() - Method in class io.spine.tools.gradle.CodeGenerationAction: Obtains directory under which the generated source will be placed.
TaskDependencies - Class in io.spine.tools.gradle: Utilities for Gradle task dependencies management.
TaskName - Interface in io.spine.tools.gradle: A name of a Gradle task.
testDescriptorFile(Project) - Method in class io.spine.tools.gradle.ProtoPlugin: Obtains the descriptor set file for the test scope.
testProtoFiles(Project) - Method in class io.spine.tools.gradle.ProtoPlugin: Obtains Protobuf files for the test scope.
ThirdPartyDependency - Class in io.spine.tools.gradle: A third-party dependency of a client project.
ThirdPartyDependency(String, String) - Constructor for class io.spine.tools.gradle.ThirdPartyDependency
toString() - Method in class io.spine.tools.gradle.Artifact
toString() - Method in class io.spine.tools.gradle.GradlePlugin
toString() - Method in class io.spine.tools.gradle.GradleTask
toString() - Method in class io.spine.tools.gradle.ThirdPartyDependency

U

useSpineToolsGroup() - Method in class io.spine.tools.gradle.Artifact.Builder
useTestClassifier() - Method in class io.spine.tools.gradle.Artifact.Builder

V

value() - Method in enum io.spine.tools.gradle.ConfigurationName
valueOf(String) - Static method in enum io.spine.tools.gradle.BaseTaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.ConfigurationName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.JavadocPrettifierTaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.JavaTaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.ModelCompilerTaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.ModelVerifierTaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.ProtobufTaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.ProtocPluginName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.ProtoDartTaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.ProtoJsTaskName: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.spine.tools.gradle.SourceScope: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.spine.tools.gradle.BaseTaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.ConfigurationName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.JavadocPrettifierTaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.JavaTaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.ModelCompilerTaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.ModelVerifierTaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.ProtobufTaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.ProtocPluginName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.ProtoDartTaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.ProtoJsTaskName: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.spine.tools.gradle.SourceScope: Returns an array containing the constants of this enum type, in the order they are declared.
VERSIONS - Static variable in class io.spine.tools.gradle.ProtocConfigurationPlugin

W

with(GradlePlugin, Consumer) - Method in class io.spine.tools.gradle.project.PlugableProject
with(GradlePlugin, Consumer) - Method in interface io.spine.tools.gradle.project.PluginTarget: Executes the given action if the given plugin is applied.
withInputFiles(FileCollection) - Method in class io.spine.tools.gradle.GradleTask.Builder: Adds the files and/or directories to the input file set for the task being built.
withInputProperty(String, Serializable) - Method in class io.spine.tools.gradle.GradleTask.Builder: Adds a task input property.
withOutputFiles(FileCollection) - Method in class io.spine.tools.gradle.GradleTask.Builder: Adds the files and/or directories to the output file set for the task being built.

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