detekt-psi-utils/dev.detekt.psi

Package-level declarations

Types

class AnnotationExcluder(root: KtFile, excludes: List<Regex>, fullAnalysis: Boolean)

Primary use case for an AnnotationExcluder is to decide if a KtElement should be excluded from further analysis. This is done by checking if a special annotation is present over the element.

FunctionMatcher

sealed class FunctionMatcher

Properties

arguments

val KtThrowExpression.arguments: List<KtValueArgument>

Functions

absolutePath

fun PsiFile.absolutePath(): Path

fun KtFile.absolutePath(): Path

companionObject

fun KtClass.companionObject(): <Error class: unknown class>

firstParameterOrNull

fun KtLambdaExpression.firstParameterOrNull(): KaValueParameterSymbol?

hasAnnotation

fun KtAnnotated.hasAnnotation(vararg annotationNames: String): Boolean

hasCorrectEqualsParameter

fun KtFunction.hasCorrectEqualsParameter(): Boolean

hasImplicitParameterReference

fun KtLambdaExpression.hasImplicitParameterReference(): Boolean

hasImplicitUnitReturnType

fun KtNamedFunction.hasImplicitUnitReturnType(): Boolean

implicitParameterOrNull

fun KtLambdaExpression.implicitParameterOrNull(): KaValueParameterSymbol?

isAbstract

fun KtModifierListOwner.isAbstract(): Boolean

isActual

fun KtModifierListOwner.isActual(): Boolean

isAllowedExceptionName

fun KtCatchClause.isAllowedExceptionName(regex: Regex): Boolean

isCalling

fun KtCallExpression.isCalling(callableIds: List<CallableId>): <Error class: unknown class>

fun KtCallExpression.isCalling(callableId: CallableId): Boolean

isCallingWithNonNullCheckArgument

fun KtCallExpression.isCallingWithNonNullCheckArgument(callableId: CallableId): Boolean

isConstant

fun KtModifierListOwner.isConstant(): Boolean

isEmptyOrSingleStringArgument

fun List<KtValueArgument>.isEmptyOrSingleStringArgument(): Boolean

isEnclosedByConditionalStatement

fun KtThrowExpression.isEnclosedByConditionalStatement(): Boolean

isEqualsFunction

fun KtFunction.isEqualsFunction(): Boolean

isExceptionOfType

inline fun <T : Exception> KtThrowExpression.isExceptionOfType(): Boolean

isExpect

fun KtModifierListOwner.isExpect(): Boolean

isExternal

fun KtModifierListOwner.isExternal(): Boolean

isHashCodeFunction

fun KtFunction.isHashCodeFunction(): Boolean

isIllegalArgumentException

fun KtThrowExpression.isIllegalArgumentException(): Boolean

isIllegalStateException

fun KtThrowExpression.isIllegalStateException(): Boolean

isInline

fun KtModifierListOwner.isInline(): Boolean

isInternal

fun KtModifierListOwner.isInternal(): Boolean

isJvmFinalizeFunction

fun KtNamedFunction.isJvmFinalizeFunction(): Boolean

Kotlin Documentation

isLateinit

fun KtModifierListOwner.isLateinit(): Boolean

isMainFunction

fun KtNamedFunction.isMainFunction(): Boolean

isNonNullCheck

fun KtBinaryExpression.isNonNullCheck(): Boolean

isNullable

fun KtExpression.isNullable(shouldConsiderPlatformTypeAsNullable: Boolean): Boolean

Return if overall expression is nullable or not nullable

isNullCheck

fun KtBinaryExpression.isNullCheck(): Boolean

isOpen

fun KtModifierListOwner.isOpen(): Boolean

isOperator

fun KtModifierListOwner.isOperator(): Boolean

isOverride

fun KtModifierListOwner.isOverride(): Boolean

isPartOf

inline fun <T : PsiElement> PsiElement.isPartOf(): Boolean

Tests if this element is part of given PsiElement.

isPartOfString

fun PsiElement.isPartOfString(): Boolean

Tests if this element is part of a kotlin string.

isProtected

fun KtModifierListOwner.isProtected(): Boolean

isPublicNotOverridden

fun KtModifierListOwner.isPublicNotOverridden(): Boolean

fun KtModifierListOwner.isPublicNotOverridden(considerProtectedAsPublic: Boolean): Boolean

isString

fun KtValueArgument.isString(): Boolean

lastArgumentMatchesKotlinReferenceUrlSyntax

fun String.lastArgumentMatchesKotlinReferenceUrlSyntax(): Boolean

lastArgumentMatchesMarkdownUrlSyntax

fun String.lastArgumentMatchesMarkdownUrlSyntax(): Boolean

lastArgumentMatchesUrl

fun String.lastArgumentMatchesUrl(): Boolean

receiverIsUsed

fun KtCallExpression.receiverIsUsed(): Boolean