Gradle Plugin/kotlinx.rpc.protoc/ProtoTasks

ProtoTasks

Available in a dev version: 0․11․0-grpc-186

How to configure

sealed interface ProtoTasks<ProtoTaskT : ProtoTask> : TaskCollection<ProtoTaskT> (source)

Represents a collection of ProtoTask tasks of a given type.

Allows for better filtering using additional method on top of Gradle's TaskCollection.

Example:

protoTasks.matchingSourceSet("main")
protoTasks.testTasks()
protoTasks
    .testTasks()
    .matching { ... }
    .all { ... }

Properties

asMap

abstract override val asMap: SortedMap<String?, ProtoTaskT?>?

buf

val ProtoTasks<ProtoTask>.buf: ProtoTasks<BufExecTask>

Returns a collection of all buf tasks registered in the project.

collectionSchema

@get:Internal

abstract override val collectionSchema: NamedDomainObjectCollectionSchema?

generate

val ProtoTasks<BufExecTask>.generate: ProtoTasks<BufGenerateTask>

Returns a collection of all buf generate tasks registered in the project.

namer

abstract override val namer: Namer<ProtoTaskT?>?

names

abstract override val names: SortedSet<String?>?

rules

abstract override val rules: List<Rule?>?

size

abstract val size: Int

Functions

add

abstract fun add(e: ProtoTaskT?): Boolean

addAll

abstract fun addAll(c: Collection<out ProtoTaskT?>): Boolean

addAllLater

abstract fun addAllLater(provider: Provider<out Iterable<ProtoTaskT?>?>?)

addLater

abstract fun addLater(provider: Provider<out ProtoTaskT?>?)

addRule

abstract fun addRule(rule: Rule?): Rule?

abstract fun addRule(description: String?, ruleAction: Closure<*>?): Rule?

abstract fun addRule(description: String?, ruleAction: Action<String?>?): Rule?

all

abstract fun all(action: Closure<*>?)

abstract fun all(action: Action<in ProtoTaskT?>?)

androidInstrumentedTestTasks

abstract fun androidInstrumentedTestTasks(): ProtoTasks<ProtoTaskT>

Filters tasks by where ProtoTask.AndroidProperties.isInstrumentedTest is true.

androidTasks

abstract fun androidTasks(predicate: (ProtoTaskT, ProtoTask.AndroidProperties) -> Boolean = { _, _ -> true }): ProtoTasks<ProtoTaskT>

Filters tasks by where ProtoTask.properties are of type ProtoTask.AndroidProperties.

androidUnitTestTasks

abstract fun androidUnitTestTasks(): ProtoTasks<ProtoTaskT>

Filters tasks by where ProtoTask.AndroidProperties.isUnitTest is true.

clear

abstract fun clear()

configureEach

abstract fun configureEach(action: Action<in ProtoTaskT?>?)

contains

abstract operator fun contains(element: ProtoTaskT?): Boolean

containsAll

abstract fun containsAll(elements: Collection<ProtoTaskT?>): Boolean

findAll

abstract fun ~~findAll~~(spec: Closure<*>?): Set<ProtoTaskT?>?

findByName

abstract fun findByName(name: String?): @Nullable ProtoTaskT?

getAsMap

abstract fun getAsMap(): SortedMap<String?, ProtoTaskT?>?

getAt

abstract fun getAt(name: String?): ProtoTaskT?

getByName

abstract fun getByName(name: String?): ProtoTaskT?

abstract fun getByName(name: String?, configureClosure: Closure<*>?): ProtoTaskT?

abstract fun getByName(name: String?, configureAction: Action<in ProtoTaskT?>?): ProtoTaskT?

getNamer

abstract fun getNamer(): Namer<ProtoTaskT?>?

isEmpty

abstract fun isEmpty(): Boolean

iterator

abstract operator override fun iterator(): MutableIterator<ProtoTaskT?>

matching

abstract fun matching(closure: Closure<*>?): TaskCollection<ProtoTaskT?>?

abstract fun matching(spec: Spec<in ProtoTaskT?>?): TaskCollection<ProtoTaskT?>?

matchingAndroidBuildType

