KtClassLikeDeclaration¶

@SubclassOptInRequired(markerClass = [KtImplementationDetail::class])
interface KtClassLikeDeclaration : KtNamedDeclaration

Represents a declaration that introduces a classifier referable by a ClassId, namely a class, interface, object, or type alias.

This is the common base type for KtClassOrObject and KtTypeAlias. It abstracts over "how a classifier is addressed" rather than "how it is defined", which is why its central capability is getClassId.

Inheritors¶

Properties¶

`allChildren`¶

val PsiElement.allChildren: PsiChildRange

The range of all direct children of this element, or an empty range if it has none.

`annotationEntries`¶

@get:NotNull
abstract val annotationEntries: List<KtAnnotationEntry?>

`annotations`¶

@get:NotNull
abstract val annotations: List<KtAnnotation?>

`children`¶

@get:Contract(pure = true)
@get:NotNull
abstract val children: @NotNull Array<out @NotNull PsiElement>

`containingClassId`¶

val KtDeclaration.containingClassId: ClassId?

The containing ClassId for this declaration. REPL KtScripts are supported.

`containingClassOrObject`¶

val KtDeclaration.containingClassOrObject: KtClassOrObject?

The class or object that declares this declaration as a member (including constructors and nested classes), or null if it is not a class member — for example, a member function's parameter or local, or a property accessor.

`containingClassOrScript`¶

val KtDeclaration.containingClassOrScript: KtNamedDeclaration?

The containing class or script for a declaration.

`containingFile`¶

@get:Contract(pure = true)
abstract val containingFile: PsiFile?

`containingKtFile`¶

@get:NotNull
abstract val containingKtFile: KtFile

`containingScript`¶

val KtDeclaration.containingScript: KtScript?

The containing script for top-level declarations.

`context`¶

@get:Nullable
@get:Contract(pure = true)
abstract val context: @Nullable PsiElement?

`docComment`¶

@get:Nullable
abstract val docComment: KDoc?

`endOffset`¶

val PsiElement.endOffset: Int

The offset just past the end of this element's text range in the file.

`firstChild`¶

@get:Contract(pure = true)
abstract val firstChild: PsiElement?

`fqName`¶

@get:Nullable
abstract val fqName: FqName?

`identifyingElement`¶

@get:Nullable
open val identifyingElement: @Nullable PsiElement?

`isFromCompanionBlock`¶

val KtDeclaration.isFromCompanionBlock: Boolean

Whether this declaration is declared inside a companion object block.

`isPhysical`¶

@get:Contract(pure = true)
abstract val isPhysical: Boolean

`isPrivateNestedClassOrObject`¶

val KtNamedDeclaration.isPrivateNestedClassOrObject: Boolean

true if this is a private nested (non-top-level) class or object.

`isPublic`¶

val KtModifierListOwner.isPublic: Boolean

true if this declaration is effectively public (no visibility modifier or an explicit public), and not local.

`isValid`¶

@get:Contract(pure = true)
abstract val isValid: Boolean

`isWritable`¶

@get:Contract(pure = true)
abstract val isWritable: Boolean

`language`¶

@get:NotNull
@get:Contract(pure = true)
abstract val language: @NotNull Language

`lastChild`¶

@get:Contract(pure = true)
abstract val lastChild: PsiElement?

`manager`¶

@get:Contract(pure = true)
abstract val manager: PsiManager?

`modifierList`¶

@get:Nullable
abstract val modifierList: KtModifierList?

`name`¶

@get:Nullable
@get:NlsSafe
abstract override val name: @Nullable @NlsSafe String?

`nameAsName`¶

@get:Nullable
abstract val nameAsName: Name?

`nameAsSafeName`¶

@get:NotNull
abstract val nameAsSafeName: Name

`nameIdentifier`¶

@get:Nullable
abstract val nameIdentifier: @Nullable PsiElement?

`navigationElement`¶

@get:Contract(pure = true)
abstract val navigationElement: PsiElement?

`nextLeafs`¶

val PsiElement.nextLeafs: Sequence<PsiElement>

The following leaf elements as a lazy sequence, nearest first.

`nextSibling`¶

@get:Contract(pure = true)
abstract val nextSibling: PsiElement?

`node`¶

@get:Contract(pure = true)
abstract val node: ASTNode?

