2.0.0-alpha.0

detekt-psi-utils/dev.detekt.psi

Package-level declarations

Types

AnnotationExcluder

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

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.

AnnotationExcluderBindingContext

class AnnotationExcluderBindingContext(root: KtFile, excludes: List<Regex>, context: BindingContext)

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

val KtThrowExpression.arguments: List<KtValueArgument>

Functions

fun PsiFile.absolutePath(): Path

fun KtFile.absolutePath(): Path

companionObject

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

fun KtLambdaExpression.firstParameter(bindingContext: BindingContext): <Error class: unknown class>

firstParameterOrNull

fun KtLambdaExpression.firstParameterOrNull(): KaValueParameterSymbol?

fun KotlinType.fqNameOrNull(): FqName?

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

hasCorrectEqualsParameter

fun KtFunction.hasCorrectEqualsParameter(): Boolean

hasImplicitParameterReference

fun KtLambdaExpression.hasImplicitParameterReference(): Boolean

fun KtLambdaExpression.hasImplicitParameterReference(implicitParameter: ValueParameterDescriptor, bindingContext: BindingContext): Boolean

hasImplicitUnitReturnType

fun KtNamedFunction.hasImplicitUnitReturnType(): Boolean

fun KtNamedFunction.hasImplicitUnitReturnType(bindingContext: BindingContext): Boolean

implicitParameter

fun KtLambdaExpression.implicitParameter(bindingContext: BindingContext): ValueParameterDescriptor?

fun KtModifierListOwner.isAbstract(): Boolean

fun KtModifierListOwner.isActual(): Boolean

isAllowedExceptionName

fun KtCatchClause.isAllowedExceptionName(regex: Regex): Boolean

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

fun KtCallExpression.isCalling(callableId: CallableId): Boolean

fun KtCallExpression.isCalling(fqNames: List<FqName>, bindingContext: BindingContext): Boolean

fun KtCallExpression.isCalling(fqName: FqName, bindingContext: BindingContext): Boolean

isCallingWithNonNullCheckArgument

fun KtCallExpression.isCallingWithNonNullCheckArgument(callableId: CallableId): Boolean

fun KtModifierListOwner.isConstant(): Boolean

isEmptyOrSingleStringArgument

fun List<KtValueArgument>.isEmptyOrSingleStringArgument(): Boolean

fun List<KtValueArgument>.isEmptyOrSingleStringArgument(bindingContext: BindingContext): Boolean

isEnclosedByConditionalStatement

fun KtThrowExpression.isEnclosedByConditionalStatement(): Boolean

isEqualsFunction

fun KtFunction.isEqualsFunction(): Boolean

isExceptionOfType

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

fun KtModifierListOwner.isExpect(): Boolean

fun KtModifierListOwner.isExternal(): Boolean

isHashCodeFunction

fun KtFunction.isHashCodeFunction(): Boolean

isIllegalArgumentException

fun KtThrowExpression.isIllegalArgumentException(): Boolean

isIllegalStateException

fun KtThrowExpression.isIllegalStateException(): Boolean

fun KtModifierListOwner.isInline(): Boolean

fun KtModifierListOwner.isInternal(): Boolean

isJvmFinalizeFunction

fun KtNamedFunction.isJvmFinalizeFunction(): Boolean

Kotlin Documentation

fun KtModifierListOwner.isLateinit(): Boolean

fun KtNamedFunction.isMainFunction(): Boolean

fun KtBinaryExpression.isNonNullCheck(): Boolean

fun KtExpression.isNullable(shouldConsiderPlatformTypeAsNullable: Boolean): Boolean

Return if overall expression is nullable or not nullable

fun KtBinaryExpression.isNullCheck(): Boolean

fun KtModifierListOwner.isOpen(): Boolean

fun KtModifierListOwner.isOperator(): Boolean

fun KtModifierListOwner.isOverride(): Boolean

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

Tests if this element is part of given PsiElement.

fun PsiElement.isPartOfString(): Boolean

Tests if this element is part of a kotlin string.

fun KtModifierListOwner.isProtected(): Boolean

isPublicNotOverridden

fun KtModifierListOwner.isPublicNotOverridden(): Boolean

fun KtModifierListOwner.isPublicNotOverridden(considerProtectedAsPublic: Boolean): Boolean

fun KtValueArgument.isString(): Boolean

fun KtValueArgument.isString(bindingContext: BindingContext): Boolean

lastArgumentMatchesKotlinReferenceUrlSyntax

fun String.lastArgumentMatchesKotlinReferenceUrlSyntax(): Boolean

lastArgumentMatchesMarkdownUrlSyntax

fun String.lastArgumentMatchesMarkdownUrlSyntax(): Boolean

lastArgumentMatchesUrl

fun String.lastArgumentMatchesUrl(): Boolean

fun KtCallExpression.receiverIsUsed(): Boolean

fun KtCallExpression.receiverIsUsed(context: BindingContext): Boolean