A

addFilesToTaskInputs(Project, TaskInputs, Object) - Method in Utils

addToIdeSources(Project, boolean, File) - Method in Utils

Adds the file to the IDE plugin's set of sources / resources.

all() - Method in ProtobufConfigurator.GenerateProtoTaskCollection

apply(Project) - Method in ProtobufPlugin

artifactParts(String) - Method in ToolsLocator

B

builtins(Closure) - Method in GenerateProtoTask

Configures the protoc builtins in a closure, which will be manipulating a NamedDomainObjectContainer.

C

compareGradleVersion(Project, String) - Method in Utils

Returns positive/0/negative if current Gradle version is higher than/equal to/lower than the given target version.

compile() - Method in GenerateProtoTask

D

doneConfig() - Method in GenerateProtoTask

doneInitializing() - Method in GenerateProtoTask

E

ExecutableLocator - Class in com.google.protobuf.gradle

Locates an executable that can either be found locally or downloaded from repositories.

ExecutableLocator(String) - Constructor in ExecutableLocator

extract() - Method in ProtobufExtract

F

G

generateCmds(List<String>, List<File>, int) - Method in GenerateProtoTask

GenerateProtoTask - Class in com.google.protobuf.gradle

The task that compiles proto files into Java files.

GenerateProtoTask.DescriptorSetOptions - Class in com.google.protobuf.gradle

Configuration object for descriptor generation details.

GenerateProtoTask.PluginOptions - Class in com.google.protobuf.gradle

The container of command-line options for a protoc plugin or a built-in output.

GenerateProtoTask.PluginOptions(String) - Constructor in GenerateProtoTask.PluginOptions

GenerateProtoTask() - Constructor in GenerateProtoTask

generateProtoTasks(Closure) - Method in ProtobufConfigurator

Configures the generateProto tasks in the given closure.

getArtifact() - Method in ExecutableLocator

getBuildType() - Method in GenerateProtoTask

getBuiltins() - Method in GenerateProtoTask

Returns the container of protoc builtins.

getCmdLengthLimit(String) - Method in GenerateProtoTask

getConfigName(String, String) - Method in Utils

Returns the conventional name of a configuration for a sourceSet

getDescriptorPath() - Method in GenerateProtoTask

getDestDir() - Method in ProtobufExtract

getFileResolver() - Method in GenerateProtoTask

getFlavors() - Method in GenerateProtoTask

getGenerateProtoTasks() - Method in ProtobufConfigurator

Returns the collection of generateProto tasks.

getIsTest() - Method in GenerateProtoTask

Returns true if the Java source set or Android variant is test related.

getIsTest() - Method in ProtobufExtract

getIsTestVariant() - Method in GenerateProtoTask

getKotlinAndroidCompileTaskName(Project, String) - Method in Utils

Returns the compile task name for Kotlin.

getName() - Method in ExecutableLocator

getName() - Method in GenerateProtoTask.PluginOptions

Returns the name of the plugin or builtin.

getOptions() - Method in GenerateProtoTask.PluginOptions

getOutputDir(GenerateProtoTask.PluginOptions) - Method in GenerateProtoTask

getOutputSourceDirectorySet() - Method in GenerateProtoTask

Returns a SourceDirectorySet representing the generated source directories.

getOutputSubDir() - Method in GenerateProtoTask.PluginOptions

Returns the relative outputDir for this plugin.

getPath() - Method in ExecutableLocator

getPlugins() - Method in GenerateProtoTask

Returns the container of protoc plugins.

getSourceSet() - Method in GenerateProtoTask

getSourceSetSubstringForTaskNames(String) - Method in Utils

Returns the conventional substring that represents the sourceSet in task names, e.g., "generateProto"

getVariant() - Method in GenerateProtoTask

H

hasPlugin(String) - Method in GenerateProtoTask

Returns true if the task has a plugin with the given name, false otherwise.

I

include(Object) - Method in GenerateProtoTask

Add a directory to protoc's include path.

isAndroidProject(Project) - Method in Utils

isTest(String) - Method in Utils

Returns true if the source set is a test related source set.

J

K

L

M

makeOptionsPrefix(List<String>) - Method in GenerateProtoTask

