- CAUGHT_EXCEPTIONS_PROPERTY - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.TooGenericExceptionCaught
-
- CLASS_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.ClassNaming
-
- ClassNaming - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports when class or object names which do not follow the specified naming convention are used.
- ClassNaming(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.ClassNaming
-
Reports when class or object names which do not follow the specified naming convention are used.
- ClassNaming() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.ClassNaming
-
Reports when class or object names which do not follow the specified naming convention are used.
- ClassNaming.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- CollapsibleIfStatements - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule detects if statements which can be collapsed. This can reduce nesting and help improve readability.
- CollapsibleIfStatements(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.CollapsibleIfStatements
-
This rule detects if statements which can be collapsed. This can reduce nesting and help improve readability.
- CollapsibleIfStatements() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.CollapsibleIfStatements
-
This rule detects if statements which can be collapsed. This can reduce nesting and help improve readability.
- CommentOverPrivateFunction - Class in io.gitlab.arturbosch.detekt.rules.documentation
-
This rule reports comments and documentation that has been added to private functions. These comments get reported
because they probably explain the functionality of the private function. However private functions should be small
enough and have an understandable name so that they are self-explanatory and do not need this comment in the first
place.
- CommentOverPrivateFunction(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.CommentOverPrivateFunction
-
This rule reports comments and documentation that has been added to private functions. These comments get reported
because they probably explain the functionality of the private function. However private functions should be small
enough and have an understandable name so that they are self-explanatory and do not need this comment in the first
place.
- CommentOverPrivateFunction() - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.CommentOverPrivateFunction
-
This rule reports comments and documentation that has been added to private functions. These comments get reported
because they probably explain the functionality of the private function. However private functions should be small
enough and have an understandable name so that they are self-explanatory and do not need this comment in the first
place.
- CommentOverPrivateProperty - Class in io.gitlab.arturbosch.detekt.rules.documentation
-
This rule reports comments and documentation above private properties. This can indicate that the property has a
confusing name or is not in a small enough context to be understood.
Private properties should be named in a self-explanatory way and readers of the code should be able to understand
why the property exists and what purpose it solves without the comment.
- CommentOverPrivateProperty(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.CommentOverPrivateProperty
-
This rule reports comments and documentation above private properties. This can indicate that the property has a
confusing name or is not in a small enough context to be understood.
Private properties should be named in a self-explanatory way and readers of the code should be able to understand
why the property exists and what purpose it solves without the comment.
- CommentOverPrivateProperty() - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.CommentOverPrivateProperty
-
This rule reports comments and documentation above private properties. This can indicate that the property has a
confusing name or is not in a small enough context to be understood.
Private properties should be named in a self-explanatory way and readers of the code should be able to understand
why the property exists and what purpose it solves without the comment.
- CommentSmellProvider - Class in io.gitlab.arturbosch.detekt.rules.providers
-
This rule set provides rules that address issues in comments and documentation
of the code.
- CommentSmellProvider() - Constructor for class io.gitlab.arturbosch.detekt.rules.providers.CommentSmellProvider
-
This rule set provides rules that address issues in comments and documentation
of the code.
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.bugs.LateinitUsage
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.ComplexCondition
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.ComplexInterface
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.ComplexMethod
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.LabeledExpression
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.LargeClass
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.LongMethod
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.LongParameterList
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.MethodOverloading
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.NestedBlockDepth
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.StringLiteralDuplication
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.documentation.EndOfSentenceFormat
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicClass
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.empty.EmptyCatchBlock
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.empty.EmptyFunctionBlock
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.ExceptionRaisedInUnexpectedLocation
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.SwallowedException
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingExceptionsWithoutMessageOrCause
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.TooGenericExceptionCaught
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.TooGenericExceptionThrown
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.ClassNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.ConstructorParameterNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.EnumNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.ForbiddenClassName
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionMaxLength
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionMinLength
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionParameterNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.MemberNameEqualsClassName
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.ObjectPropertyNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.PackageNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.TopLevelPropertyNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.VariableMaxLength
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.VariableMinLength
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.VariableNaming
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.DataClassContainsFunctions
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.EqualsOnSignatureLine
-
Deprecated.
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ExpressionBodySyntax
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ForbiddenComment
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ForbiddenImport
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.FunctionOnlyReturningConstant
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.LoopWithTooManyJumpStatements
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MaxLineLength
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.optional.OptionalUnit
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.optional.PreferToOverPairSyntax
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ReturnCount
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ThrowsCount
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryAbstractClass
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.UnusedImports
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.UnusedPrivateMember
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.UseDataClass
-
- Companion - Static variable in class io.gitlab.arturbosch.detekt.rules.style.WildcardImport
-
- companionObject($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.JunkKt
-
- ComplexCondition - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
Complex conditions make it hard to understand which cases lead to the condition being true or false. To improve
readability and understanding of complex conditions consider extracting them into well-named functions or variables
and call those instead.
- ComplexCondition(config, threshold) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.ComplexCondition
-
Complex conditions make it hard to understand which cases lead to the condition being true or false. To improve
readability and understanding of complex conditions consider extracting them into well-named functions or variables
and call those instead.
- ComplexCondition() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.ComplexCondition
-
Complex conditions make it hard to understand which cases lead to the condition being true or false. To improve
readability and understanding of complex conditions consider extracting them into well-named functions or variables
and call those instead.
- ComplexCondition.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- ComplexInterface - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
Complex interfaces which contain too many functions and/or properties indicate that this interface is handling too
many things at once. Interfaces should follow the single-responsibility principle to also encourage implementations
of this interface to not handle too many things at once.
- ComplexInterface(config, threshold) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.ComplexInterface
-
Complex interfaces which contain too many functions and/or properties indicate that this interface is handling too
many things at once. Interfaces should follow the single-responsibility principle to also encourage implementations
of this interface to not handle too many things at once.
- ComplexInterface() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.ComplexInterface
-
Complex interfaces which contain too many functions and/or properties indicate that this interface is handling too
many things at once. Interfaces should follow the single-responsibility principle to also encourage implementations
of this interface to not handle too many things at once.
- ComplexInterface.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- ComplexityProvider - Class in io.gitlab.arturbosch.detekt.rules.providers
-
This rule set contains rules that report complex code.
- ComplexityProvider() - Constructor for class io.gitlab.arturbosch.detekt.rules.providers.ComplexityProvider
-
This rule set contains rules that report complex code.
- ComplexMethod - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
Complex methods are hard to understand and read. It might not be obvious what side-effects a complex method has.
Prefer splitting up complex methods into smaller methods that are in turn easier to understand.
Smaller methods can also be named much clearer which leads to improved readability of the code.
- ComplexMethod(config, threshold) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.ComplexMethod
-
Complex methods are hard to understand and read. It might not be obvious what side-effects a complex method has.
Prefer splitting up complex methods into smaller methods that are in turn easier to understand.
Smaller methods can also be named much clearer which leads to improved readability of the code.
- ComplexMethod() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.ComplexMethod
-
Complex methods are hard to understand and read. It might not be obvious what side-effects a complex method has.
Prefer splitting up complex methods into smaller methods that are in turn easier to understand.
Smaller methods can also be named much clearer which leads to improved readability of the code.
- ComplexMethod.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- component1() - Method in class io.gitlab.arturbosch.detekt.rules.style.KtFileContent
-
- component2() - Method in class io.gitlab.arturbosch.detekt.rules.style.KtFileContent
-
- ConditionalPathVisitor - Class in io.gitlab.arturbosch.detekt.rules.style.optional
-
- ConditionalPathVisitor(block) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.optional.ConditionalPathVisitor
-
- CONSTANT_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.ObjectPropertyNaming
-
- CONSTANT_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.TopLevelPropertyNaming
-
- ConstructorParameterNaming - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports constructor parameter names which do not follow the specified naming convention are used.
- ConstructorParameterNaming(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.ConstructorParameterNaming
-
Reports constructor parameter names which do not follow the specified naming convention are used.
- ConstructorParameterNaming() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.ConstructorParameterNaming
-
Reports constructor parameter names which do not follow the specified naming convention are used.
- ConstructorParameterNaming.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- CONVERSION_FUNCTION_PREFIX - Static variable in class io.gitlab.arturbosch.detekt.rules.style.DataClassContainsFunctions
-
- copy(file, content) - Method in class io.gitlab.arturbosch.detekt.rules.style.KtFileContent
-
- EmptyBlocks - Class in io.gitlab.arturbosch.detekt.rules.empty
-
- EmptyBlocks(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyBlocks
-
- EmptyBlocks() - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyBlocks
-
- EmptyCatchBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty catch blocks. Empty blocks of code serve no purpose and should be removed.
- EmptyCatchBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyCatchBlock
-
Reports empty catch blocks. Empty blocks of code serve no purpose and should be removed.
- EmptyCatchBlock.Companion - Class in io.gitlab.arturbosch.detekt.rules.empty
-
- EmptyClassBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty classes. Empty blocks of code serve no purpose and should be removed.
- EmptyClassBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyClassBlock
-
Reports empty classes. Empty blocks of code serve no purpose and should be removed.
- EmptyCodeProvider - Class in io.gitlab.arturbosch.detekt.rules.providers
-
The empty-blocks ruleset contains rules that will report empty blocks of code
which should be avoided.
- EmptyCodeProvider() - Constructor for class io.gitlab.arturbosch.detekt.rules.providers.EmptyCodeProvider
-
The empty-blocks ruleset contains rules that will report empty blocks of code
which should be avoided.
- EmptyDefaultConstructor - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty default constructors. Empty blocks of code serve no purpose and should be removed.
- EmptyDefaultConstructor(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyDefaultConstructor
-
Reports empty default constructors. Empty blocks of code serve no purpose and should be removed.
- EmptyDoWhileBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty do/while loops. Empty blocks of code serve no purpose and should be removed.
- EmptyDoWhileBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyDoWhileBlock
-
Reports empty do/while loops. Empty blocks of code serve no purpose and should be removed.
- EmptyElseBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty else blocks. Empty blocks of code serve no purpose and should be removed.
- EmptyElseBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyElseBlock
-
Reports empty else blocks. Empty blocks of code serve no purpose and should be removed.
- EmptyFinallyBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty finally blocks. Empty blocks of code serve no purpose and should be removed.
- EmptyFinallyBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyFinallyBlock
-
Reports empty finally blocks. Empty blocks of code serve no purpose and should be removed.
- EmptyForBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty for loops. Empty blocks of code serve no purpose and should be removed.
- EmptyForBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyForBlock
-
Reports empty for loops. Empty blocks of code serve no purpose and should be removed.
- EmptyFunctionBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty functions. Empty blocks of code serve no purpose and should be removed.
This rule will not report functions overriding others.
- EmptyFunctionBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyFunctionBlock
-
Reports empty functions. Empty blocks of code serve no purpose and should be removed.
This rule will not report functions overriding others.
- EmptyFunctionBlock.Companion - Class in io.gitlab.arturbosch.detekt.rules.empty
-
- EmptyIfBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty if blocks. Empty blocks of code serve no purpose and should be removed.
- EmptyIfBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyIfBlock
-
Reports empty if blocks. Empty blocks of code serve no purpose and should be removed.
- EmptyInitBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty init expressions. Empty blocks of code serve no purpose and should be removed.
- EmptyInitBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyInitBlock
-
Reports empty init expressions. Empty blocks of code serve no purpose and should be removed.
- EmptyKtFile - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty Kotlin (.kt) files. Empty blocks of code serve no purpose and should be removed.
- EmptyKtFile(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyKtFile
-
Reports empty Kotlin (.kt) files. Empty blocks of code serve no purpose and should be removed.
- EmptyRule - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Rule to detect empty blocks of code.
- EmptyRule(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyRule
-
Rule to detect empty blocks of code.
- EmptySecondaryConstructor - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty secondary constructors. Empty blocks of code serve no purpose and should be removed.
- EmptySecondaryConstructor(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptySecondaryConstructor
-
Reports empty secondary constructors. Empty blocks of code serve no purpose and should be removed.
- EmptyWhenBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty when expressions. Empty blocks of code serve no purpose and should be removed.
- EmptyWhenBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyWhenBlock
-
Reports empty when expressions. Empty blocks of code serve no purpose and should be removed.
- EmptyWhileBlock - Class in io.gitlab.arturbosch.detekt.rules.empty
-
Reports empty while expressions. Empty blocks of code serve no purpose and should be removed.
- EmptyWhileBlock(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.empty.EmptyWhileBlock
-
Reports empty while expressions. Empty blocks of code serve no purpose and should be removed.
- END_OF_SENTENCE_FORMAT - Static variable in class io.gitlab.arturbosch.detekt.rules.documentation.EndOfSentenceFormat
-
- EndOfSentenceFormat - Class in io.gitlab.arturbosch.detekt.rules.documentation
-
This rule validates the end of the first sentence of a KDoc comment.
It should end with proper punctuation or with a correct URL.
- EndOfSentenceFormat(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.EndOfSentenceFormat
-
This rule validates the end of the first sentence of a KDoc comment.
It should end with proper punctuation or with a correct URL.
- EndOfSentenceFormat() - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.EndOfSentenceFormat
-
This rule validates the end of the first sentence of a KDoc comment.
It should end with proper punctuation or with a correct URL.
- EndOfSentenceFormat.Companion - Class in io.gitlab.arturbosch.detekt.rules.documentation
-
- ENUM_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.EnumNaming
-
- EnumNaming - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports when enum names which do not follow the specified naming convention are used.
- EnumNaming(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.EnumNaming
-
Reports when enum names which do not follow the specified naming convention are used.
- EnumNaming() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.EnumNaming
-
Reports when enum names which do not follow the specified naming convention are used.
- EnumNaming.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- equals(p) - Method in class io.gitlab.arturbosch.detekt.rules.style.KtFileContent
-
- EqualsAlwaysReturnsTrueOrFalse - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Reports equals() methods which will always return true or false.
- EqualsAlwaysReturnsTrueOrFalse(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.EqualsAlwaysReturnsTrueOrFalse
-
Reports equals() methods which will always return true or false.
- EqualsAlwaysReturnsTrueOrFalse() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.EqualsAlwaysReturnsTrueOrFalse
-
Reports equals() methods which will always return true or false.
- EqualsNullCall - Class in io.gitlab.arturbosch.detekt.rules.style
-
To compare an object with null prefer using ==. This rule detects and reports instances in the code where the
equals() method is used to compare a value with null.
- EqualsNullCall(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.EqualsNullCall
-
To compare an object with null prefer using ==. This rule detects and reports instances in the code where the
equals() method is used to compare a value with null.
- EqualsNullCall() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.EqualsNullCall
-
To compare an object with null prefer using ==. This rule detects and reports instances in the code where the
equals() method is used to compare a value with null.
- EqualsOnSignatureLine - Class in io.gitlab.arturbosch.detekt.rules.style
-
Requires that the equals sign, when used for an expression style function, is on the same line as the
rest of the function signature.
- EqualsOnSignatureLine(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.EqualsOnSignatureLine
-
Requires that the equals sign, when used for an expression style function, is on the same line as the
rest of the function signature.
- EqualsOnSignatureLine() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.EqualsOnSignatureLine
-
Requires that the equals sign, when used for an expression style function, is on the same line as the
rest of the function signature.
- EqualsWithHashCodeExist - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
When a class overrides the equals() method it should also override the hashCode() method.
- EqualsWithHashCodeExist(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.EqualsWithHashCodeExist
-
When a class overrides the equals() method it should also override the hashCode() method.
- EqualsWithHashCodeExist() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.EqualsWithHashCodeExist
-
When a class overrides the equals() method it should also override the hashCode() method.
- EqualsWithHashCodeExistKt - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
- ExceptionRaisedInUnexpectedLocation - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
This rule allows to define functions which should never throw an exception. If a function exists that does throw
an exception it will be reported. By default this rule is checking for toString, hashCode, equals and
finalize. This rule is configurable via the methodNames configuration to change the list of functions which
should not throw any exceptions.
- ExceptionRaisedInUnexpectedLocation(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ExceptionRaisedInUnexpectedLocation
-
This rule allows to define functions which should never throw an exception. If a function exists that does throw
an exception it will be reported. By default this rule is checking for toString, hashCode, equals and
finalize. This rule is configurable via the methodNames configuration to change the list of functions which
should not throw any exceptions.
- ExceptionRaisedInUnexpectedLocation() - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ExceptionRaisedInUnexpectedLocation
-
This rule allows to define functions which should never throw an exception. If a function exists that does throw
an exception it will be reported. By default this rule is checking for toString, hashCode, equals and
finalize. This rule is configurable via the methodNames configuration to change the list of functions which
should not throw any exceptions.
- ExceptionRaisedInUnexpectedLocation.Companion - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
- EXCEPTIONS - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingExceptionsWithoutMessageOrCause
-
- ExceptionsProvider - Class in io.gitlab.arturbosch.detekt.rules.providers
-
Rules in this rule set report issues related to how code throws and handles Exceptions.
- ExceptionsProvider() - Constructor for class io.gitlab.arturbosch.detekt.rules.providers.ExceptionsProvider
-
Rules in this rule set report issues related to how code throws and handles Exceptions.
- EXCLUDE_ANNOTATED_CLASSES - Static variable in class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryAbstractClass
-
- EXCLUDE_ANNOTATED_CLASSES - Static variable in class io.gitlab.arturbosch.detekt.rules.style.UseDataClass
-
- EXCLUDE_ANNOTATED_PROPERTIES - Static variable in class io.gitlab.arturbosch.detekt.rules.bugs.LateinitUsage
-
- EXCLUDE_CLASS_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.ConstructorParameterNaming
-
- EXCLUDE_CLASS_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionNaming
-
- EXCLUDE_CLASS_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionParameterNaming
-
- EXCLUDE_CLASS_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.VariableNaming
-
- EXCLUDE_COMMENT_STATEMENTS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MaxLineLength
-
- EXCLUDE_IMPORT_STATEMENTS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MaxLineLength
-
- EXCLUDE_LABELED - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ReturnCount
-
- EXCLUDE_PACKAGE_STATEMENTS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MaxLineLength
-
- EXCLUDE_RETURN_FROM_LAMBDA - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ReturnCount
-
- EXCLUDE_SHORT_STRING - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.StringLiteralDuplication
-
- EXCLUDED_FUNCTIONS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.FunctionOnlyReturningConstant
-
- EXCLUDED_FUNCTIONS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ReturnCount
-
- EXCLUDED_IMPORTS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.WildcardImport
-
- ExplicitGarbageCollectionCall - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Reports all calls to explicitly trigger the Garbage Collector.
Code should work independently of the garbage collector and should not require the GC to be triggered in certain
points in time.
- ExplicitGarbageCollectionCall(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.ExplicitGarbageCollectionCall
-
Reports all calls to explicitly trigger the Garbage Collector.
Code should work independently of the garbage collector and should not require the GC to be triggered in certain
points in time.
- ExplicitItLambdaParameter - Class in io.gitlab.arturbosch.detekt.rules.style
-
Lambda expressions are one of the core features of the language. They often include very small chunks of
code using only one parameter. In this cases Kotlin can supply the implicit it parameter
to make code more concise. It fits most usecases, but when faced larger or nested chunks of code,
you might want to add an explicit name for the parameter. Naming it just it is meaningless and only
makes your code misleading, especially when dealing with nested functions.
- ExplicitItLambdaParameter(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ExplicitItLambdaParameter
-
Lambda expressions are one of the core features of the language. They often include very small chunks of
code using only one parameter. In this cases Kotlin can supply the implicit it parameter
to make code more concise. It fits most usecases, but when faced larger or nested chunks of code,
you might want to add an explicit name for the parameter. Naming it just it is meaningless and only
makes your code misleading, especially when dealing with nested functions.
- ExpressionBodySyntax - Class in io.gitlab.arturbosch.detekt.rules.style
-
Functions which only contain a return statement can be collapsed to an expression body. This shortens and
cleans up the code.
- ExpressionBodySyntax(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ExpressionBodySyntax
-
Functions which only contain a return statement can be collapsed to an expression body. This shortens and
cleans up the code.
- ExpressionBodySyntax() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ExpressionBodySyntax
-
Functions which only contain a return statement can be collapsed to an expression body. This shortens and
cleans up the code.
- ExpressionBodySyntax.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- FileParsingRule - Class in io.gitlab.arturbosch.detekt.rules.style
-
- FileParsingRule(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.FileParsingRule
-
- FileParsingRule() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.FileParsingRule
-
- findTabs(file) - Method in class io.gitlab.arturbosch.detekt.rules.style.NoTabs
-
- FORBIDDEN_NAME - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.ForbiddenClassName
-
- ForbiddenClassName - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports class names which are forbidden per configuration.
By default this rule does not report any classes.
Examples for forbidden names might be too generic class names like ...Manager.
- ForbiddenClassName(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.ForbiddenClassName
-
Reports class names which are forbidden per configuration.
By default this rule does not report any classes.
Examples for forbidden names might be too generic class names like ...Manager.
- ForbiddenClassName() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.ForbiddenClassName
-
Reports class names which are forbidden per configuration.
By default this rule does not report any classes.
Examples for forbidden names might be too generic class names like ...Manager.
- ForbiddenClassName.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- ForbiddenComment - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule allows to set a list of comments which are forbidden in the codebase and should only be used during
development. Offending code comments will then be reported.
- ForbiddenComment(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ForbiddenComment
-
This rule allows to set a list of comments which are forbidden in the codebase and should only be used during
development. Offending code comments will then be reported.
- ForbiddenComment() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ForbiddenComment
-
This rule allows to set a list of comments which are forbidden in the codebase and should only be used during
development. Offending code comments will then be reported.
- ForbiddenComment.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- ForbiddenImport - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule allows to set a list of forbidden imports. This can be used to discourage the use of unstable, experimental
or deprecated APIs. Detekt will then report all imports that are forbidden.
- ForbiddenImport(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ForbiddenImport
-
This rule allows to set a list of forbidden imports. This can be used to discourage the use of unstable, experimental
or deprecated APIs. Detekt will then report all imports that are forbidden.
- ForbiddenImport() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ForbiddenImport
-
This rule allows to set a list of forbidden imports. This can be used to discourage the use of unstable, experimental
or deprecated APIs. Detekt will then report all imports that are forbidden.
- ForbiddenImport.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- ForbiddenVoid - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule detects usages of Void and reports them as forbidden.
The Kotlin type Unit should be used instead. This type corresponds to the Void class in Java
and has only one value - the Unit object.
- ForbiddenVoid(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ForbiddenVoid
-
This rule detects usages of Void and reports them as forbidden.
The Kotlin type Unit should be used instead. This type corresponds to the Void class in Java
and has only one value - the Unit object.
- ForbiddenVoid() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ForbiddenVoid
-
This rule detects usages of Void and reports them as forbidden.
The Kotlin type Unit should be used instead. This type corresponds to the Void class in Java
and has only one value - the Unit object.
- ForEachOnRange - Class in io.gitlab.arturbosch.detekt.rules.performance
-
Using the forEach method on ranges has a heavy performance cost. Prefer using simple for loops.
- ForEachOnRange(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.performance.ForEachOnRange
-
Using the forEach method on ranges has a heavy performance cost. Prefer using simple for loops.
- ForEachOnRange() - Constructor for class io.gitlab.arturbosch.detekt.rules.performance.ForEachOnRange
-
Using the forEach method on ranges has a heavy performance cost. Prefer using simple for loops.
- FUNCTION_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionNaming
-
- FunctionMaxLength - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports when very long function names are used.
- FunctionMaxLength(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.FunctionMaxLength
-
Reports when very long function names are used.
- FunctionMaxLength() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.FunctionMaxLength
-
Reports when very long function names are used.
- FunctionMaxLength.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- FunctionMinLength - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports when very short function names are used.
- FunctionMinLength(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.FunctionMinLength
-
Reports when very short function names are used.
- FunctionMinLength() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.FunctionMinLength
-
Reports when very short function names are used.
- FunctionMinLength.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- FunctionNaming - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports when function names which do not follow the specified naming convention are used.
- FunctionNaming(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.FunctionNaming
-
Reports when function names which do not follow the specified naming convention are used.
- FunctionNaming() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.FunctionNaming
-
Reports when function names which do not follow the specified naming convention are used.
- FunctionNaming.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- FunctionOnlyReturningConstant - Class in io.gitlab.arturbosch.detekt.rules.style
-
A function that only returns a single constant can be misleading. Instead prefer to define the constant directly
as a const val.
- FunctionOnlyReturningConstant(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.FunctionOnlyReturningConstant
-
A function that only returns a single constant can be misleading. Instead prefer to define the constant directly
as a const val.
- FunctionOnlyReturningConstant() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.FunctionOnlyReturningConstant
-
A function that only returns a single constant can be misleading. Instead prefer to define the constant directly
as a const val.
- FunctionOnlyReturningConstant.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- FunctionParameterNaming - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports function parameter names which do not follow the specified naming convention are used.
- FunctionParameterNaming(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.FunctionParameterNaming
-
Reports function parameter names which do not follow the specified naming convention are used.
- FunctionParameterNaming() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.FunctionParameterNaming
-
Reports function parameter names which do not follow the specified naming convention are used.
- FunctionParameterNaming.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- IdentifierNameKt - Class in io.gitlab.arturbosch.detekt.rules
-
- IGNORE_ANNOTATION - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.StringLiteralDuplication
-
- IGNORE_ANNOTATION - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- IGNORE_COMPANION_OBJECT_PROPERTY_DECLARATION - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- IGNORE_CONSTANT_DECLARATION - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- IGNORE_DEFAULT_PARAMETERS - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.LongParameterList
-
- IGNORE_DEPRECATED - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
- IGNORE_ENUMS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- IGNORE_HASH_CODE - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- IGNORE_NAMED_ARGUMENT - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- IGNORE_NUMBERS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- IGNORE_ON_CLASSES_PATTERN - Static variable in class io.gitlab.arturbosch.detekt.rules.bugs.LateinitUsage
-
- IGNORE_OVERRIDABLE_FUNCTION - Static variable in class io.gitlab.arturbosch.detekt.rules.style.FunctionOnlyReturningConstant
-
- IGNORE_OVERRIDDEN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionNaming
-
- IGNORE_OVERRIDDEN - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.VariableNaming
-
- IGNORE_OVERRIDDEN_FUNCTION - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.MemberNameEqualsClassName
-
- IGNORE_OVERRIDDEN_FUNCTIONS - Static variable in class io.gitlab.arturbosch.detekt.rules.empty.EmptyFunctionBlock
-
- IGNORE_OVERRIDDEN_FUNCTIONS - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionParameterNaming
-
- IGNORE_PRIVATE - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
- IGNORE_PROPERTY_DECLARATION - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
- IGNORE_SIMPLE_WHEN_ENTRIES - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.ComplexMethod
-
- IGNORE_SINGLE_WHEN_EXPRESSION - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.ComplexMethod
-
- IGNORE_STRINGS_REGEX - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.StringLiteralDuplication
-
- IGNORED_EXCEPTION_TYPES - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.SwallowedException
-
- IGNORED_LABELS - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.LabeledExpression
-
- IMPORTS - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ForbiddenImport
-
- INCLUDE_LINE_WRAPPING - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ExpressionBodySyntax
-
- INCLUDE_STATIC_DECLARATIONS - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.ComplexInterface
-
- instance(config) - Method in class io.gitlab.arturbosch.detekt.rules.providers.CommentSmellProvider
-
- instance(config) - Method in class io.gitlab.arturbosch.detekt.rules.providers.ComplexityProvider
-
- instance(config) - Method in class io.gitlab.arturbosch.detekt.rules.providers.EmptyCodeProvider
-
- instance(config) - Method in class io.gitlab.arturbosch.detekt.rules.providers.ExceptionsProvider
-
- instance(config) - Method in class io.gitlab.arturbosch.detekt.rules.providers.NamingProvider
-
- instance(config) - Method in class io.gitlab.arturbosch.detekt.rules.providers.PerformanceProvider
-
- instance(config) - Method in class io.gitlab.arturbosch.detekt.rules.providers.PotentialBugProvider
-
- instance(config) - Method in class io.gitlab.arturbosch.detekt.rules.providers.StyleGuideProvider
-
- InstanceOfCheckForException - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
This rule reports catch blocks which check for the type of an exception via is checks or casts.
Instead of catching generic exception types and then checking for specific exception types the code should
use multiple catch blocks. These catch blocks should then catch the specific exceptions.
- InstanceOfCheckForException(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.InstanceOfCheckForException
-
This rule reports catch blocks which check for the type of an exception via is checks or casts.
Instead of catching generic exception types and then checking for specific exception types the code should
use multiple catch blocks. These catch blocks should then catch the specific exceptions.
- InstanceOfCheckForException() - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.InstanceOfCheckForException
-
This rule reports catch blocks which check for the type of an exception via is checks or casts.
Instead of catching generic exception types and then checking for specific exception types the code should
use multiple catch blocks. These catch blocks should then catch the specific exceptions.
- InvalidRange - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Reports ranges which are empty.
This might be a bug if it is used for instance as a loop condition. This loop will never be triggered then.
This might be due to invalid ranges like (10..9) which will cause the loop to never be entered.
- InvalidRange(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.InvalidRange
-
Reports ranges which are empty.
This might be a bug if it is used for instance as a loop condition. This loop will never be triggered then.
This might be due to invalid ranges like (10..9) which will cause the loop to never be entered.
- InvalidRange() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.InvalidRange
-
Reports ranges which are empty.
This might be a bug if it is used for instance as a loop condition. This loop will never be triggered then.
This might be due to invalid ranges like (10..9) which will cause the loop to never be entered.
- io.gitlab.arturbosch.detekt.rules - package io.gitlab.arturbosch.detekt.rules
-
- io.gitlab.arturbosch.detekt.rules.bugs - package io.gitlab.arturbosch.detekt.rules.bugs
-
- io.gitlab.arturbosch.detekt.rules.complexity - package io.gitlab.arturbosch.detekt.rules.complexity
-
- io.gitlab.arturbosch.detekt.rules.documentation - package io.gitlab.arturbosch.detekt.rules.documentation
-
- io.gitlab.arturbosch.detekt.rules.empty - package io.gitlab.arturbosch.detekt.rules.empty
-
- io.gitlab.arturbosch.detekt.rules.exceptions - package io.gitlab.arturbosch.detekt.rules.exceptions
-
- io.gitlab.arturbosch.detekt.rules.naming - package io.gitlab.arturbosch.detekt.rules.naming
-
- io.gitlab.arturbosch.detekt.rules.performance - package io.gitlab.arturbosch.detekt.rules.performance
-
- io.gitlab.arturbosch.detekt.rules.providers - package io.gitlab.arturbosch.detekt.rules.providers
-
- io.gitlab.arturbosch.detekt.rules.style - package io.gitlab.arturbosch.detekt.rules.style
-
- io.gitlab.arturbosch.detekt.rules.style.optional - package io.gitlab.arturbosch.detekt.rules.style.optional
-
- isAbstract($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isConstant($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isEqualsFunction($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.MethodSignatureKt
-
- isExternal($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isHashCodeFunction($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.MethodSignatureKt
-
- isInline($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isInterface($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtClassOrObjectExtensionsKt
-
- isInternal($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isLateinit($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isMainFunction($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.MethodSignatureKt
-
- isMainInsideObject($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.MethodSignatureKt
-
- isObjectOfAnonymousClass($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.JunkKt
-
- isOpen($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isOperator($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isOverride($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isPartOf($receiver, clazz) - Static method in class io.gitlab.arturbosch.detekt.rules.IsPartOfUtilsKt
-
Tests if this element is part of given PsiElement.
- isPartOfString($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.IsPartOfUtilsKt
-
Tests if this element is part of a kotlin string.
- IsPartOfUtilsKt - Class in io.gitlab.arturbosch.detekt.rules
-
- isPublicNotOverridden($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.KtModifierListKt
-
- isTopLevelMain($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.MethodSignatureKt
-
- isUsedForNesting($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.JunkKt
-
- IT_LITERAL - Static variable in class io.gitlab.arturbosch.detekt.rules.KeywordsKt
-
This file contains common literals of keywords, library functions and other idioms of Kotlin language
- IteratorHasNextCallsNextMethod - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Verifies implementations of the Iterator interface.
The hasNext() method of an Iterator implementation should not have any side effects.
This rule reports implementations that call the next() method of the Iterator inside the hasNext() method.
- IteratorHasNextCallsNextMethod(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.IteratorHasNextCallsNextMethod
-
Verifies implementations of the Iterator interface.
The hasNext() method of an Iterator implementation should not have any side effects.
This rule reports implementations that call the next() method of the Iterator inside the hasNext() method.
- IteratorHasNextCallsNextMethod() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.IteratorHasNextCallsNextMethod
-
Verifies implementations of the Iterator interface.
The hasNext() method of an Iterator implementation should not have any side effects.
This rule reports implementations that call the next() method of the Iterator inside the hasNext() method.
- IteratorNotThrowingNoSuchElementException - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Reports implementations of the Iterator interface which do not throw a NoSuchElementException in the
implementation of the next() method. When there are no more elements to return an Iterator should throw a
NoSuchElementException.
- IteratorNotThrowingNoSuchElementException(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.IteratorNotThrowingNoSuchElementException
-
Reports implementations of the Iterator interface which do not throw a NoSuchElementException in the
implementation of the next() method. When there are no more elements to return an Iterator should throw a
NoSuchElementException.
- IteratorNotThrowingNoSuchElementException() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.IteratorNotThrowingNoSuchElementException
-
Reports implementations of the Iterator interface which do not throw a NoSuchElementException in the
implementation of the next() method. When there are no more elements to return an Iterator should throw a
NoSuchElementException.
- LabeledExpression - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
This rule reports labeled expressions. Expressions with labels generally increase complexity and worsen the
maintainability of the code. Refactor the violating code to not use labels instead.
Labeled expressions referencing an outer class with a label from an inner class are allowed, because there is no
way to get the instance of an outer class from an inner class in Kotlin.
- LabeledExpression(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.LabeledExpression
-
This rule reports labeled expressions. Expressions with labels generally increase complexity and worsen the
maintainability of the code. Refactor the violating code to not use labels instead.
Labeled expressions referencing an outer class with a label from an inner class are allowed, because there is no
way to get the instance of an outer class from an inner class in Kotlin.
- LabeledExpression() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.LabeledExpression
-
This rule reports labeled expressions. Expressions with labels generally increase complexity and worsen the
maintainability of the code. Refactor the violating code to not use labels instead.
Labeled expressions referencing an outer class with a label from an inner class are allowed, because there is no
way to get the instance of an outer class from an inner class in Kotlin.
- LabeledExpression.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- LargeClass - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
This rule reports large classes. Classes should generally have one responsibility. Large classes can indicate that
the class does instead handle multiple responsibilities. Instead of doing many things at once prefer to
split up large classes into smaller classes. These smaller classes are then easier to understand and handle less
things.
- LargeClass(config, threshold) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.LargeClass
-
This rule reports large classes. Classes should generally have one responsibility. Large classes can indicate that
the class does instead handle multiple responsibilities. Instead of doing many things at once prefer to
split up large classes into smaller classes. These smaller classes are then easier to understand and handle less
things.
- LargeClass() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.LargeClass
-
This rule reports large classes. Classes should generally have one responsibility. Large classes can indicate that
the class does instead handle multiple responsibilities. Instead of doing many things at once prefer to
split up large classes into smaller classes. These smaller classes are then easier to understand and handle less
things.
- LargeClass.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- LateinitUsage - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Turn on this rule to flag usages of the lateinit modifier.
- LateinitUsage(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.LateinitUsage
-
Turn on this rule to flag usages of the lateinit modifier.
- LateinitUsage() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.LateinitUsage
-
Turn on this rule to flag usages of the lateinit modifier.
- LateinitUsage.Companion - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
- LET_LITERAL - Static variable in class io.gitlab.arturbosch.detekt.rules.KeywordsKt
-
- line($receiver, inFile) - Static method in class io.gitlab.arturbosch.detekt.rules.LinesOfCodeKt
-
- linesOfCode($receiver) - Static method in class io.gitlab.arturbosch.detekt.rules.LinesOfCodeKt
-
- linesOfCode($receiver, inFile) - Static method in class io.gitlab.arturbosch.detekt.rules.LinesOfCodeKt
-
- LinesOfCodeKt - Class in io.gitlab.arturbosch.detekt.rules
-
- LongMethod - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
Methods should have one responsibility. Long methods can indicate that a method handles too many cases at once.
Prefer smaller methods with clear names that describe their functionality clearly.
- LongMethod(config, threshold) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.LongMethod
-
Methods should have one responsibility. Long methods can indicate that a method handles too many cases at once.
Prefer smaller methods with clear names that describe their functionality clearly.
- LongMethod() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.LongMethod
-
Methods should have one responsibility. Long methods can indicate that a method handles too many cases at once.
Prefer smaller methods with clear names that describe their functionality clearly.
- LongMethod.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- LongParameterList - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
Reports functions which have more parameters than a certain threshold (default: 6).
- LongParameterList(config, threshold) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.LongParameterList
-
Reports functions which have more parameters than a certain threshold (default: 6).
- LongParameterList() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.LongParameterList
-
Reports functions which have more parameters than a certain threshold (default: 6).
- LongParameterList.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- LoopWithTooManyJumpStatements - Class in io.gitlab.arturbosch.detekt.rules.style
-
Loops which contain multiple break or continue statements are hard to read and understand.
To increase readability they should be refactored into simpler loops.
- LoopWithTooManyJumpStatements(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.LoopWithTooManyJumpStatements
-
Loops which contain multiple break or continue statements are hard to read and understand.
To increase readability they should be refactored into simpler loops.
- LoopWithTooManyJumpStatements() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.LoopWithTooManyJumpStatements
-
Loops which contain multiple break or continue statements are hard to read and understand.
To increase readability they should be refactored into simpler loops.
- LoopWithTooManyJumpStatements.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- MagicNumber - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule detects and reports usages of magic numbers in the code. Prefer defining constants with clear names
describing what the magic number means.
- MagicNumber(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
This rule detects and reports usages of magic numbers in the code. Prefer defining constants with clear names
describing what the magic number means.
- MagicNumber() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.MagicNumber
-
This rule detects and reports usages of magic numbers in the code. Prefer defining constants with clear names
describing what the magic number means.
- MagicNumber.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- MagicNumberKt - Class in io.gitlab.arturbosch.detekt.rules.style
-
- MandatoryBracesIfStatements - Class in io.gitlab.arturbosch.detekt.rules.style.optional
-
This rule detects multi-line if statements which do not have braces.
Adding braces would improve readability and avoid possible errors.
- MandatoryBracesIfStatements(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.optional.MandatoryBracesIfStatements
-
This rule detects multi-line if statements which do not have braces.
Adding braces would improve readability and avoid possible errors.
- MandatoryBracesIfStatements() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.optional.MandatoryBracesIfStatements
-
This rule detects multi-line if statements which do not have braces.
Adding braces would improve readability and avoid possible errors.
- MatchingDeclarationName - Class in io.gitlab.arturbosch.detekt.rules.naming
-
"If a Kotlin file contains a single non-private class (potentially with related top-level declarations),
its name should be the same as the name of the class, with the .kt extension appended.
If a file contains multiple classes, or only top-level declarations,
choose a name describing what the file contains, and name the file accordingly.
Use camel humps with an uppercase first letter (e.g. ProcessDeclarations.kt).
- MatchingDeclarationName(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.MatchingDeclarationName
-
"If a Kotlin file contains a single non-private class (potentially with related top-level declarations),
its name should be the same as the name of the class, with the .kt extension appended.
If a file contains multiple classes, or only top-level declarations,
choose a name describing what the file contains, and name the file accordingly.
Use camel humps with an uppercase first letter (e.g. ProcessDeclarations.kt).
- MatchingDeclarationName() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.MatchingDeclarationName
-
"If a Kotlin file contains a single non-private class (potentially with related top-level declarations),
its name should be the same as the name of the class, with the .kt extension appended.
If a file contains multiple classes, or only top-level declarations,
choose a name describing what the file contains, and name the file accordingly.
Use camel humps with an uppercase first letter (e.g. ProcessDeclarations.kt).
- MatchingDeclarationNameKt - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- MAX - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ReturnCount
-
- MAX - Static variable in class io.gitlab.arturbosch.detekt.rules.style.ThrowsCount
-
- MAX_JUMP_COUNT - Static variable in class io.gitlab.arturbosch.detekt.rules.style.LoopWithTooManyJumpStatements
-
- MAX_LINE_LENGTH - Static variable in class io.gitlab.arturbosch.detekt.rules.style.MaxLineLength
-
- MAXIMUM_FUNCTION_NAME_LENGTH - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionMaxLength
-
- MAXIMUM_VARIABLE_NAME_LENGTH - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.VariableMaxLength
-
- MaxLineLength - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule reports lines of code which exceed a defined maximum line length.
- MaxLineLength(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.MaxLineLength
-
This rule reports lines of code which exceed a defined maximum line length.
- MaxLineLength() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.MaxLineLength
-
This rule reports lines of code which exceed a defined maximum line length.
- MaxLineLength.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- MayBeConst - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule identifies and reports properties (val) that may be const val instead.
Using const val can lead to better performance of the resulting bytecode as well as better interoperability with
Java.
- MayBeConst(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.MayBeConst
-
This rule identifies and reports properties (val) that may be const val instead.
Using const val can lead to better performance of the resulting bytecode as well as better interoperability with
Java.
- MayBeConst() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.MayBeConst
-
This rule identifies and reports properties (val) that may be const val instead.
Using const val can lead to better performance of the resulting bytecode as well as better interoperability with
Java.
- MemberNameEqualsClassName - Class in io.gitlab.arturbosch.detekt.rules.naming
-
This rule reports a member that has the same as the containing class or object.
This might result in confusion.
The member should either be renamed or changed to a constructor.
Factory functions that create an instance of the class are exempt from this rule.
- MemberNameEqualsClassName(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.MemberNameEqualsClassName
-
This rule reports a member that has the same as the containing class or object.
This might result in confusion.
The member should either be renamed or changed to a constructor.
Factory functions that create an instance of the class are exempt from this rule.
- MemberNameEqualsClassName() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.MemberNameEqualsClassName
-
This rule reports a member that has the same as the containing class or object.
This might result in confusion.
The member should either be renamed or changed to a constructor.
Factory functions that create an instance of the class are exempt from this rule.
- MemberNameEqualsClassName.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- MESSAGE - Static variable in class io.gitlab.arturbosch.detekt.rules.style.EqualsOnSignatureLine
-
- METHOD_NAMES - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.ExceptionRaisedInUnexpectedLocation
-
- MethodOverloading - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
This rule reports methods which are overloaded often.
Method overloading tightly couples these methods together which might make the code harder to understand.
- MethodOverloading(config, threshold) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.MethodOverloading
-
This rule reports methods which are overloaded often.
Method overloading tightly couples these methods together which might make the code harder to understand.
- MethodOverloading() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.MethodOverloading
-
This rule reports methods which are overloaded often.
Method overloading tightly couples these methods together which might make the code harder to understand.
- MethodOverloading.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- MethodSignatureKt - Class in io.gitlab.arturbosch.detekt.rules
-
- MINIMUM_FUNCTION_NAME_LENGTH - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.FunctionMinLength
-
- MINIMUM_VARIABLE_NAME_LENGTH - Static variable in class io.gitlab.arturbosch.detekt.rules.naming.VariableMinLength
-
- ModifierOrder - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule reports cases in the code where modifiers are not in the correct order. The default modifier order is
taken from: http://kotlinlang.org/docs/reference/coding-conventions.html#modifiers
- ModifierOrder(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ModifierOrder
-
This rule reports cases in the code where modifiers are not in the correct order. The default modifier order is
taken from: http://kotlinlang.org/docs/reference/coding-conventions.html#modifiers
- ModifierOrder() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ModifierOrder
-
This rule reports cases in the code where modifiers are not in the correct order. The default modifier order is
taken from: http://kotlinlang.org/docs/reference/coding-conventions.html#modifiers
- SafeCast - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule inspects casts and reports casts which could be replaced with safe casts instead.
- SafeCast(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.SafeCast
-
This rule inspects casts and reports casts which could be replaced with safe casts instead.
- SafeCast() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.SafeCast
-
This rule inspects casts and reports casts which could be replaced with safe casts instead.
- SEARCH_IN_INNER_CLASS - Static variable in class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicClass
-
- SEARCH_IN_INNER_INTERFACE - Static variable in class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicClass
-
- SEARCH_IN_INNER_OBJECT - Static variable in class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicClass
-
- SEARCH_IN_NESTED_CLASS - Static variable in class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicClass
-
- SerialVersionUIDInSerializableClass - Class in io.gitlab.arturbosch.detekt.rules.style
-
Classes which implement the Serializable interface should also correctly declare a serialVersionUID.
This rule verifies that a serialVersionUID was correctly defined.
- SerialVersionUIDInSerializableClass(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.SerialVersionUIDInSerializableClass
-
Classes which implement the Serializable interface should also correctly declare a serialVersionUID.
This rule verifies that a serialVersionUID was correctly defined.
- SerialVersionUIDInSerializableClass() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.SerialVersionUIDInSerializableClass
-
Classes which implement the Serializable interface should also correctly declare a serialVersionUID.
This rule verifies that a serialVersionUID was correctly defined.
- setProperties(p) - Method in class io.gitlab.arturbosch.detekt.rules.bugs.UselessPostfixExpression
-
- SpacingBetweenPackageAndImports - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule verifies spacing between package and import statements as well as between import statements and class
declarations.
- SpacingBetweenPackageAndImports(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.SpacingBetweenPackageAndImports
-
This rule verifies spacing between package and import statements as well as between import statements and class
declarations.
- SpacingBetweenPackageAndImports() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.SpacingBetweenPackageAndImports
-
This rule verifies spacing between package and import statements as well as between import statements and class
declarations.
- SpreadOperator - Class in io.gitlab.arturbosch.detekt.rules.performance
-
Using a spread operator causes a full copy of the array to be created before calling a method.
This has a very high performance penalty.
Benchmarks showing this performance penalty can be seen here:
https://sites.google.com/a/athaydes.com/renato-athaydes/posts/kotlinshiddencosts-benchmarks
- SpreadOperator(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.performance.SpreadOperator
-
Using a spread operator causes a full copy of the array to be created before calling a method.
This has a very high performance penalty.
Benchmarks showing this performance penalty can be seen here:
https://sites.google.com/a/athaydes.com/renato-athaydes/posts/kotlinshiddencosts-benchmarks
- SpreadOperator() - Constructor for class io.gitlab.arturbosch.detekt.rules.performance.SpreadOperator
-
Using a spread operator causes a full copy of the array to be created before calling a method.
This has a very high performance penalty.
Benchmarks showing this performance penalty can be seen here:
https://sites.google.com/a/athaydes.com/renato-athaydes/posts/kotlinshiddencosts-benchmarks
- STRING_EXCLUSION_LENGTH - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.StringLiteralDuplication
-
- StringExtensionsKt - Class in io.gitlab.arturbosch.detekt.rules
-
- StringLiteralDuplication - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
This rule detects and reports duplicated String literals. Repeatedly typing out the same String literal across the
codebase makes it harder to change and maintain.
- StringLiteralDuplication(config, threshold) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.StringLiteralDuplication
-
This rule detects and reports duplicated String literals. Repeatedly typing out the same String literal across the
codebase makes it harder to change and maintain.
- StringLiteralDuplication() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.StringLiteralDuplication
-
This rule detects and reports duplicated String literals. Repeatedly typing out the same String literal across the
codebase makes it harder to change and maintain.
- StringLiteralDuplication.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- StyleGuideProvider - Class in io.gitlab.arturbosch.detekt.rules.providers
-
The Style ruleset provides rules that assert the style of the code.
This will help keep code in line with the given
code style guidelines.
- StyleGuideProvider() - Constructor for class io.gitlab.arturbosch.detekt.rules.providers.StyleGuideProvider
-
The Style ruleset provides rules that assert the style of the code.
This will help keep code in line with the given
code style guidelines.
- SwallowedException - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
Exceptions should not be swallowed. This rule reports all instances where exceptions are caught and not correctly
passed into a newly thrown exception.
- SwallowedException(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.SwallowedException
-
Exceptions should not be swallowed. This rule reports all instances where exceptions are caught and not correctly
passed into a newly thrown exception.
- SwallowedException() - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.SwallowedException
-
Exceptions should not be swallowed. This rule reports all instances where exceptions are caught and not correctly
passed into a newly thrown exception.
- SwallowedException.Companion - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
- THRESHOLD_IN_CLASSES - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
- THRESHOLD_IN_ENUMS - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
- THRESHOLD_IN_FILES - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
- THRESHOLD_IN_INTERFACES - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
- THRESHOLD_IN_OBJECTS - Static variable in class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
- ThrowingExceptionFromFinally - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
This rule reports all cases where exceptions are thrown from a finally block. Throwing exceptions from a finally
block should be avoided as it can lead to confusion and discarded exceptions.
- ThrowingExceptionFromFinally(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingExceptionFromFinally
-
This rule reports all cases where exceptions are thrown from a finally block. Throwing exceptions from a finally
block should be avoided as it can lead to confusion and discarded exceptions.
- ThrowingExceptionFromFinally() - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingExceptionFromFinally
-
This rule reports all cases where exceptions are thrown from a finally block. Throwing exceptions from a finally
block should be avoided as it can lead to confusion and discarded exceptions.
- ThrowingExceptionInMain - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
This rule reports all exceptions that are thrown in a main method.
An exception should only be thrown if it can be handled by a "higher" function.
- ThrowingExceptionInMain(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingExceptionInMain
-
This rule reports all exceptions that are thrown in a main method.
An exception should only be thrown if it can be handled by a "higher" function.
- ThrowingExceptionInMain() - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingExceptionInMain
-
This rule reports all exceptions that are thrown in a main method.
An exception should only be thrown if it can be handled by a "higher" function.
- ThrowingExceptionsWithoutMessageOrCause - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
This rule reports all exceptions which are thrown without arguments or further description.
Exceptions should always call one of the constructor overloads to provide a message or a cause.
Exceptions should be meaningful and contain as much detail about the error case as possible. This will help to track
down an underlying issue in a better way.
- ThrowingExceptionsWithoutMessageOrCause(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingExceptionsWithoutMessageOrCause
-
This rule reports all exceptions which are thrown without arguments or further description.
Exceptions should always call one of the constructor overloads to provide a message or a cause.
Exceptions should be meaningful and contain as much detail about the error case as possible. This will help to track
down an underlying issue in a better way.
- ThrowingExceptionsWithoutMessageOrCause() - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingExceptionsWithoutMessageOrCause
-
This rule reports all exceptions which are thrown without arguments or further description.
Exceptions should always call one of the constructor overloads to provide a message or a cause.
Exceptions should be meaningful and contain as much detail about the error case as possible. This will help to track
down an underlying issue in a better way.
- ThrowingExceptionsWithoutMessageOrCause.Companion - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
- ThrowingNewInstanceOfSameException - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
Exceptions should not be wrapped inside the same exception type and then rethrown. Prefer wrapping exceptions in more
meaningful exception types.
- ThrowingNewInstanceOfSameException(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingNewInstanceOfSameException
-
Exceptions should not be wrapped inside the same exception type and then rethrown. Prefer wrapping exceptions in more
meaningful exception types.
- ThrowingNewInstanceOfSameException() - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.ThrowingNewInstanceOfSameException
-
Exceptions should not be wrapped inside the same exception type and then rethrown. Prefer wrapping exceptions in more
meaningful exception types.
- THROWN_EXCEPTIONS_PROPERTY - Static variable in class io.gitlab.arturbosch.detekt.rules.exceptions.TooGenericExceptionThrown
-
- ThrowsCount - Class in io.gitlab.arturbosch.detekt.rules.style
-
Functions should have clear throw statements. Functions with many throw statements can be harder to read and lead
to confusion. Instead prefer to limit the amount of throw statements in a function.
- ThrowsCount(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ThrowsCount
-
Functions should have clear throw statements. Functions with many throw statements can be harder to read and lead
to confusion. Instead prefer to limit the amount of throw statements in a function.
- ThrowsCount() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.ThrowsCount
-
Functions should have clear throw statements. Functions with many throw statements can be harder to read and lead
to confusion. Instead prefer to limit the amount of throw statements in a function.
- ThrowsCount.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- tokenSequence($receiver, skipTreesOf) - Static method in class io.gitlab.arturbosch.detekt.rules.LinesOfCodeKt
-
- TooGenericExceptionCaught - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
This rule reports catch blocks for exceptions that have a type that is too generic.
It should be preferred to catch specific exceptions to the case that is currently handled. If the scope of the caught
exception is too broad it can lead to unintended exceptions being caught.
- TooGenericExceptionCaught(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.TooGenericExceptionCaught
-
This rule reports catch blocks for exceptions that have a type that is too generic.
It should be preferred to catch specific exceptions to the case that is currently handled. If the scope of the caught
exception is too broad it can lead to unintended exceptions being caught.
- TooGenericExceptionCaught.Companion - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
- TooGenericExceptionCaughtKt - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
- TooGenericExceptionThrown - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
This rule reports thrown exceptions that have a type that is too generic. It should be preferred to throw specific
exceptions to the case that has currently occurred.
- TooGenericExceptionThrown(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.exceptions.TooGenericExceptionThrown
-
This rule reports thrown exceptions that have a type that is too generic. It should be preferred to throw specific
exceptions to the case that has currently occurred.
- TooGenericExceptionThrown.Companion - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
- TooGenericExceptionThrownKt - Class in io.gitlab.arturbosch.detekt.rules.exceptions
-
- TooManyFunctions - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
This rule reports files, classes, interfaces, objects and enums which contain too many functions.
Each element can be configured with different thresholds.
- TooManyFunctions(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
This rule reports files, classes, interfaces, objects and enums which contain too many functions.
Each element can be configured with different thresholds.
- TooManyFunctions() - Constructor for class io.gitlab.arturbosch.detekt.rules.complexity.TooManyFunctions
-
This rule reports files, classes, interfaces, objects and enums which contain too many functions.
Each element can be configured with different thresholds.
- TooManyFunctions.Companion - Class in io.gitlab.arturbosch.detekt.rules.complexity
-
- TopLevelPropertyNaming - Class in io.gitlab.arturbosch.detekt.rules.naming
-
Reports when top level constant names which do not follow the specified naming convention are used.
- TopLevelPropertyNaming(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.TopLevelPropertyNaming
-
Reports when top level constant names which do not follow the specified naming convention are used.
- TopLevelPropertyNaming() - Constructor for class io.gitlab.arturbosch.detekt.rules.naming.TopLevelPropertyNaming
-
Reports when top level constant names which do not follow the specified naming convention are used.
- TopLevelPropertyNaming.Companion - Class in io.gitlab.arturbosch.detekt.rules.naming
-
- toString() - Method in class io.gitlab.arturbosch.detekt.rules.style.KtFileContent
-
- TrailingWhitespace - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule reports lines that end with a whitespace.
- TrailingWhitespace(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.TrailingWhitespace
-
This rule reports lines that end with a whitespace.
- TrailingWhitespace() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.TrailingWhitespace
-
This rule reports lines that end with a whitespace.
- TraversingKt - Class in io.gitlab.arturbosch.detekt.rules
-
- UnconditionalJumpStatementInLoop - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Reports loops which contain jump statements that jump regardless of any conditions.
This implies that the loop is only executed once and thus could be rewritten without a
loop altogether.
- UnconditionalJumpStatementInLoop(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UnconditionalJumpStatementInLoop
-
Reports loops which contain jump statements that jump regardless of any conditions.
This implies that the loop is only executed once and thus could be rewritten without a
loop altogether.
- UnconditionalJumpStatementInLoop() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UnconditionalJumpStatementInLoop
-
Reports loops which contain jump statements that jump regardless of any conditions.
This implies that the loop is only executed once and thus could be rewritten without a
loop altogether.
- UndocumentedPublicClass - Class in io.gitlab.arturbosch.detekt.rules.documentation
-
This rule reports public classes, objects and interfaces which do not have the required documentation.
Enable this rule if the codebase should have documentation on every public class, interface and object.
- UndocumentedPublicClass(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicClass
-
This rule reports public classes, objects and interfaces which do not have the required documentation.
Enable this rule if the codebase should have documentation on every public class, interface and object.
- UndocumentedPublicClass() - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicClass
-
This rule reports public classes, objects and interfaces which do not have the required documentation.
Enable this rule if the codebase should have documentation on every public class, interface and object.
- UndocumentedPublicClass.Companion - Class in io.gitlab.arturbosch.detekt.rules.documentation
-
- UndocumentedPublicFunction - Class in io.gitlab.arturbosch.detekt.rules.documentation
-
This rule will report any public function which does not have the required documentation.
If the codebase should have documentation on all public functions enable this rule to enforce this.
- UndocumentedPublicFunction(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicFunction
-
This rule will report any public function which does not have the required documentation.
If the codebase should have documentation on all public functions enable this rule to enforce this.
- UndocumentedPublicFunction() - Constructor for class io.gitlab.arturbosch.detekt.rules.documentation.UndocumentedPublicFunction
-
This rule will report any public function which does not have the required documentation.
If the codebase should have documentation on all public functions enable this rule to enforce this.
- UnnecessaryAbstractClass - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule inspects abstract classes. In case an abstract class does not have any concrete members it should be
refactored into an interface. Abstract classes which do not define any abstract members should instead be
refactored into concrete classes.
- UnnecessaryAbstractClass(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryAbstractClass
-
This rule inspects abstract classes. In case an abstract class does not have any concrete members it should be
refactored into an interface. Abstract classes which do not define any abstract members should instead be
refactored into concrete classes.
- UnnecessaryAbstractClass() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryAbstractClass
-
This rule inspects abstract classes. In case an abstract class does not have any concrete members it should be
refactored into an interface. Abstract classes which do not define any abstract members should instead be
refactored into concrete classes.
- UnnecessaryAbstractClass.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- UnnecessaryApply - Class in io.gitlab.arturbosch.detekt.rules.style
-
apply expressions are used frequently, but sometimes their usage should be replaced with
an ordinary method/extension function call to reduce visual complexity
- UnnecessaryApply(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryApply
-
apply expressions are used frequently, but sometimes their usage should be replaced with
an ordinary method/extension function call to reduce visual complexity
- UnnecessaryApplyKt - Class in io.gitlab.arturbosch.detekt.rules.style
-
- UnnecessaryInheritance - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule reports unnecessary super types. Inheriting from Any or Object is unnecessary and should simply be
removed.
- UnnecessaryInheritance(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryInheritance
-
This rule reports unnecessary super types. Inheriting from Any or Object is unnecessary and should simply be
removed.
- UnnecessaryInheritance() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryInheritance
-
This rule reports unnecessary super types. Inheriting from Any or Object is unnecessary and should simply be
removed.
- UnnecessaryLet - Class in io.gitlab.arturbosch.detekt.rules.style
-
let expressions are used extensively in our code for null-checking and chaining functions,
but sometimes their usage should be replaced with a ordinary method/extension function call
to reduce visual complexity
- UnnecessaryLet(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryLet
-
let expressions are used extensively in our code for null-checking and chaining functions,
but sometimes their usage should be replaced with a ordinary method/extension function call
to reduce visual complexity
- UnnecessaryLetKt - Class in io.gitlab.arturbosch.detekt.rules.style
-
- UnnecessaryParentheses - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule reports unnecessary parentheses around expressions.
These unnecessary parentheses can safely be removed.
- UnnecessaryParentheses(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryParentheses
-
This rule reports unnecessary parentheses around expressions.
These unnecessary parentheses can safely be removed.
- UnnecessaryParentheses() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnnecessaryParentheses
-
This rule reports unnecessary parentheses around expressions.
These unnecessary parentheses can safely be removed.
- UnnecessaryTemporaryInstantiation - Class in io.gitlab.arturbosch.detekt.rules.performance
-
Avoid temporary objects when converting primitive types to String. This has a performance penalty when compared
to using primitive types directly.
To solve this issue, remove the wrapping type.
- UnnecessaryTemporaryInstantiation(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.performance.UnnecessaryTemporaryInstantiation
-
Avoid temporary objects when converting primitive types to String. This has a performance penalty when compared
to using primitive types directly.
To solve this issue, remove the wrapping type.
- UnnecessaryTemporaryInstantiation() - Constructor for class io.gitlab.arturbosch.detekt.rules.performance.UnnecessaryTemporaryInstantiation
-
Avoid temporary objects when converting primitive types to String. This has a performance penalty when compared
to using primitive types directly.
To solve this issue, remove the wrapping type.
- UnreachableCode - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Reports unreachable code.
Code can be unreachable because it is behind return, throw, continue or break expressions.
This unreachable code should be removed as it serves no purpose.
- UnreachableCode(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UnreachableCode
-
Reports unreachable code.
Code can be unreachable because it is behind return, throw, continue or break expressions.
This unreachable code should be removed as it serves no purpose.
- UnreachableCode() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UnreachableCode
-
Reports unreachable code.
Code can be unreachable because it is behind return, throw, continue or break expressions.
This unreachable code should be removed as it serves no purpose.
- UnsafeCallOnNullableType - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Reports unsafe calls on nullable types. These calls will throw a NullPointerException in case
the nullable value is null. Kotlin provides many ways to work with nullable types to increase
null safety. Guard the code appropriately to prevent NullPointerExceptions.
- UnsafeCallOnNullableType(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UnsafeCallOnNullableType
-
Reports unsafe calls on nullable types. These calls will throw a NullPointerException in case
the nullable value is null. Kotlin provides many ways to work with nullable types to increase
null safety. Guard the code appropriately to prevent NullPointerExceptions.
- UnsafeCallOnNullableType() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UnsafeCallOnNullableType
-
Reports unsafe calls on nullable types. These calls will throw a NullPointerException in case
the nullable value is null. Kotlin provides many ways to work with nullable types to increase
null safety. Guard the code appropriately to prevent NullPointerExceptions.
- UnsafeCast - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
Reports casts which are unsafe. In case the cast is not possible it will throw an exception.
- UnsafeCast(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UnsafeCast
-
Reports casts which are unsafe. In case the cast is not possible it will throw an exception.
- UnsafeCast() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UnsafeCast
-
Reports casts which are unsafe. In case the cast is not possible it will throw an exception.
- UntilInsteadOfRangeTo - Class in io.gitlab.arturbosch.detekt.rules.style
-
Reports calls to '..' operator instead of calls to 'until'.
'until' is applicable in cases where the upper range value is described as
some value subtracted by 1. 'until' helps to prevent off-by-one errors.
- UntilInsteadOfRangeTo(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UntilInsteadOfRangeTo
-
Reports calls to '..' operator instead of calls to 'until'.
'until' is applicable in cases where the upper range value is described as
some value subtracted by 1. 'until' helps to prevent off-by-one errors.
- UntilInsteadOfRangeTo() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UntilInsteadOfRangeTo
-
Reports calls to '..' operator instead of calls to 'until'.
'until' is applicable in cases where the upper range value is described as
some value subtracted by 1. 'until' helps to prevent off-by-one errors.
- UnusedImports - Class in io.gitlab.arturbosch.detekt.rules.style
-
This rule reports unused imports. Unused imports are dead code and should be removed.
- UnusedImports(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnusedImports
-
This rule reports unused imports. Unused imports are dead code and should be removed.
- UnusedImports.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- UnusedImportsKt - Class in io.gitlab.arturbosch.detekt.rules.style
-
- UnusedPrivateClass - Class in io.gitlab.arturbosch.detekt.rules.style
-
Reports unused private classes.
If private classes are unused they should be removed. Otherwise this dead code
can lead to confusion and potential bugs.
- UnusedPrivateClass(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnusedPrivateClass
-
Reports unused private classes.
If private classes are unused they should be removed. Otherwise this dead code
can lead to confusion and potential bugs.
- UnusedPrivateClass() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnusedPrivateClass
-
Reports unused private classes.
If private classes are unused they should be removed. Otherwise this dead code
can lead to confusion and potential bugs.
- UnusedPrivateClassKt - Class in io.gitlab.arturbosch.detekt.rules.style
-
- UnusedPrivateMember - Class in io.gitlab.arturbosch.detekt.rules.style
-
Reports unused private properties, function parameters and functions.
If private properties are unused they should be removed. Otherwise this dead code
can lead to confusion and potential bugs.
- UnusedPrivateMember(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnusedPrivateMember
-
Reports unused private properties, function parameters and functions.
If private properties are unused they should be removed. Otherwise this dead code
can lead to confusion and potential bugs.
- UnusedPrivateMember() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UnusedPrivateMember
-
Reports unused private properties, function parameters and functions.
If private properties are unused they should be removed. Otherwise this dead code
can lead to confusion and potential bugs.
- UnusedPrivateMember.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- UseDataClass - Class in io.gitlab.arturbosch.detekt.rules.style
-
Classes that simply hold data should be refactored into a data class. Data classes are specialized to hold data
and generate hashCode, equals and toString implementations as well.
- UseDataClass(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UseDataClass
-
Classes that simply hold data should be refactored into a data class. Data classes are specialized to hold data
and generate hashCode, equals and toString implementations as well.
- UseDataClass() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UseDataClass
-
Classes that simply hold data should be refactored into a data class. Data classes are specialized to hold data
and generate hashCode, equals and toString implementations as well.
- UseDataClass.Companion - Class in io.gitlab.arturbosch.detekt.rules.style
-
- UselessPostfixExpression - Class in io.gitlab.arturbosch.detekt.rules.bugs
-
This rule reports postfix expressions (++, --) which are unused and thus unnecessary.
This leads to confusion as a reader of the code might think the value will be incremented/decremented.
However the value is replaced with the original value which might lead to bugs.
- UselessPostfixExpression(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UselessPostfixExpression
-
This rule reports postfix expressions (++, --) which are unused and thus unnecessary.
This leads to confusion as a reader of the code might think the value will be incremented/decremented.
However the value is replaced with the original value which might lead to bugs.
- UselessPostfixExpression() - Constructor for class io.gitlab.arturbosch.detekt.rules.bugs.UselessPostfixExpression
-
This rule reports postfix expressions (++, --) which are unused and thus unnecessary.
This leads to confusion as a reader of the code might think the value will be incremented/decremented.
However the value is replaced with the original value which might lead to bugs.
- UtilityClassWithPublicConstructor - Class in io.gitlab.arturbosch.detekt.rules.style
-
A class which only contains utility variables and functions with no concrete implementation can be refactored
into an object or an class with a non-public constructor.
Furthermore, this rule reports utility classes which are not final.
- UtilityClassWithPublicConstructor(config) - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UtilityClassWithPublicConstructor
-
A class which only contains utility variables and functions with no concrete implementation can be refactored
into an object or an class with a non-public constructor.
Furthermore, this rule reports utility classes which are not final.
- UtilityClassWithPublicConstructor() - Constructor for class io.gitlab.arturbosch.detekt.rules.style.UtilityClassWithPublicConstructor
-
A class which only contains utility variables and functions with no concrete implementation can be refactored
into an object or an class with a non-public constructor.
Furthermore, this rule reports utility classes which are not final.