A

addIncludeDir(FileCollection) - Method in GenerateProtoTask

Add a directory to protoc's include path.

addSourceDirs(FileCollection) - Method in GenerateProtoTask

Add a collection of proto source files to be compiled.

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

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

all() - Method in ProtobufExtension.GenerateProtoTaskCollection

apply(Project) - Method in ProtobufPlugin

ArchiveActionFacade - Interface in com.google.protobuf.gradle

ArchiveActionFacade.ProjectBased - Class in com.google.protobuf.gradle

ArchiveActionFacade.ServiceBased - Class in com.google.protobuf.gradle

artifactParts(String) - Method in ToolsLocator

B

builtins(Action<NamedDomainObjectContainer<PluginOptions>>) - Method in GenerateProtoTask

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

C

compile() - Method in GenerateProtoTask

computeExecutablePath(ExecutableLocator) - Method in GenerateProtoTask

computeJavaExePath(boolean) - Method in GenerateProtoTask

copy(Action<? super CopySpec>) - Method in CopyActionFacade.FileSystemOperationsBased

copy(Action<? super CopySpec>) - Method in CopyActionFacade.ProjectBased

CopyActionFacade.FileSystemOperationsBased - Class in com.google.protobuf.gradle

CopyActionFacade.Loader - Class in com.google.protobuf.gradle

CopyActionFacade.ProjectBased - Class in com.google.protobuf.gradle

CopyActionFacade.ProjectBased(Project) - Constructor in CopyActionFacade.ProjectBased

create(Project, ObjectFactory) - Method in CopyActionFacade.Loader

D

DefaultProtoSourceSet - Class in com.google.protobuf.gradle.internal

DefaultProtoSourceSet(String, ObjectFactory) - Constructor in DefaultProtoSourceSet

delete(Action<? super DeleteSpec>) - Method in CopyActionFacade.FileSystemOperationsBased

delete(Action<? super DeleteSpec>) - Method in CopyActionFacade.ProjectBased

doneConfig() - Method in GenerateProtoTask

doneInitializing() - Method in GenerateProtoTask

E

escapePathUnix(String) - Method in GenerateProtoTask

escapePathWindows(String) - Method in GenerateProtoTask

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

extendsFrom(ProtoSourceSet) - Method in DefaultProtoSourceSet

extendsFrom(ProtoSourceSet) - Method in ProtoSourceSet

extract() - Method in ProtobufExtract

F

forEachVariant(Project, Action<? extends BaseVariant>) - Method in ProjectExt

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

generateProtoTasks(Action<GenerateProtoTaskCollection>) - Method in ProtobufExtension

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.

getBuiltinsForCaching() - Method in GenerateProtoTask

Used to expose inputs to Gradle, not to be called directly.

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

getDescriptorSetOptionsForCaching() - Method in GenerateProtoTask

Used to expose inputs to Gradle, not to be called directly.

getDestDir() - Method in ProtobufExtract

getExecutables() - Method in GenerateProtoTask

Not for external use.

getFileOperations() - Method in ArchiveActionFacade.ServiceBased

getFileSystemOperations() - Method in CopyActionFacade.FileSystemOperationsBased

getFlavors() - Method in GenerateProtoTask

getGeneratedFilesBaseDir() - Method in ProtobufExtension

getGenerateProtoTasks() - Method in ProtobufExtension

Returns the collection of generateProto tasks.

getIncludeDirs() - Method in GenerateProtoTask

getIncludeProtoDirs() - Method in DefaultProtoSourceSet

getIncludeProtoDirs() - Method in ProtoSourceSet

getInputFiles() - Method in ProtobufExtract

Input for this tasks containing all archive files to extract.

getInputProtoFiles() - Method in ProtobufExtract

Inputs for this task containing only proto files, which is enough for up-to-date checks.

getIsAndroidProject() - Method in GenerateProtoTask

getIsTest() - Method in GenerateProtoTask

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

getIsTestProvider() - Method in GenerateProtoTask