N

O

ofBuildType(String) - Method in ProtobufConfigurator.AndroidGenerateProtoTaskCollection

ofFlavor(String) - Method in ProtobufConfigurator.AndroidGenerateProtoTaskCollection

ofNonTest() - Method in ProtobufConfigurator.AndroidGenerateProtoTaskCollection

ofSourceSet(String) - Method in ProtobufConfigurator.JavaGenerateProtoTaskCollection

ofTest() - Method in ProtobufConfigurator.AndroidGenerateProtoTaskCollection

ofVariant(String) - Method in ProtobufConfigurator.AndroidGenerateProtoTaskCollection

option(String) - Method in GenerateProtoTask.PluginOptions

Adds a plugin option.

P

plugins(Closure) - Method in GenerateProtoTask

Configures the protoc plugins in a closure, which will be maniuplating a NamedDomainObjectContainer.

plugins(Closure) - Method in ProtobufConfigurator

Locate the codegen plugin executables.

protobuf(Closure) - Method in ProtobufConvention

ProtobufConfigurator - Class in com.google.protobuf.gradle

The main configuration block exposed as protobuf in the build script.

ProtobufConfigurator.AndroidGenerateProtoTaskCollection - Class in com.google.protobuf.gradle

ProtobufConfigurator.GenerateProtoTaskCollection - Class in com.google.protobuf.gradle

ProtobufConfigurator.JavaGenerateProtoTaskCollection - Class in com.google.protobuf.gradle

ProtobufConfigurator(Project, FileResolver) - Constructor in ProtobufConfigurator

ProtobufConvention - Class in com.google.protobuf.gradle

Adds the protobuf {} block as a property of the project.

ProtobufConvention(Project, FileResolver) - Constructor in ProtobufConvention

ProtobufExtract - Class in com.google.protobuf.gradle

Extracts proto files from a dependency configuration.

ProtobufPlugin - Class in com.google.protobuf.gradle

The main class for the protobuf plugin.

ProtobufPlugin(FileResolver) - Constructor in ProtobufPlugin

ProtobufSourceDirectorySet - Class in com.google.protobuf.gradle

The backing class of the proto extension added to sourceSets, e.g., sourceSets.main.proto

ProtobufSourceDirectorySet(String, FileResolver) - Constructor in ProtobufSourceDirectorySet

protoc(Closure) - Method in ProtobufConfigurator

Locates the protoc executable.

Q

R

registerDependencyWithTasks(ExecutableLocator, Collection<GenerateProtoTask>) - Method in ToolsLocator

registerTaskDependencies(Collection<GenerateProtoTask>) - Method in ToolsLocator

For every ExecutableLocator that points to an artifact spec: creates a project configuration dependency for that artifact, registers the configuration dependency as an input dependency with the specified tasks, and adds a doFirst {} block to the specified tasks which resolves the spec, downloads the artifact, and point to the local path.

runTaskConfigClosures() - Method in ProtobufConfigurator

S

setArtifact(String) - Method in ExecutableLocator

Specifies an artifact spec for downloading the executable from repositories. spec format: '::'

setBuildType(String) - Method in GenerateProtoTask

setDestDir(File) - Method in ProtobufExtract

setFileResolver(FileResolver) - Method in GenerateProtoTask

setFlavors(ImmutableList<String>) - Method in GenerateProtoTask

setIsTest(boolean) - Method in ProtobufExtract

setOutputBaseDir(String) - Method in GenerateProtoTask

setOutputSubDir(String) - Method in GenerateProtoTask.PluginOptions

Set the output directory for this plugin, relative to GenerateProtoTask.outputBaseDir.

setPath(String) - Method in ExecutableLocator

Specifies a local path.

setSourceSet(SourceSet) - Method in GenerateProtoTask

setVariant(Object, boolean) - Method in GenerateProtoTask

T

ToolsLocator - Class in com.google.protobuf.gradle

Holds locations of all external executables, i.e., protoc and plugins.

ToolsLocator(Project) - Constructor in ToolsLocator

U

Utils - Class in com.google.protobuf.gradle

Utility classes.

V

W

X

Y

Z

_