`originalElement`¶

@get:Contract(pure = true)
abstract val originalElement: PsiElement?

`ownDeclarations`¶

@get:NotNull
open val ownDeclarations: @NotNull Collection<out @NotNull PsiSymbolDeclaration>

`ownReferences`¶

@get:NotNull
open val ownReferences: @NotNull Collection<out @NotNull PsiSymbolReference>

`parent`¶

@get:Contract(pure = true)
abstract override val parent: PsiElement?

`parents`¶

val PsiElement.parents: Sequence<PsiElement>

The ancestors of this element, from its immediate parent up to and including the containing file.

`parentsWithSelf`¶

val PsiElement.parentsWithSelf: Sequence<PsiElement>

This element and its ancestors, from the element itself up to and including the containing file.

`presentation`¶

@get:Nullable
abstract val presentation: @Nullable ItemPresentation?

`prevLeafs`¶

val PsiElement.prevLeafs: Sequence<PsiElement>

The preceding leaf elements as a lazy sequence, nearest first.

`prevSibling`¶

@get:Contract(pure = true)
abstract val prevSibling: PsiElement?

`project`¶

@get:NotNull
@get:Contract(pure = true)
abstract val project: @NotNull Project

`psiOrParent`¶

@get:NotNull
abstract val psiOrParent: KtElement

`pureEndOffset`¶

val KtPureElement.pureEndOffset: Int

The end offset of this element's source.

`pureStartOffset`¶

val KtPureElement.pureStartOffset: Int

The start offset of this element's source, excluding any leading comments.

reference¶

abstract override val reference: PsiReference?

`references`¶

@get:Contract(pure = true)
abstract val references: @NotNull Array<out PsiReference?>

`resolveScope`¶

@get:NotNull
@get:Contract(pure = true)
abstract val resolveScope: @NotNull GlobalSearchScope

`startOffset`¶

val PsiElement.startOffset: Int

The offset of the start of this element's text range in the file.

`startOffsetInParent`¶

@get:Contract(pure = true)
abstract val startOffsetInParent: Int

`startOffsetSkippingComments`¶

val PsiElement.startOffsetSkippingComments: Int

The start offset of this element, skipping leading comments and the whitespace that follows them.

`text`¶

@get:Contract(pure = true)
@get:NlsSafe
abstract val text: @NlsSafe String?

`textLength`¶

@get:Contract(pure = true)
abstract val textLength: Int

`textOffset`¶

@get:Contract(pure = true)
abstract val textOffset: Int

`textRange`¶

@get:Contract(pure = true)
abstract val textRange: TextRange?

`textRangeInParent`¶

@get:Contract(pure = true)
@get:NotNull
open val textRangeInParent: @NotNull TextRange

`textRangeWithoutComments`¶

val PsiElement.textRangeWithoutComments: TextRange

The text range of this element excluding any leading comments.

`useScope`¶

@get:NotNull
@get:Contract(pure = true)
abstract val useScope: @NotNull SearchScope

Functions¶

`accept`¶

abstract fun accept(p0: @NotNull PsiElementVisitor)

abstract fun <R, D> accept(@NotNull visitor: KtVisitor<R, D>, data: D): R

Dispatches this element to the corresponding visit* method of the given visitor and returns its result.

`acceptChildren`¶

abstract fun acceptChildren(p0: @NotNull PsiElementVisitor)

abstract fun <D> acceptChildren(visitor: KtVisitor<Void, D>, data: D)

Passes each direct child of this element to the given visitor.

`add`¶

abstract fun add(p0: @NotNull PsiElement): PsiElement?

`addAfter`¶

abstract fun addAfter(p0: @NotNull PsiElement, p1: @Nullable PsiElement?): PsiElement?

`addBefore`¶

abstract fun addBefore(p0: @NotNull PsiElement, p1: @Nullable PsiElement?): PsiElement?

`addRange`¶

abstract fun addRange(p0: PsiElement?, p1: PsiElement?): PsiElement?

`addRangeAfter`¶

abstract fun addRangeAfter(
    p0: PsiElement?, 
    p1: PsiElement?, 
    p2: PsiElement?
): PsiElement?

`addRangeBefore`¶

abstract fun addRangeBefore(
    p0: @NotNull PsiElement, 
    p1: @NotNull PsiElement, 
    p2: PsiElement?
): PsiElement?