getIsTestVariant() - Method in GenerateProtoTask

getKotlinAndroidCompileTaskName(Project, String) - Method in Utils

Returns the compile task name for Kotlin.

getName() - Method in DefaultProtoSourceSet

getName() - Method in ExecutableLocator

getName() - Method in GenerateProtoTask.PluginOptions

Returns the name of the plugin or builtin.

getName() - Method in ProtoSourceSet

getObjectFactory() - Method in GenerateProtoTask

getObjectFactory() - Method in ProtobufExtract

getOptions() - Method in GenerateProtoTask.PluginOptions

getOutput() - Method in DefaultProtoSourceSet

getOutput() - Method in ProtoSourceSet

getOutputBaseDir() - Method in GenerateProtoTask

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.

getPluginsForCaching() - Method in GenerateProtoTask

Used to expose inputs to Gradle, not to be called directly.

getProto() - Method in DefaultProtoSourceSet

getProto() - Method in ProtoSourceSet

getProviderFactory() - Method in GenerateProtoTask

getProviderFactory() - Method in ProtobufExtract

getReleaseArtifacts() - Method in GenerateProtoTask

Not for external use.

getSourceDirs() - Method in GenerateProtoTask

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

includesFrom(ProtoSourceSet) - Method in DefaultProtoSourceSet

includesFrom(ProtoSourceSet) - Method in ProtoSourceSet

isAndroidProject(Project) - Method in Utils

Detects if an android plugin has been applied to the project

isTest(String) - Method in Utils

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

isWindows() - Method in GenerateProtoTask

J

K

L

M

makeOptionsPrefix(List<String>) - Method in GenerateProtoTask

mkdirsForFile(File) - Method in GenerateProtoTask

N

O

ofBuildType(String) - Method in ProtobufExtension.GenerateProtoTaskCollection

ofFlavor(String) - Method in ProtobufExtension.GenerateProtoTaskCollection

ofNonTest() - Method in ProtobufExtension.GenerateProtoTaskCollection

ofSourceSet(String) - Method in ProtobufExtension.GenerateProtoTaskCollection

ofTest() - Method in ProtobufExtension.GenerateProtoTaskCollection

ofVariant(String) - Method in ProtobufExtension.GenerateProtoTaskCollection

option(String) - Method in GenerateProtoTask.PluginOptions

Adds a plugin option.

P

plugins(Action<NamedDomainObjectContainer<PluginOptions>>) - Method in GenerateProtoTask

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

plugins(Action<NamedDomainObjectContainer<ExecutableLocator>>) - Method in ProtobufExtension

Locate the codegen plugin executables.

ProjectExt - Class in com.google.protobuf.gradle.internal

ProtobufExtension - Class in com.google.protobuf.gradle

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

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

ProtobufExtension.GenerateProtoTaskCollection(Project) - Constructor in ProtobufExtension.GenerateProtoTaskCollection

ProtobufExtension(Project) - Constructor in ProtobufExtension

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.

protoc(Action<ExecutableLocator>) - Method in ProtobufExtension

Locates the protoc executable.

ProtoSourceSet - Interface in com.google.protobuf.gradle.tasks

Q

R

resolve(Project) - 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.

S

setArtifact(String) - Method in ExecutableLocator

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

setBuildType(String) - Method in GenerateProtoTask

setExecutableOrFail(File) - Method in GenerateProtoTask

setFlavors(List<String>) - Method in GenerateProtoTask

setGeneratedFilesBaseDir(String) - Method in ProtobufExtension

setOutputBaseDir(Provider<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

tarTree(Object) - Method in ArchiveActionFacade

tarTree(Object) - Method in ArchiveActionFacade.ProjectBased

tarTree(Object) - Method in ArchiveActionFacade.ServiceBased

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

zipTree(Object) - Method in ArchiveActionFacade

zipTree(Object) - Method in ArchiveActionFacade.ProjectBased

zipTree(Object) - Method in ArchiveActionFacade.ServiceBased

_