Konsist 0.17.0/com.lemonappdev.konsist.api.declaration.combined/KoInterfaceAndObjectDeclaration

KoInterfaceAndObjectDeclaration

interface KoInterfaceAndObjectDeclaration : KoClassAndInterfaceAndObjectDeclaration

Represents a Kotlin interface or object declaration.

Inheritors

KoInterfaceDeclaration

KoObjectDeclaration

Properties

annotations

abstract val annotations: List<KoAnnotationDeclaration>

List of annotations.

containingDeclaration

abstract val containingDeclaration: KoBaseDeclaration

The parent of the declaration.

containingFile

abstract val containingFile: KoFileDeclaration

File containing the declaration.

fullyQualifiedName

abstract val fullyQualifiedName: String?

Fully qualified name of the declaration.

hasInternalModifier

abstract val hasInternalModifier: Boolean

Determines whatever the declaration has internal modifier.

hasKDoc

abstract val hasKDoc: Boolean

Determines whatever the declaration has kDoc.

hasPrivateModifier

abstract val hasPrivateModifier: Boolean

Determines whatever the declaration has private modifier.

hasProtectedModifier

abstract val hasProtectedModifier: Boolean

Determines whatever the declaration has protected modifier.

hasPublicModifier

abstract val hasPublicModifier: Boolean

Determines whatever the declaration has public modifier.

hasPublicOrDefaultModifier

abstract val hasPublicOrDefaultModifier: Boolean

Determines whatever the declaration has public or no visibility modifier.

isTopLevel

abstract val isTopLevel: Boolean

Determines whatever the declaration is defined at top level.

kDoc

abstract val kDoc: KoKDocDeclaration?

Documentation of the declaration.

location

abstract val location: String

Location of the declaration containing the file path, line and column.

locationWithText

abstract val locationWithText: String

Text of the declaration with the location (file path, line and column).

modifiers

abstract val modifiers: List<KoModifier>

List of modifiers.

moduleName

abstract val moduleName: String

The declaration's module name.

name

abstract val name: String

Name of the declaration.

numAnnotations

abstract val numAnnotations: Int

The number of annotations.

numModifiers

abstract val numModifiers: Int

The number of modifiers.

packagee

abstract val packagee: KoPackageDeclaration?

Package of the declaration.

path

abstract val path: String

File path of the declaration or path of the file.

projectPath

abstract val projectPath: String

Project file path of the declaration or root project path of the file.

sourceSetName

abstract val sourceSetName: String

The declaration's source set name.

text

abstract val text: String

Text of the declaration.

Functions

classes

abstract fun classes(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoClassDeclaration>

The classes present in the declaration.

classesAndInterfaces

abstract fun classesAndInterfaces(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoClassAndInterfaceDeclaration>

The classes and interfaces present in the declaration.

classesAndInterfacesAndObjects

abstract fun classesAndInterfacesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoClassAndInterfaceAndObjectDeclaration>

The classes, interfaces and objects present in the declaration.

classesAndObjects

abstract fun classesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoClassAndObjectDeclaration>

The classes and objects present in the declaration.

countAnnotations

abstract fun countAnnotations(predicate: (KoAnnotationDeclaration) -> Boolean): Int

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

countClasses

abstract fun countClasses(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassDeclaration) -> Boolean): Int

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

countClassesAndInterfaces

abstract fun countClassesAndInterfaces(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndInterfaceDeclaration) -> Boolean): Int

Returns the number of classes and interfaces that satisfies the specified predicate present in the declaration.

countClassesAndInterfacesAndObjects

abstract fun countClassesAndInterfacesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndInterfaceAndObjectDeclaration) -> Boolean): Int

Returns the number of classes, interfaces and objects that satisfies the specified predicate present in the declaration.

countClassesAndObjects

abstract fun countClassesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndObjectDeclaration) -> Boolean): Int

Returns the number of classes and objects that satisfies the specified predicate present in the declaration.

countDeclarations

abstract fun countDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoBaseDeclaration) -> Boolean): Int

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

countExternalParents

abstract fun countExternalParents(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Int

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

countFunctions

abstract fun countFunctions(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoFunctionDeclaration) -> Boolean): Int

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

countInterfaces

abstract fun countInterfaces(includeNested: Boolean = true, predicate: (KoInterfaceDeclaration) -> Boolean): Int

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