`anyDescendantOfType`¶

inline fun <reified T : PsiElement> PsiElement.anyDescendantOfType(noinline predicate: (T) -> Boolean = { true }): Boolean

Returns true if this element or any descendant of type T satisfies predicate.

inline fun <reified T : PsiElement> PsiElement.anyDescendantOfType(crossinline canGoInside: (PsiElement) -> Boolean, noinline predicate: (T) -> Boolean = { true }): Boolean

Returns true if this element or any descendant of type T satisfies predicate. canGoInside controls traversal into children but does not prevent the current element from being tested.

`asAssignment`¶

fun KtExpression.asAssignment(): KtBinaryExpression?

Returns this expression as a KtBinaryExpression if it is an assignment, or null otherwise.

`before`¶

fun PsiElement.before(element: PsiElement): Boolean

Returns true if this element ends at or before element starts (that is, it precedes element in the file).

`blockExpressionsOrSingle`¶

fun KtElement.blockExpressionsOrSingle(): Sequence<KtElement>

Returns the statements of this element if it is a block, otherwise a single-element sequence of this element.

`canNavigate`¶

open fun canNavigate(): Boolean

`canNavigateToSource`¶

open fun canNavigateToSource(): Boolean

`checkAdd`¶

abstract fun checkAdd(p0: @NotNull PsiElement)

`checkDecompiledText`¶

fun PsiElement.checkDecompiledText()

Throws if this element belongs to a compiled file that is backed by a stub. Loading decompiled text is slow and should be avoided; stubs should be used instead. Called by the descendant-traversal helpers as a guard.

`checkDelete`¶

abstract fun checkDelete()

`collectDescendantsOfType`¶

inline fun <reified T : PsiElement> PsiElement.collectDescendantsOfType(noinline predicate: (T) -> Boolean = { true }): List<T>

Collects this element and all descendants of type T satisfying predicate into a list in post-order.

inline fun <reified T : PsiElement> PsiElement.collectDescendantsOfType(crossinline canGoInside: (PsiElement) -> Boolean, noinline predicate: (T) -> Boolean = { true }): List<T>

Collects this element and all descendants of type T satisfying predicate into a list in post-order. canGoInside controls traversal into children but does not prevent the current element from being collected.

`collectDescendantsOfTypeTo`¶

inline fun <reified T : PsiElement, C : MutableCollection<T>> PsiElement.collectDescendantsOfTypeTo(
    to: C, 
    crossinline canGoInside: (PsiElement) -> Boolean, 
    noinline predicate: (T) -> Boolean = { true }
): C

Adds this element and all descendants of type T satisfying predicate to to in post-order. canGoInside controls traversal into children but does not prevent the current element from being added.

`containingClass`¶

fun KtElement.containingClass(): KtClass?

Returns the nearest enclosing KtClass, or null if there is none.

`copy`¶

abstract fun copy(): PsiElement?

`delete`¶

abstract fun delete()

`deleteChildRange`¶

abstract fun deleteChildRange(p0: PsiElement?, p1: PsiElement?)

`findDescendantOfType`¶

inline fun <reified T : PsiElement> PsiElement.findDescendantOfType(noinline predicate: (T) -> Boolean = { true }): T?

Returns the first element of type T in a pre-order traversal of this element and its descendants that satisfies predicate, or null if there is none.

inline fun <reified T : PsiElement> PsiElement.findDescendantOfType(crossinline canGoInside: (PsiElement) -> Boolean, noinline predicate: (T) -> Boolean = { true }): T?

Returns the first element of type T in a pre-order traversal of this element and its descendants that satisfies predicate, or null. canGoInside controls traversal into children but does not prevent the current element from being tested.

`findElementAt`¶

abstract fun findElementAt(p0: Int): @Nullable PsiElement?

`findReferenceAt`¶

abstract fun findReferenceAt(p0: Int): @Nullable PsiReference?

`forEachDescendantOfType`¶

inline fun <reified T : PsiElement> PsiElement.forEachDescendantOfType(noinline action: (T) -> Unit)

Applies action to this element and every descendant of type T, in post-order (children before parents).

inline fun <reified T : PsiElement> PsiElement.forEachDescendantOfType(crossinline canGoInside: (PsiElement) -> Boolean, noinline action: (T) -> Unit)