abstract fun matchingAndroidBuildType(buildType: String?): ProtoTasks<ProtoTaskT>

Filters tasks by where ProtoTask.AndroidProperties.buildType matches the given buildType.

matchingAndroidFlavor

abstract fun matchingAndroidFlavor(flavor: String?): ProtoTasks<ProtoTaskT>

Filters tasks by where ProtoTask.AndroidProperties.flavors matches the given flavor.

matchingAndroidVariant

abstract fun matchingAndroidVariant(variant: String?): ProtoTasks<ProtoTaskT>

Filters tasks by where ProtoTask.AndroidProperties.variant matches the given variant.

matchingKotlinSourceSet

abstract fun matchingKotlinSourceSet(sourceSet: NamedDomainObjectProvider<KotlinSourceSet>): ProtoTasks<ProtoTaskT>

abstract fun matchingKotlinSourceSet(sourceSet: KotlinSourceSet): ProtoTasks<ProtoTaskT>

Filters tasks by a Kotlin source set.

matchingSourceSet

abstract fun matchingSourceSet(sourceSetName: String): ProtoTasks<ProtoTaskT>

Filters tasks by source set name.

abstract fun matchingSourceSet(sourceSet: NamedDomainObjectProvider<SourceSet>): ProtoTasks<ProtoTaskT>

abstract fun matchingSourceSet(sourceSet: SourceSet): ProtoTasks<ProtoTaskT>

Filters tasks by a source set.

matchingType

abstract fun <ProtoTaskT : ProtoTask> matchingType(kClass: KClass<ProtoTaskT>): ProtoTasks<ProtoTaskT>

Filters tasks by type.

matchingType

inline fun <ProtoTaskT : ProtoTask> ProtoTasks<*>.matchingType(): ProtoTasks<ProtoTaskT>

Filters tasks by type.

named

abstract fun named(name: String?): TaskProvider<ProtoTaskT?>?

abstract fun named(nameFilter: Spec<String?>?): TaskCollection<ProtoTaskT?>?

abstract fun <S : ProtoTaskT?> named(name: String?, type: Class<S?>?): TaskProvider<S?>?

abstract fun named(name: String?, configurationAction: Action<in ProtoTaskT?>?): TaskProvider<ProtoTaskT?>?

abstract fun <S : ProtoTaskT?> named(name: String?, type: Class<S?>?, configurationAction: Action<in S?>?): TaskProvider<S?>?

nonTestTasks

abstract fun nonTestTasks(): ProtoTasks<ProtoTaskT>

Filters tasks by where ProtoTask.Properties.isTest is false.

remove

@IgnorableReturnValue

abstract fun remove(element: ProtoTaskT?): Boolean

removeAll

@IgnorableReturnValue

abstract fun removeAll(elements: Collection<ProtoTaskT?>): Boolean

retainAll

@IgnorableReturnValue

abstract fun retainAll(elements: Collection<ProtoTaskT?>): Boolean

testTasks

abstract fun testTasks(): ProtoTasks<ProtoTaskT>

Filters tasks by where ProtoTask.Properties.isTest is true.

whenObjectAdded

abstract fun whenObjectAdded(action: Closure<*>?)

abstract fun whenObjectAdded(action: Action<in ProtoTaskT?>?): Action<in ProtoTaskT?>?

whenObjectRemoved

abstract fun whenObjectRemoved(action: Closure<*>?)

abstract fun whenObjectRemoved(action: Action<in ProtoTaskT?>?): Action<in ProtoTaskT?>?

whenTaskAdded

abstract fun whenTaskAdded(closure: Closure<*>?)

abstract fun whenTaskAdded(action: Action<in ProtoTaskT?>?): Action<in ProtoTaskT?>?

withType

abstract fun <S : ProtoTaskT?> withType(type: Class<S?>?): TaskCollection<S?>?

abstract fun <S : ProtoTaskT?> withType(type: Class<S?>?, @DelegatesTo(genericTypeIndex = 0) configureClosure: Closure<*>?): DomainObjectCollection<S?>?

abstract fun <S : ProtoTaskT?> withType(type: Class<S?>?, configureAction: Action<in S?>?): DomainObjectCollection<S?>?