countInterfacesAndObjects

abstract fun countInterfacesAndObjects(includeNested: Boolean = true, predicate: (KoInterfaceAndObjectDeclaration) -> Boolean): Int

Returns the number of interfaces and objects that satisfies the specified predicate present in the declaration.

countObjects

abstract fun countObjects(includeNested: Boolean = true, predicate: (KoObjectDeclaration) -> Boolean): Int

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

countParentInterfaces

abstract fun countParentInterfaces(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Int

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

countParents

abstract fun countParents(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Int

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

countProperties

abstract fun countProperties(includeNested: Boolean = true, predicate: (KoPropertyDeclaration) -> Boolean): Int

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

declarations

abstract fun declarations(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoBaseDeclaration>

The declarations present in the declaration.

declarationsOf

inline fun <T : KoBaseProvider> KoDeclarationProvider.declarationsOf(includeNested: Boolean = true, includeLocal: Boolean = true): List<T>

The declarations of type T present in the declaration.

externalParents

abstract fun externalParents(indirectParents: Boolean = false): List<KoParentDeclaration>

List containing external parents of the declaration.

functions

abstract fun functions(includeNested: Boolean = true, includeLocal: Boolean = true): List<KoFunctionDeclaration>

The functions present in the declaration.

hasAllAnnotations

abstract fun hasAllAnnotations(predicate: (KoAnnotationDeclaration) -> Boolean): Boolean

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

hasAllAnnotationsOf

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.

hasAllClasses

abstract fun hasAllClasses(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassDeclaration) -> Boolean): Boolean

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

hasAllClassesAndInterfaces

abstract fun hasAllClassesAndInterfaces(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndInterfaceDeclaration) -> Boolean): Boolean

Determines whether the declaration has all classes and interfaces that satisfy the provided predicate.

hasAllClassesAndInterfacesAndObjects

abstract fun hasAllClassesAndInterfacesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndInterfaceAndObjectDeclaration) -> Boolean): Boolean

Determines whether the declaration has all classes, interfaces and objects that satisfy the provided predicate.

hasAllClassesAndObjects

abstract fun hasAllClassesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndObjectDeclaration) -> Boolean): Boolean

Determines whether the declaration has all classes and objects that satisfy the provided predicate.

hasAllDeclarations

abstract fun hasAllDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoBaseDeclaration) -> Boolean): Boolean

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

hasAllExternalParents

abstract fun hasAllExternalParents(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Boolean

Determines whether the declaration has all external parents that satisfy the provided predicate.

hasAllExternalParentsOf

abstract fun hasAllExternalParentsOf(names: Collection<KClass<*>>, indirectParents: Boolean = false): Boolean

abstract fun hasAllExternalParentsOf(name: KClass<*>, vararg names: KClass<*>, indirectParents: Boolean = false): Boolean

Determines whether the declaration has external parents with all the specified KClass type.

hasAllFunctions

abstract fun hasAllFunctions(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoFunctionDeclaration) -> Boolean): Boolean

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

hasAllInterfaces

abstract fun hasAllInterfaces(includeNested: Boolean = true, predicate: (KoInterfaceDeclaration) -> Boolean): Boolean

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

hasAllInterfacesAndObjects

abstract fun hasAllInterfacesAndObjects(includeNested: Boolean = true, predicate: (KoInterfaceAndObjectDeclaration) -> Boolean): Boolean

Determines whether the declaration has all interfaces and objects that satisfy the provided predicate.

hasAllModifiers

abstract fun hasAllModifiers(modifiers: Collection<KoModifier>): Boolean

abstract fun hasAllModifiers(modifier: KoModifier, vararg modifiers: KoModifier): Boolean

Determines whether the declaration has all specified modifiers.

hasAllObjects

abstract fun hasAllObjects(includeNested: Boolean = true, predicate: (KoObjectDeclaration) -> Boolean): Boolean

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

hasAllParentInterfaces