Applies action to this element and every descendant of type T, in post-order. canGoInside controls whether each visited element's children are traversed; the element itself is still passed to action when it is a T, even if canGoInside returns false for it.

`forEachDescendantOfTypeInPreorder`¶

inline fun <reified T : PsiElement> PsiElement.forEachDescendantOfTypeInPreorder(noinline action: (T) -> Unit)

Applies action to this element and every descendant of type T, in pre-order (parents before children).

inline fun <reified T : PsiElement> PsiElement.forEachDescendantOfTypeInPreorder(crossinline canGoInside: (PsiElement) -> Boolean, noinline action: (T) -> Unit)

Applies action to this element and every descendant of type T, in pre-order. canGoInside controls whether each visited element's children are traversed; the element itself is still passed to action when it is a T, even if canGoInside returns false for it.

`getAnnotationEntries`¶

fun KtExpression.getAnnotationEntries(): List<KtAnnotationEntry>

Returns the annotation entries applied to this expression through an enclosing annotated (or labeled) expression, or an empty list if there are none.

`getAssignmentByLHS`¶

fun KtExpression.getAssignmentByLHS(): KtBinaryExpression?

Returns the assignment in which this expression is the left-hand side, or null if it is not assigned to.

`getAssignmentLhsIfUnwrappable`¶

fun PsiElement.getAssignmentLhsIfUnwrappable(): PsiElement?

Returns the operand this operation applies to, but only when that operand is wrapped in parentheses, a label, or annotations; returns null otherwise.

`getBinaryWithTypeParent`¶

fun KtExpression.getBinaryWithTypeParent(): KtBinaryExpressionWithTypeRHS?

Returns the as/as? expression whose left-hand side is a call with this expression as its direct child, normally its callee. The call may be the selector of a qualified expression, and the call or qualified expression may be parenthesized. Returns null otherwise.

`getChildOfType`¶

inline fun <reified T : PsiElement> PsiElement.getChildOfType(): T?

Returns the first direct child of type T, or null if there is none.

`getChildrenOfType`¶

inline fun <reified T : PsiElement> PsiElement.getChildrenOfType(): Array<T>

Returns the direct children of type T, or an empty array if there are none.

getClassId¶

abstract fun getClassId(): ClassId?

Return ClassId, if the class is not local (e.g., if a class can be accessed by that ClassId from another context)

For classes that are themselves local (declared inside a function or other local scope), returns null. For nested classes in local classes returns null. For KtEnumEntry returns null as enum entry is not a class semantically. And so, for nested classes in enum entry, returns null. Otherwise, returns non-null ClassId.

For returned ClassId, the ClassId.isLocal is always false.

`getCopyableUserData`¶

abstract fun <T> getCopyableUserData(p0: @NotNull Key<T?>): @Nullable T?

`getElementTextWithContext`¶

fun PsiElement.getElementTextWithContext(): String

Returns this element's text with surrounding source context, for use in diagnostics and log messages.

`getExplicitReceiverOfDotQualified`¶

fun PsiElement.getExplicitReceiverOfDotQualified(): PsiElement?

Returns the source of the explicit receiver if this element is a dot-qualified expression, or null otherwise.

`getIcon`¶

abstract fun getIcon(p0: Int): Icon?

`getLabeledParent`¶

fun KtExpression.getLabeledParent(labelName: String): KtLabeledExpression?

Returns the nearest enclosing labeled expression with the given labelName, or null if there is none.

`getLastParentOfTypeInRow`¶

inline fun <reified T : PsiElement> PsiElement.getLastParentOfTypeInRow(): T?

Returns the outermost element in an uninterrupted chain of ancestors of type T, or null if the parent is not a T.

`getLastParentOfTypeInRowWithSelf`¶

inline fun <reified T : PsiElement> PsiElement.getLastParentOfTypeInRowWithSelf(): T?

Like getLastParentOfTypeInRow, but the chain may start at this element itself.

getModificationStamp¶

fun KtElement.getModificationStamp(): Long

Returns the modification stamp of the nearest enclosing element that tracks one (a file, a stub-based declaration, or a supertype list). The stamp changes whenever that element's subtree is modified, so it can be used to invalidate caches keyed on this element.

`getName`¶

