gradle/org.gradle.api.plugins.quality/CheckstyleReports

CheckstyleReports

interface CheckstyleReports : ReportContainer<T> (source)

The reporting configuration for the Checkstyle task.

Functions

abstract fun add(e: T): Boolean

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

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

abstract fun addLater(provider: Provider<out T>)

abstract fun addRule(rule: Rule): Rule

abstract fun all(action: Action<in T>)

abstract fun clear()

abstract fun configure(cl: Closure): T

abstract fun configureEach(action: Action<in T>)

abstract fun contains(p: Any): Boolean

abstract fun containsAll(p: Collection<out Any>): Boolean

open fun <E> copyOf(coll: Collection<out E>): Set<E>

abstract fun equals(p: Any): Boolean

abstract fun findAll(spec: Closure): Collection<T>

abstract fun findAll(spec: Closure): Set<T>

abstract fun findByName(name: String): T

open fun forEach(action: Consumer<in T>)

operator fun <T : Any> NamedDomainObjectCollection<T>.get(name: String): T

Locates an object by name, failing if there is no such object.

abstract fun getAsMap(): SortedMap<String, T>

abstract fun getAt(name: String): T

abstract fun getByName(name: String): T

inline fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String): T

Locates an object by name and casts it to the expected type T.

inline fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, configure: T.() -> Unit): T

Locates an object by name and casts it to the expected type T then configures it.

fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, type: KClass<T>): T

Locates an object by name and casts it to the expected type.

fun <T : Any> NamedDomainObjectCollection<out Any>.getByName(name: String, type: KClass<T>, configure: T.() -> Unit): T

Locates an object by name and casts it to the expected type then configures it.

getCollectionSchema

abstract fun getCollectionSchema(): NamedDomainObjectCollectionSchema

abstract fun getEnabled(): NamedDomainObjectSet<T>

getEnabledReports

abstract fun getEnabledReports(): Map<String, T>

abstract fun getHtml(): CustomizableHtmlReport

The checkstyle HTML report.

abstract fun getNamer(): Namer<T>

abstract fun getNames(): SortedSet<String>

abstract fun getRules(): List<Rule>

abstract fun getSarif(): SingleFileReport

The checkstyle SARIF report This report is NOT enabled by default.

abstract fun getXml(): SingleFileReport

The checkstyle XML report This report IS enabled by default.

abstract fun hashCode(): Int

abstract fun isEmpty(): Boolean

abstract fun iterator(): Iterator<T>

abstract fun iterator(): Iterator<E>

abstract fun matching(spec: Spec<in T>): DomainObjectCollection<T>

abstract fun matching(spec: Spec<in T>): DomainObjectSet<T>

abstract fun matching(spec: Spec<in T>): NamedDomainObjectCollection<T>

abstract fun matching(spec: Spec<in T>): NamedDomainObjectSet<T>

abstract fun named(name: String): NamedDomainObjectProvider<T>

open fun named(nameFilter: Spec<String>): NamedDomainObjectCollection<T>

abstract fun <S : T?> named(name: String, type: Class<S>): NamedDomainObjectProvider<S>

abstract fun named(nameFilter: Spec<String>): NamedDomainObjectSet<T>

inline fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String): NamedDomainObjectProvider<T>

fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, type: KClass<T>): NamedDomainObjectProvider<T>

Locates an object by name and type, without triggering its creation or configuration, failing if there is no such object.

inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.named(name: String, type: KClass<S>): NamedDomainObjectProvider<S>

inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.named(name: String, type: KClass<S>, configurationAction: Action<in S>): NamedDomainObjectProvider<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectCollection.named.

inline fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, noinline configuration: T.() -> Unit): NamedDomainObjectProvider<T>

fun <T : Any> NamedDomainObjectCollection<out Any>.named(name: String, type: KClass<T>, configuration: T.() -> Unit): NamedDomainObjectProvider<T>

Configures an object by name and type, without triggering its creation or configuration, failing if there is no such object.

open fun <E> of(): Set<E>

open fun parallelStream(): Stream<E>

provideDelegate

operator fun <T : Any> NamedDomainObjectCollection<T>.provideDelegate(thisRef: Any?, property: KProperty<*>): NamedDomainObjectProvider<T>

Allows a NamedDomainObjectCollection to be used as a property delegate.

abstract fun remove(p: Any): Boolean

abstract fun removeAll(p: Collection<out Any>): Boolean

open fun removeIf(filter: Predicate<in E>): Boolean

abstract fun retainAll(p: Collection<out Any>): Boolean

abstract fun size(): Int

open fun spliterator(): Spliterator<T>

open fun spliterator(): Spliterator<E>

open fun stream(): Stream<E>

abstract fun toArray(): Array<Any>

abstract fun <T> toArray(p: Array<T>): Array<T>

whenObjectAdded

abstract fun whenObjectAdded(action: Closure)

abstract fun whenObjectAdded(action: Action<in T>): Action<in T>

whenObjectRemoved

abstract fun whenObjectRemoved(action: Closure)

abstract fun whenObjectRemoved(action: Action<in T>): Action<in T>

abstract fun <S : T?> withType(type: Class<S>): DomainObjectCollection<S>

abstract fun <S : T?> withType(type: Class<S>): DomainObjectSet<S>

abstract fun <S : T?> withType(type: Class<S>): NamedDomainObjectCollection<S>

abstract fun <S : T?> withType(type: Class<S>): NamedDomainObjectSet<S>

inline fun <S : Any> DomainObjectCollection<in S>.withType(): DomainObjectCollection<S>

inline fun <S : Any> NamedDomainObjectCollection<in S>.withType(): NamedDomainObjectCollection<S>

Returns a collection containing the objects in this collection of the given type. The returned collection is live, so that when matching objects are later added to this collection, they are also visible in the filtered collection.

inline fun <S : Any> DomainObjectCollection<in S>.withType(noinline configuration: S.() -> Unit): DomainObjectCollection<S>

Returns a collection containing the objects in this collection of the given type. Equivalent to calling withType(type).all(configureAction).

inline fun <S : T, T : Any> DomainObjectCollection<T>.withType(type: KClass<S>): DomainObjectCollection<S>

inline fun <S : T, T : Any> DomainObjectCollection<T>.withType(type: KClass<S>, configureAction: Action<in S>): DomainObjectCollection<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.DomainObjectCollection.withType.

inline fun <S : T, T : Any> DomainObjectSet<T>.withType(type: KClass<S>): DomainObjectSet<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.DomainObjectSet.withType.

inline fun <S : T, T : Any> NamedDomainObjectCollection<T>.withType(type: KClass<S>): NamedDomainObjectCollection<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectCollection.withType.

inline fun <S : T, T : Any> NamedDomainObjectSet<T>.withType(type: KClass<S>): NamedDomainObjectSet<S>

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.NamedDomainObjectSet.withType.