abstract fun hasAllParentInterfaces(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Boolean

Determines whether the declaration has all parent interfaces that satisfy the provided predicate.

hasAllParentInterfacesOf

abstract fun hasAllParentInterfacesOf(names: Collection<KClass<*>>, indirectParents: Boolean = false): Boolean

abstract fun hasAllParentInterfacesOf(name: KClass<*>, vararg names: KClass<*>, indirectParents: Boolean = false): Boolean

Determines whether the declaration has parent interfaces with all the specified KClass type.

hasAllParents

abstract fun hasAllParents(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Boolean

Determines whether the declaration has all parents (parent classes and parent interfaces) that satisfy the provided predicate.

hasAllParentsOf

abstract fun hasAllParentsOf(names: Collection<KClass<*>>, indirectParents: Boolean = false): Boolean

abstract fun hasAllParentsOf(name: KClass<*>, vararg names: KClass<*>, indirectParents: Boolean = false): Boolean

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

hasAllProperties

abstract fun hasAllProperties(includeNested: Boolean = true, predicate: (KoPropertyDeclaration) -> Boolean): Boolean

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

hasAnnotation

abstract fun hasAnnotation(predicate: (KoAnnotationDeclaration) -> Boolean): Boolean

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

hasAnnotationOf

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.

hasAnnotationOf

inline fun <T> KoAnnotationProvider.hasAnnotationOf(): Boolean

Returns true if declaration represents the type of T.

hasAnnotations

abstract fun hasAnnotations(): Boolean

Determines whatever declaration has any annotation.

hasAnnotationsWithAllNames

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.

hasAnnotationWithName

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.

hasClass

abstract fun hasClass(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassDeclaration) -> Boolean): Boolean

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

hasClasses

abstract fun hasClasses(includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whatever the declaration has classes.

hasClassesAndInterfacesAndObjectsWithAllNames

abstract fun hasClassesAndInterfacesAndObjectsWithAllNames(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasClassesAndInterfacesAndObjectsWithAllNames(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whether the declaration has classes, interfaces and objects with all the specified names.

hasClassesAndInterfacesWithAllNames

abstract fun hasClassesAndInterfacesWithAllNames(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasClassesAndInterfacesWithAllNames(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whether the declaration has classes and interfaces with all the specified names.

hasClassesAndObjectsWithAllNames

abstract fun hasClassesAndObjectsWithAllNames(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasClassesAndObjectsWithAllNames(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whether the declaration has classes and objects with all the specified names.

hasClassesOrInterfaces

abstract fun hasClassesOrInterfaces(includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whatever the declaration has classes and interfaces.

hasClassesOrInterfacesOrObjects

abstract fun hasClassesOrInterfacesOrObjects(includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whatever the declaration has classes, interfaces and objects.

hasClassesOrObjects

abstract fun hasClassesOrObjects(includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whatever the declaration has classes and objects.

hasClassesWithAllNames

abstract fun hasClassesWithAllNames(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasClassesWithAllNames(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

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

hasClassOrInterface

abstract fun hasClassOrInterface(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndInterfaceDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one class or interface that satisfies the provided predicate.

hasClassOrInterfaceOrObject

abstract fun hasClassOrInterfaceOrObject(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndInterfaceAndObjectDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one class, interface or object that satisfies the provided predicate.

hasClassOrInterfaceOrObjectWithName

abstract fun hasClassOrInterfaceOrObjectWithName(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasClassOrInterfaceOrObjectWithName(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whether the declaration has at least one class, interface or object whose name matches any of the specified names.

hasClassOrInterfaceWithName

abstract fun hasClassOrInterfaceWithName(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasClassOrInterfaceWithName(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

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

hasClassOrObject

abstract fun hasClassOrObject(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoClassAndObjectDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one class or object that satisfies the provided predicate.

hasClassOrObjectWithName

abstract fun hasClassOrObjectWithName(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasClassOrObjectWithName(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

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

hasClassWithName

abstract fun hasClassWithName(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasClassWithName(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

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

hasDeclaration

abstract fun hasDeclaration(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoBaseDeclaration) -> Boolean): Boolean

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

hasDeclarations

abstract fun hasDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whatever the declaration has declarations.

hasExternalParent

abstract fun hasExternalParent(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Boolean

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

hasExternalParentOf

abstract fun hasExternalParentOf(names: Collection<KClass<*>>, indirectParents: Boolean = false): Boolean

abstract fun hasExternalParentOf(name: KClass<*>, vararg names: KClass<*>, indirectParents: Boolean = false): Boolean

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

hasExternalParentOf

inline fun <T> KoExternalParentProvider.hasExternalParentOf(): Boolean

Returns true if declaration represents the type of T. The external parent is a parent defined outside the project codebase (defined inside external library).

hasExternalParents

abstract fun hasExternalParents(indirectParents: Boolean = false): Boolean

Determines whatever declaration has any external parents. The external parent is a parent defined outside project codebase (defined inside external library).

hasExternalParentsWithAllNames

abstract fun hasExternalParentsWithAllNames(names: Collection<String>, indirectParents: Boolean = false): Boolean

abstract fun hasExternalParentsWithAllNames(name: String, vararg names: String, indirectParents: Boolean = false): Boolean

Determines whether the declaration has parents interface defined project codebase (external == false)

hasExternalParentWithName

abstract fun hasExternalParentWithName(names: Collection<String>, indirectParents: Boolean = false): Boolean

abstract fun hasExternalParentWithName(name: String, vararg names: String, indirectParents: Boolean = false): Boolean

Determines whether the declaration has at least one external parent whose name matches any of the specified.

hasFunction

abstract fun hasFunction(includeNested: Boolean = true, includeLocal: Boolean = true, predicate: (KoFunctionDeclaration) -> Boolean): Boolean

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

hasFunctions

abstract fun hasFunctions(includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

Determines whatever the declaration has functions.

hasFunctionsWithAllNames

abstract fun hasFunctionsWithAllNames(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasFunctionsWithAllNames(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

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

hasFunctionWithName

abstract fun hasFunctionWithName(names: Collection<String>, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

abstract fun hasFunctionWithName(name: String, vararg names: String, includeNested: Boolean = true, includeLocal: Boolean = true): Boolean

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

hasInterface

abstract fun hasInterface(includeNested: Boolean = true, predicate: (KoInterfaceDeclaration) -> Boolean): Boolean

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

hasInterfaceOrObject

abstract fun hasInterfaceOrObject(includeNested: Boolean = true, predicate: (KoInterfaceAndObjectDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one interface or object that satisfies the provided predicate.

hasInterfaceOrObjectWithName

abstract fun hasInterfaceOrObjectWithName(names: Collection<String>, includeNested: Boolean = true): Boolean

abstract fun hasInterfaceOrObjectWithName(name: String, vararg names: String, includeNested: Boolean = true): Boolean

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

hasInterfaces

abstract fun hasInterfaces(includeNested: Boolean = true): Boolean

Determines whatever the declaration has interfaces.

hasInterfacesAndObjectsWithAllNames

abstract fun hasInterfacesAndObjectsWithAllNames(names: Collection<String>, includeNested: Boolean = true): Boolean

abstract fun hasInterfacesAndObjectsWithAllNames(name: String, vararg names: String, includeNested: Boolean = true): Boolean

Determines whether the declaration has interfaces and objects with all the specified names.

hasInterfacesOrObjects

abstract fun hasInterfacesOrObjects(includeNested: Boolean = true): Boolean

Determines whatever the declaration has interfaces and objects.

hasInterfacesWithAllNames

abstract fun hasInterfacesWithAllNames(names: Collection<String>, includeNested: Boolean = true): Boolean

abstract fun hasInterfacesWithAllNames(name: String, vararg names: String, includeNested: Boolean = true): Boolean

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

hasInterfaceWithName

abstract fun hasInterfaceWithName(names: Collection<String>, includeNested: Boolean = true): Boolean

abstract fun hasInterfaceWithName(name: String, vararg names: String, includeNested: Boolean = true): Boolean

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

hasModifier

abstract fun hasModifier(modifiers: Collection<KoModifier>): Boolean

abstract fun hasModifier(modifier: KoModifier, vararg modifiers: KoModifier): Boolean

Determines whether the declaration has at least one specified modifier.

hasModifiers

abstract fun hasModifiers(): Boolean

Determines whatever the declaration has modifiers.

hasNameContaining

abstract fun hasNameContaining(text: String): Boolean

Name of the declaration containing text.

hasNameEndingWith

abstract fun hasNameEndingWith(suffix: String): Boolean

Name of the declaration with suffix.

hasNameMatching

abstract fun hasNameMatching(regex: Regex): Boolean

Name of the declaration matching regex.

hasNameStartingWith

abstract fun hasNameStartingWith(prefix: String): Boolean

Name of the declaration with prefix.

hasObject

abstract fun hasObject(includeNested: Boolean = true, predicate: (KoObjectDeclaration) -> Boolean): Boolean

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

hasObjects

abstract fun hasObjects(includeNested: Boolean = true): Boolean

Determines whatever the declaration has objects.

hasObjectsWithAllNames

abstract fun hasObjectsWithAllNames(names: Collection<String>, includeNested: Boolean = true): Boolean

abstract fun hasObjectsWithAllNames(name: String, vararg names: String, includeNested: Boolean = true): Boolean

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

hasObjectWithName

abstract fun hasObjectWithName(names: Collection<String>, includeNested: Boolean = true): Boolean

abstract fun hasObjectWithName(name: String, vararg names: String, includeNested: Boolean = true): Boolean

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

hasParent

abstract fun hasParent(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Boolean

Determines whether the declaration has at least one parent (parent class or parent interface) that satisfies the provided predicate.

hasParentInterface

abstract fun hasParentInterface(indirectParents: Boolean = false, predicate: (KoParentDeclaration) -> Boolean): Boolean

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

hasParentInterfaceOf

abstract fun hasParentInterfaceOf(names: Collection<KClass<*>>, indirectParents: Boolean = false): Boolean

abstract fun hasParentInterfaceOf(name: KClass<*>, vararg names: KClass<*>, indirectParents: Boolean = false): Boolean

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

hasParentInterfaceOf

inline fun <T> KoParentInterfaceProvider.hasParentInterfaceOf(): Boolean

Returns true if declaration represents the type of T.

hasParentInterfaces

abstract fun hasParentInterfaces(indirectParents: Boolean = false): Boolean

Determines whatever declaration has any parent interface.

hasParentInterfacesWithAllNames

abstract fun hasParentInterfacesWithAllNames(names: Collection<String>, indirectParents: Boolean = false): Boolean

abstract fun hasParentInterfacesWithAllNames(name: String, vararg names: String, indirectParents: Boolean = false): Boolean

Determines whether the declaration has parent interfaces defined with all the specified names.

hasParentInterfaceWithName

abstract fun hasParentInterfaceWithName(names: Collection<String>, indirectParents: Boolean = false): Boolean

abstract fun hasParentInterfaceWithName(name: String, vararg names: String, indirectParents: Boolean = false): Boolean

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

hasParentOf

abstract fun hasParentOf(names: Collection<KClass<*>>, indirectParents: Boolean = false): Boolean

abstract fun hasParentOf(name: KClass<*>, vararg names: KClass<*>, indirectParents: Boolean = false): Boolean

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

hasParentOf

inline fun <T> KoParentProvider.hasParentOf(): Boolean

Returns true if declaration represents the type of T.

hasParents

abstract fun hasParents(indirectParents: Boolean = false): Boolean

Determines whatever declaration has any parent (parent class and parent interfaces).

hasParentsWithAllNames

abstract fun hasParentsWithAllNames(names: Collection<String>, indirectParents: Boolean = false): Boolean

abstract fun hasParentsWithAllNames(name: String, vararg names: String, indirectParents: Boolean = false): Boolean

Determines whether the declaration has parents (parent classes and parent interfaces) with all the specified names.

hasParentWithName

abstract fun hasParentWithName(names: Collection<String>, indirectParents: Boolean = false): Boolean

abstract fun hasParentWithName(name: String, vararg names: String, indirectParents: Boolean = false): Boolean

Determines whether the declaration has at least one parent (parent class and parent interfaces) whose name matches any of the specified names.

hasProperties

abstract fun hasProperties(includeNested: Boolean = true): Boolean

Determines whatever the declaration has properties.

hasPropertiesWithAllNames

abstract fun hasPropertiesWithAllNames(names: Collection<String>, includeNested: Boolean = true): Boolean

abstract fun hasPropertiesWithAllNames(name: String, vararg names: String, includeNested: Boolean = true): Boolean

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

hasProperty

abstract fun hasProperty(includeNested: Boolean = true, predicate: (KoPropertyDeclaration) -> Boolean): Boolean

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

hasPropertyWithName

abstract fun hasPropertyWithName(names: Collection<String>, includeNested: Boolean = true): Boolean

abstract fun hasPropertyWithName(name: String, vararg names: String, includeNested: Boolean = true): Boolean

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

hasTextContaining

abstract fun hasTextContaining(str: String): Boolean

Text of the declaration containing text.

hasTextEndingWith

abstract fun hasTextEndingWith(suffix: String): Boolean

Text of the declaration with suffix.

hasTextMatching

abstract fun hasTextMatching(regex: Regex): Boolean

Text of the declaration matching regex.

hasTextStartingWith

abstract fun hasTextStartingWith(prefix: String): Boolean

Text of the declaration with prefix.

interfaces

abstract fun interfaces(includeNested: Boolean = true): List<KoInterfaceDeclaration>

The interfaces present in the declaration.

interfacesAndObjects

abstract fun interfacesAndObjects(includeNested: Boolean = true): List<KoInterfaceAndObjectDeclaration>

The interfaces and objects present in the declaration.

numClasses

abstract fun numClasses(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of classes present in the declaration.

numClassesAndInterfaces

abstract fun numClassesAndInterfaces(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of classes and interfaces present in the declaration.

numClassesAndInterfacesAndObjects

abstract fun numClassesAndInterfacesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of classes, interfaces and objects present in the declaration.

numClassesAndObjects

abstract fun numClassesAndObjects(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of classes and objects present in the declaration.

numDeclarations

abstract fun numDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of declarations present in the declaration.

numExternalParents

abstract fun numExternalParents(indirectParents: Boolean = false): Int

Returns the number of external parents.

numFunctions

abstract fun numFunctions(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of functions present in the declaration.

numInterfaces

abstract fun numInterfaces(includeNested: Boolean = true): Int

Returns the number of interfaces present in the declaration.

numInterfacesAndObjects

abstract fun numInterfacesAndObjects(includeNested: Boolean = true): Int

Returns the number of interfaces and objects present in the declaration.

numInternalDeclarations

abstract fun numInternalDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of declarations with internal visibility modifier present in the declaration.

numObjects

abstract fun numObjects(includeNested: Boolean = true): Int

Returns the number of objects present in the declaration.

numParentInterfaces

abstract fun numParentInterfaces(indirectParents: Boolean = false): Int

Returns the number of parent interfaces.

numParents

abstract fun numParents(indirectParents: Boolean = false): Int

Returns the number of parents.

numPrivateDeclarations

abstract fun numPrivateDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of declarations with private visibility modifier present in the declaration.

numProperties

abstract fun numProperties(includeNested: Boolean = true): Int

Returns the number of properties present in the declaration.

numProtectedDeclarations

abstract fun numProtectedDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of declarations with protected visibility modifier present in the declaration.

numPublicDeclarations

abstract fun numPublicDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of declarations with public visibility modifier present in the declaration.

numPublicOrDefaultDeclarations

abstract fun numPublicOrDefaultDeclarations(includeNested: Boolean = true, includeLocal: Boolean = true): Int

Returns the number of declarations with public or default visibility modifier present in the declaration.

objects

abstract fun objects(includeNested: Boolean = true): List<KoObjectDeclaration>

The objects present in the declaration.

parentInterfaces

abstract fun parentInterfaces(indirectParents: Boolean = false): List<KoParentDeclaration>

The parent interfaces of the declaration.

parents

abstract fun parents(indirectParents: Boolean = false): List<KoParentDeclaration>

The parents (parent class and parent interfaces) of the declaration.

properties

abstract fun properties(includeNested: Boolean = true): List<KoPropertyDeclaration>

The properties present in the declaration.

representsType

abstract fun representsType(name: String?): Boolean

Determines whatever this declaration represents the specified type.

representsTypeOf

inline fun <T> KoRepresentsTypeProvider.representsTypeOf(): Boolean

Returns true if declaration represents the type of T.

resideInModule

abstract fun resideInModule(name: String): Boolean

Determines whatever declaration reside in module.

resideInPackage

abstract fun resideInPackage(name: String): Boolean

Determines whatever the declaration resides in a package.

resideInPath

abstract fun resideInPath(path: String, absolutePath: Boolean = false): Boolean

Determines whatever declaration reside in file path or file reside in path.

resideInSourceSet

abstract fun resideInSourceSet(sourceSetName: String): Boolean

Determines whatever declaration reside in source set.

resideOutsidePackage

abstract fun resideOutsidePackage(name: String): Boolean

Determines whatever the declaration resides outside a package.

toString

abstract override fun toString(): String

String representing the declaration.