@Nullable
@NlsSafe
abstract fun getName(): @Nullable @NlsSafe String?

`getNextSiblingIgnoringWhitespace`¶

fun PsiElement.getNextSiblingIgnoringWhitespace(withItself: Boolean = false): PsiElement?

Returns the next sibling that is not whitespace, or null. Considers this element if withItself.

`getNextSiblingIgnoringWhitespaceAndComments`¶

fun PsiElement.getNextSiblingIgnoringWhitespaceAndComments(withItself: Boolean = false): PsiElement?

Returns the next sibling that is neither whitespace nor a comment, or null. Considers this element if withItself.

`getNonStrictParentOfType`¶

inline fun <reified T : PsiElement> PsiElement.getNonStrictParentOfType(): T?

Returns the nearest ancestor of type T including this element, or null if there is none.

fun <T : PsiElement> PsiElement.getNonStrictParentOfType(parentClass: Class<T>): T?

Returns the nearest ancestor of type T (including this element), or null if there is none.

`getOutermostParentContainedIn`¶

tailrec fun PsiElement.getOutermostParentContainedIn(container: PsiElement): PsiElement?

Returns the outermost element on the path from this element that is still strictly contained in container, or null.

`getOutermostParenthesizerOrThis`¶

fun KtExpression.getOutermostParenthesizerOrThis(): KtExpression

Returns the outermost expression that wraps this one only through parentheses, labels, or annotations, or this expression itself.

`getParent`¶

@Contract(pure = true)
abstract fun getParent(): PsiElement?

`getParentOfType`¶

inline fun <reified T : PsiElement> PsiElement.getParentOfType(strict: Boolean): T?

Returns the nearest ancestor of type T, or null. When strict is false, this element itself is also considered.

inline fun <reified T : PsiElement> PsiElement.getParentOfType(strict: Boolean, vararg stopAt: Class<out PsiElement>): T?

Returns the nearest ancestor of type T, stopping the search once an ancestor of any type in stopAt is reached, or null. When strict is false, this element itself is also considered.

`getParentOfTypeAndBranch`¶

inline fun <reified T : PsiElement> PsiElement.getParentOfTypeAndBranch(strict: Boolean = false, noinline branch: T.() -> PsiElement?): T?

Checks the nearest element of type T and returns it if this element lies within the subtree selected by branch. If that candidate's branch does not contain this element, returns null without checking higher ancestors. When strict is false, this element itself is also considered as the candidate.

`getParentOfTypeAndBranches`¶

inline fun <reified T : PsiElement> PsiElement.getParentOfTypeAndBranches(strict: Boolean = false, noinline branches: T.() -> Iterable<PsiElement?>): T?

Checks the nearest element of type T and returns it if this element lies within any subtree selected by branches. If none of that candidate's branches contain this element, returns null without checking higher ancestors. When strict is false, this element itself is also considered as the candidate.

`getParentOfTypes`¶

fun <T : PsiElement> PsiElement.getParentOfTypes(strict: Boolean = false, vararg parentClasses: Class<out T>): T?

Returns the nearest ancestor that is an instance of one of parentClasses, or null if there is none. When strict is false, this element itself is also considered.

`getParentOfTypes2`¶

inline fun <reified T : PsiElement, reified V : PsiElement> PsiElement.getParentOfTypes2(): PsiElement?

Returns the nearest strict ancestor that is a T or V, or null if there is none.

`getParentOfTypes3`¶

inline fun <reified T : PsiElement, reified V : PsiElement, reified U : PsiElement> PsiElement.getParentOfTypes3(): PsiElement?

Returns the nearest strict ancestor that is a T, V, or U, or null if there is none.

`getParentOfTypesAndPredicate`¶

fun <T : PsiElement> PsiElement.getParentOfTypesAndPredicate(
    strict: Boolean = false, 
    vararg parentClasses: Class<out T>, 
    predicate: (T) -> Boolean
): T?

Returns the nearest ancestor that is an instance of one of parentClasses and satisfies predicate, or null. When parentClasses is empty, any type matches. When strict is false, this element itself is also considered.

`getPossiblyQualifiedCallExpression`¶

fun KtExpression.getPossiblyQualifiedCallExpression(): KtCallExpression?

