Konsist 0.17.0/com.lemonappdev.konsist.api.provider/KoAnnotationProvider

KoAnnotationProvider

interface KoAnnotationProvider : KoBaseProvider

An interface representing a Kotlin declaration that provides an annotations.

Inheritors

Properties

Link copied to clipboard
abstract val annotations: List<KoAnnotationDeclaration>

List of annotations.

Link copied to clipboard
abstract val numAnnotations: Int

The number of annotations.

Functions

Link copied to clipboard
abstract fun countAnnotations(predicate: (KoAnnotationDeclaration) -> Boolean): Int

Returns the number of annotations that satisfies the specified predicate present in the declaration.

Link copied to clipboard
abstract fun hasAllAnnotations(predicate: (KoAnnotationDeclaration) -> Boolean): Boolean

Determines whether the declaration has all annotations that satisfy the provided predicate.

Link copied to clipboard
abstract fun hasAllAnnotationsOf(names: Collection<KClass<*>>): Boolean
abstract fun hasAllAnnotationsOf(name: KClass<*>, vararg names: KClass<*>): Boolean

Determines whether the declaration has annotations with all the specified KClass type.

Link copied to clipboard
abstract fun hasAnnotation(predicate: (KoAnnotationDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one annotation that satisfies the provided predicate.

Link copied to clipboard
abstract fun hasAnnotationOf(names: Collection<KClass<*>>): Boolean
abstract fun hasAnnotationOf(name: KClass<*>, vararg names: KClass<*>): Boolean

Determines whether the declaration has at least one annotation of the specified KClass type.

Link copied to clipboard
inline fun <T> KoAnnotationProvider.hasAnnotationOf(): Boolean

Returns true if declaration represents the type of T.

Link copied to clipboard
abstract fun hasAnnotations(): Boolean

Determines whatever declaration has any annotation.

Link copied to clipboard
abstract fun hasAnnotationsWithAllNames(names: Collection<String>): Boolean
abstract fun hasAnnotationsWithAllNames(name: String, vararg names: String): Boolean

Determines whether the declaration has annotations with all the specified names.

Link copied to clipboard
abstract fun hasAnnotationWithName(names: Collection<String>): Boolean
abstract fun hasAnnotationWithName(name: String, vararg names: String): Boolean

Determines whether the declaration has at least one annotation whose name matches any of the specified names.