Returns the call expression this expression represents: the selector's call for a qualified expression, or this expression if it is itself a call. Returns null if there is no call.

`getPrevSiblingIgnoringWhitespace`¶

fun PsiElement.getPrevSiblingIgnoringWhitespace(withItself: Boolean = false): PsiElement?

Returns the previous sibling that is not whitespace, or null. Considers this element if withItself.

`getPrevSiblingIgnoringWhitespaceAndComments`¶

fun PsiElement.getPrevSiblingIgnoringWhitespaceAndComments(withItself: Boolean = false): PsiElement?

Returns the previous sibling that is neither whitespace nor a comment, or null. Considers this element if withItself.

`getQualifiedElementSelector`¶

fun KtElement.getQualifiedElementSelector(): KtElement?

Returns the rightmost selector of this qualified element, or null if there is no such selector.

`getQualifiedExpressionForReceiver`¶

fun KtExpression.getQualifiedExpressionForReceiver(): KtQualifiedExpression?

Returns the qualified expression in which this expression is the receiver, or null if it is not a receiver.

`getQualifiedExpressionForReceiverOrThis`¶

fun KtExpression.getQualifiedExpressionForReceiverOrThis(): KtExpression

Returns the qualified expression in which this expression is the receiver, or this expression itself otherwise.

`getQualifiedExpressionForSelector`¶

fun KtElement.getQualifiedExpressionForSelector(): KtQualifiedExpression?

Returns the qualified expression in which this element is the selector, or null if it is not a selector.

`getQualifiedExpressionForSelectorOrThis`¶

fun KtExpression.getQualifiedExpressionForSelectorOrThis(): KtExpression

Returns the qualified expression in which this expression is the selector, or this expression itself otherwise.

`getStartOffsetIn`¶

fun PsiElement.getStartOffsetIn(ancestor: PsiElement): Int

Returns the offset of this element relative to the start of ancestor (which must be an ancestor of this element).

`getStrictParentOfType`¶

inline fun <reified T : PsiElement> PsiElement.getStrictParentOfType(): T?

Returns the nearest strict ancestor of type T, or null if there is none.

`getTextWithLocation`¶

fun PsiElement.getTextWithLocation(): String

Returns this element's text together with its source location, for use in diagnostics and log messages.

`getTopmostParentOfType`¶

inline fun <reified T : PsiElement> PsiElement.getTopmostParentOfType(): T?

Returns the outermost ancestor of type T including this element, or null if there is none.

`getUserData`¶

abstract fun <T> getUserData(p0: @NotNull Key<T?>): @Nullable T?

`getValueParameterList`¶

fun KtNamedDeclaration.getValueParameterList(): KtParameterList?

Returns the value parameter list of this declaration (the primary constructor's for a class), or null.

`getValueParameters`¶

fun KtNamedDeclaration.getValueParameters(): List<KtParameter>

Returns the value parameters of this declaration (constructor value parameters for a class), or an empty list.

`hasActualModifier`¶

fun KtModifierListOwner.hasActualModifier(): Boolean

Returns true if this declaration has the actual modifier.

`hasBody`¶

fun KtDeclaration.hasBody(): Boolean

Returns true if this declaration is a function or property that defines a body.

`hasExpectModifier`¶

fun KtModifierListOwner.hasExpectModifier(): Boolean

Returns true if this declaration has the expect modifier.

`hasExternalModifier`¶

fun KtModifierListOwner.hasExternalModifier(): Boolean

Returns true if this declaration has the external modifier.

`hasInnerModifier`¶

fun KtModifierListOwner.hasInnerModifier(): Boolean

Returns true if this declaration has the inner modifier.

`hasModifier`¶

abstract fun hasModifier(@NotNull modifier: KtModifierKeywordToken): Boolean

Returns true if this element declares the given modifier keyword (for example, PRIVATE_KEYWORD).

`isActualDeclaration`¶

fun KtDeclaration.isActualDeclaration(): Boolean

Returns true if this declaration is actual: either it has an explicit actual modifier, or it is a constructor of an actual annotation, value, or inline class.

`isAncestor`¶

fun PsiElement?.isAncestor(element: PsiElement, strict: Boolean = false): Boolean

Returns true if this element is an ancestor of element. When strict is false, an element is its own ancestor.

`isContextualDeclaration`¶

fun KtElement.isContextualDeclaration(): Boolean

Returns true if this callable, class, or object declares at least one legacy context receiver. Named context parameters are ignored.

`isContractDescriptionCallPsiCheck`¶

fun KtExpression.isContractDescriptionCallPsiCheck(): Boolean

Best-effort PSI check for whether this expression is a contract { ... } (or kotlin.contracts.contract { ... }) call.

`isDotReceiver`¶

fun KtExpression.isDotReceiver(): Boolean

Returns true if this expression is the receiver of an enclosing dot-qualified expression.

`isDotSelector`¶

fun KtExpression.isDotSelector(): Boolean

Returns true if this expression is the selector of an enclosing dot-qualified expression.

`isEquivalentTo`¶

abstract fun isEquivalentTo(p0: PsiElement?): Boolean

`isExpectDeclaration`¶

fun KtDeclaration.isExpectDeclaration(): Boolean

Returns true if this declaration is expect, either directly (via the modifier) or by being contained in an expect declaration.

`isExtensionDeclaration`¶

fun PsiElement.isExtensionDeclaration(): Boolean

Returns true if this element is an extension function or property (that is, it declares a receiver).

`isFirstStatement`¶

fun KtElement.isFirstStatement(): Boolean

Returns true if this element is the first statement of its enclosing block.

`isFunctionalExpression`¶

fun PsiElement.isFunctionalExpression(): Boolean

Returns true if this element is an anonymous function, such as the fun expression in val predicate = fun(x: Int): Boolean = x > 0.

`isInImportDirective`¶

fun KtExpression.isInImportDirective(): Boolean

Returns true if this expression appears inside an import directive.

`isInsideOf`¶

fun PsiElement.isInsideOf(elements: Iterable<PsiElement>): Boolean

Returns true if this element lies within, or is equal to, any of the given elements.

`isLambdaOutsideParentheses`¶

fun KtExpression.isLambdaOutsideParentheses(): Boolean

Returns true if this expression is a trailing lambda argument written outside the call parentheses.

`isNull`¶

fun KtExpression.isNull(): Boolean

Returns true if this expression is the null literal. Smart-casts the receiver to KtConstantExpression on true.

`isPrivate`¶

fun KtModifierListOwner.isPrivate(): Boolean

Returns true if this declaration has the private modifier.

`isProtected`¶

fun KtModifierListOwner.isProtected(): Boolean

Returns true if this declaration has the protected modifier.

`isTopLevelKtOrJavaMember`¶

fun PsiElement.isTopLevelKtOrJavaMember(): Boolean

Returns true if this element is a top-level member of a Kotlin file or a top-level Java class.

`lastBlockStatementOrThis`¶

fun KtExpression.lastBlockStatementOrThis(): KtExpression

Returns the last statement if this expression is a block, otherwise this expression itself.

`modalityModifier`¶

fun KtDeclaration.modalityModifier(): PsiElement?

Returns the modality modifier token (abstract/open/final/sealed), or null if none is present.

`modalityModifierType`¶

fun KtDeclaration.modalityModifierType(): KtModifierKeywordToken?

Returns the type of this declaration's modality modifier, or null if none is present.

`navigate`¶

open fun navigate(requestFocus: Boolean)

`navigationRequest`¶

open fun navigationRequest(): @Nullable NavigationRequest?

`nextLeaf`¶

fun PsiElement.nextLeaf(skipEmptyElements: Boolean = false): PsiElement?

Returns the next leaf element in the tree, or null if there is none. Empty leaves are skipped if skipEmptyElements.

fun PsiElement.nextLeaf(filter: (PsiElement) -> Boolean): PsiElement?

Returns the nearest following leaf that satisfies filter, or null if there is none.

`nonStaticOuterClasses`¶

fun KtElement.nonStaticOuterClasses(): Sequence<KtClass>

Returns the enclosing classes that this element can access an outer instance of, from innermost to outermost.

`parameterIndex`¶

fun PsiElement.parameterIndex(): Int

Returns the index of this parameter within its own parameter list (Kotlin or Java), or -1 if it is not a parameter.

`prevLeaf`¶

fun PsiElement.prevLeaf(skipEmptyElements: Boolean = false): PsiElement?

Returns the previous leaf element in the tree, or null if there is none. Empty leaves are skipped if skipEmptyElements.

fun PsiElement.prevLeaf(filter: (PsiElement) -> Boolean): PsiElement?

Returns the nearest preceding leaf that satisfies filter, or null if there is none.

`processDeclarations`¶

abstract fun processDeclarations(
    p0: @NotNull PsiScopeProcessor, 
    p1: @NotNull ResolveState, 
    p2: @Nullable PsiElement?, 
    p3: @NotNull PsiElement
): Boolean

`putCopyableUserData`¶

abstract fun <T> putCopyableUserData(p0: @NotNull Key<T?>, p1: @Nullable T?)

`putUserData`¶

abstract fun <T> putUserData(p0: @NotNull Key<T?>, p1: @Nullable T?)

rawDelete¶

abstract fun rawDelete()

Deletes this PSI element using the raw platform implementation, bypassing Kotlin PSI-specific delete overrides.

Regular clients should use delete instead. When KtPsiMutationService is not registered, it performs the same plain deletion, and when the service is registered, as in the IntelliJ Kotlin plugin, it may also adjust the surrounding code, e.g., delete a semicolon that follows the element.

`referenceExpression`¶

fun KtExpression.referenceExpression(): KtReferenceExpression?

Returns the reference expression of this expression (the callee for a call), or null if it is not a reference.

`replace`¶

abstract fun replace(p0: @NotNull PsiElement): PsiElement?

`safeFqNameForLazyResolve`¶

fun KtNamedDeclaration.safeFqNameForLazyResolve(): FqName?

Returns this declaration's fully qualified name using the safe name for lazy resolution, or null if unavailable.

`safeNameForLazyResolve`¶

fun KtNamedDeclaration.safeNameForLazyResolve(): Name

Returns this declaration's name, substituting the "no name provided" special name for a missing or special name.

`setName`¶

abstract fun setName(p0: @NlsSafe @NotNull String): PsiElement?

`siblings`¶

fun PsiElement.siblings(forward: Boolean = true, withItself: Boolean = true): Sequence<PsiElement>

Returns the siblings of this element as a lazy sequence, going forward (or backward) and optionally including the element itself (withItself).

`startsWithComment`¶

fun PsiElement.startsWithComment(): Boolean

Returns true if this element's first child is a comment.

`textContains`¶

abstract fun textContains(p0: Char): Boolean

`textMatches`¶

abstract fun textMatches(p0: @NotNull PsiElement): Boolean

abstract fun textMatches(p0: @NotNull @NonNls CharSequence): Boolean

`textToCharArray`¶

abstract fun textToCharArray(): @NotNull CharArray

`topParenthesizedParentOrMe`¶

fun KtExpression.topParenthesizedParentOrMe(): KtExpression

Returns the outermost enclosing expression that this expression is wrapped in only through parentheses, or this expression itself.

unpackFunctionLiteral¶

fun KtExpression.unpackFunctionLiteral(allowParentheses: Boolean = false): KtLambdaExpression?

If this expression is a lambda expression, or wraps one in a label or an annotation, returns that KtLambdaExpression; otherwise returns null. Parentheses are unwrapped only when allowParentheses is true.

`unwrapParenthesesLabelsAndAnnotations`¶

fun PsiElement?.unwrapParenthesesLabelsAndAnnotations(): PsiElement?

Recursively unwraps this element while it is a parenthesized, labeled, or annotated expression, returning the innermost base element. A non-wrapper element is returned unchanged.

`unwrapParenthesesLabelsAndAnnotationsDeeply`¶

fun PsiElement.unwrapParenthesesLabelsAndAnnotationsDeeply(): PsiElement

Walks up through immediately enclosing parentheses, labels, and annotations, returning the first parent outside that wrapper chain.

`visibilityModifier`¶

fun KtModifierListOwner.visibilityModifier(): PsiElement?

Returns the visibility modifier token of this declaration, or null if none is present.

`visibilityModifierType`¶

fun KtModifierListOwner.visibilityModifierType(): KtModifierKeywordToken?

Returns the type of this declaration's visibility modifier, or null if none is present.

`visibilityModifierTypeOrDefault`¶

fun KtModifierListOwner.visibilityModifierTypeOrDefault(): KtModifierKeywordToken

Returns the type of this declaration's visibility modifier, or the default visibility (public) if none is present.