boolean expressions used twice that can be factorized, in order to reduce redundancy and improve the readability.
+Reports any boolean expressions used twice that can be factorized in order to reduce redundancy and improve readability of your code.
Example:
a && b || a && c
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassWithoutLogger.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassWithoutLogger.html
index 29dfed20d72b..9c010eedce09 100644
--- a/plugins/InspectionGadgets/src/inspectionDescriptions/ClassWithoutLogger.html
+++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ClassWithoutLogger.html
@@ -1,8 +1,8 @@
-Reports classes which do not have a logger declared.
-Ensuring that every class has a dedicated logger is an important step in providing a unified logging
-implementation for an application. Interfaces, enumerations, annotations, inner classes, and abstract classes are not reported by this inspection.
+Reports classes which do not have a declared logger.
+Ensuring that every class has a dedicated logger is an important step in providing a unified logging
+ implementation for an application. Interfaces, enumerations, annotations, inner classes, and abstract classes are not reported by this inspection.
For example:
public class NoLoggerDeclared {
@@ -15,8 +15,8 @@ implementation for an application. Interfaces, enumerations, annotations, inner
-Use the table below to specify logger class names.
-Classes which do not declare a field with the type of one of the classes specified, will be reported by this inspection.
+ Use the table in the Options section to specify logger class names.
+Classes which do not declare a field with the type of one of the specified classes will be reported by this inspection.
\ No newline at end of file
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/FieldCanBeMovedToSubclass.html b/plugins/InspectionGadgets/src/inspectionDescriptions/FieldCanBeMovedToSubclass.html
index 53e5dcdbfc1e..c03ac8306824 100644
--- a/plugins/InspectionGadgets/src/inspectionDescriptions/FieldCanBeMovedToSubclass.html
+++ b/plugins/InspectionGadgets/src/inspectionDescriptions/FieldCanBeMovedToSubclass.html
@@ -1,8 +1,8 @@
Reports any instance fields which can be moved to a subclass.
-Because this inspection requires global code analysis it is only available for Analyze|Inspect Code or
-Analyze|Run Inspection by Name and it will not report in the editor.
+Since this inspection requires a global code analysis, it is available only from Code | Inspect Code or
+ Code | Analyze Code | Run Inspection by Name and it will not report in the editor.
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ForeachStatement.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ForeachStatement.html
index 772531f265c4..a0db7182b52f 100644
--- a/plugins/InspectionGadgets/src/inspectionDescriptions/ForeachStatement.html
+++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ForeachStatement.html
@@ -1,20 +1,20 @@
-Reports the enhanced for statements.
-Such for statements are not supported under Java 1.4 and older.
+Reports enhanced for statements.
+Such for statements are not supported by Java of version 1.4 and older.
Example:
-
+
for (int x: Arrays.asList(1, 2, 3)) {
System.out.println(x);
}
-
-After the quick-fix is applied, the result looks like this:
-
+
After the quick-fix is applied:
+
for (Iterator<Integer> iterator = Arrays.asList(1, 2, 3).iterator(); iterator.hasNext(); ) {
final int x = iterator.next();
System.out.println(x);
}
-diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/LoopWithImplicitTerminationCondition.html b/plugins/InspectionGadgets/src/inspectionDescriptions/LoopWithImplicitTerminationCondition.html index ac5cd8cb6550..14d50b96fb50 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/LoopWithImplicitTerminationCondition.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/LoopWithImplicitTerminationCondition.html @@ -1,15 +1,16 @@
-Reports any while, -do-while and for -loops which have the constant true as their -only condition, but which still can be terminated by a containing -if statement which can break out of the loop. -This if statement must be the first or only statement -in a while or for -loops and the last or only statement in a do-while loop. -Such a loop would be clearer if the if statement was removed and its condition -was made an explicit loop condition. +Reports anywhile,
+do-while, and for
+loops that have the true constant as their
+only condition. At the same time, such loops can be still terminated by a containing
+if statement which can break out of the loop.
+Such an if statement must be the first or the only statement
+in a while or for
+loop and the last or the only statement in a do-while loop.
Removing the if statement and making its condition an explicit
+ loop condition simplifies the loop.
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/MagicNumber.html b/plugins/InspectionGadgets/src/inspectionDescriptions/MagicNumber.html index c279e26ee994..0975b4faba35 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/MagicNumber.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/MagicNumber.html @@ -1,9 +1,9 @@
-Reports "magic numbers", which are numeric literals used without being named by a constant declaration. -Magic numbers can result in code whose intention is unclear, and may result in errors if a magic -number is changed in one code location but not another. The numbers 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 100, 1000, 0L, 1L, 2L, -0.0, 1.0, 0.0F and 1.0F are not reported by this inspection. +Reports "magic numbers": numeric literals that are not named by a constant declaration. +Using magic numbers can lead to unclear code, as well as errors if a magic +number is changed in one location but remains unchanged not another. The numbers 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 100, 1000, 0L, 1L, 2L, + 0.0, 1.0, 0.0F and 1.0F are not reported by this inspection.
Example:
void checkFileSize(long bytes) {
@@ -12,7 +12,7 @@ number is changed in one code location but not another. The numbers 0, 1, 2, 3,
}
}
A quick-fix is suggested to introduce a new constant:
+A quick-fix introduces a new constant:
static final int MAX_SUPPORTED_FILE_SIZE = 1_048_576;
@@ -23,15 +23,14 @@ number is changed in one code location but not another. The numbers 0, 1, 2, 3,
}
- Use the first checkbox below to disable this inspection within hashCode() methods.
-
- Use the second checkbox below to ignore magic numbers in annotations. -
- Use the third checkbox below to ignore magic numbers used as initial capacity when constructing
- Collection, Map,
- StringBuilder or StringBuffer objects.
-
+
Configure the inspection:
+hashCode() methods.Collection, Map,
+ StringBuilder or StringBuffer objects.exception classes whose names end with 'Exception'.
-Such classes may cause confusion by breaking a common naming convention, and
-are often the sign that developer forgot extends Exception clause.
+Reports non-exception classes whose names end with Exception.
+Such classes may cause confusion by breaking a common naming convention and
+ often indicate that the extends Exception clause is missing.
Example:
public class NotStartedException {}Quick-fix to rename the class is suggested only in the editor..
+A quick-fix that renames such classes is available only in the editor.
\ No newline at end of file diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/OverriddenMethodCallDuringObjectConstruction.html b/plugins/InspectionGadgets/src/inspectionDescriptions/OverriddenMethodCallDuringObjectConstruction.html index df60b0297c49..aee9ef09d23f 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/OverriddenMethodCallDuringObjectConstruction.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/OverriddenMethodCallDuringObjectConstruction.html @@ -1,18 +1,18 @@ Reports any calls to overridden methods of the current class during object construction. -A call is during object construction if it is inside: +This happens if an object construction is inside:clone()readObject()readObjectNoData()Such calls may result in subtle bugs, as the object is not guaranteed to be initialized before the method call occurs.
Example:
-+-This inspection shares functionality with: ++abstract class Parent { void someMethod() { } } @@ -25,13 +25,13 @@ Such calls may result in subtle bugs, as the object is not guaranteed to be init @Override void someMethod() { } } -
This inspection shares its functionality with:
Only one inspection should be enabled at the same time to prevent duplicate warnings.
\ No newline at end of file diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/PackageDotHtmlMayBePackageInfo.html b/plugins/InspectionGadgets/src/inspectionDescriptions/PackageDotHtmlMayBePackageInfo.html index c542b636250d..8744d4c49b62 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/PackageDotHtmlMayBePackageInfo.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/PackageDotHtmlMayBePackageInfo.html @@ -1,23 +1,23 @@ Reports anypackage.html files which are used for documenting packages.
-Since JDK 1.5 it is recommended to use package-info.java files instead, since such
-files can also contain package annotations. In this way, package-info.java becomes the
-sole repository for package level annotations and documentation.
+Since JDK 1.5, it is recommended that you use package-info.java files instead, as such
+files can also contain package annotations. This way, package-info.java becomes a
+ sole repository for package level annotations and documentation.
Example: package.html
+\ No newline at end of file diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/PointlessIndexOfComparison.html b/plugins/InspectionGadgets/src/inspectionDescriptions/PointlessIndexOfComparison.html index 30bcd44a1537..a53ed619dacb 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/PointlessIndexOfComparison.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/PointlessIndexOfComparison.html @@ -1,8 +1,8 @@ -Reports pointless comparison with -.indexOf() expression. An example of such an expression -is comparing the result of .indexOf() with numbers less than -1. +Reports an unnecessary comparison with +-<html> <body> Documentation example. </body> </html> -After the quick-fix is applied, the result looks like this:
-package-info.java++After the quick-fix is applied:
+package-info.java+/** * Documentation example. */ package com.sample; -
.indexOf() expression. An example of such an expression
+is comparing the result of .indexOf() with numbers smaller than -1.
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/PreviewFeature.html b/plugins/InspectionGadgets/src/inspectionDescriptions/PreviewFeature.html index 5c1973e09b2f..c6a73d5aafe6 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/PreviewFeature.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/PreviewFeature.html @@ -1,16 +1,16 @@
-Reports usages of the Preview Feature API. The Preview Feature API is a set of elements that are annotated with@PreviewFeature.
+Reports usages of the Preview Feature API: a set of elements that are annotated with @PreviewFeature.
A preview feature is a new feature of the Java language, Java Virtual Machine, or Java SE API that is fully specified, fully implemented, - and yet impermanent. The notion of a preview feature is defined in JEP 12. + and is yet impermanent. The notion of a preview feature is defined in JEP 12.
- If a code depends on a preview feature it might stop compiling in the future JDK versions if the feature get no positive feedback and, - hence, it either gets removed or changed. + If a piece of code depends on a preview feature, it might stop compiling in future JDK versions in case the feature gets no positive + feedback and gets removed or changed.
-It's enabled only if the language level of the current project is a preview one.
+The inspection is enabled only if the language level of the current project is Preview.
New in 2021.1
\ No newline at end of file diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/PublicStaticCollectionField.html b/plugins/InspectionGadgets/src/inspectionDescriptions/PublicStaticCollectionField.html index a0eaab0ae689..9ef099522a54 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/PublicStaticCollectionField.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/PublicStaticCollectionField.html @@ -1,8 +1,8 @@ -Reports modifiablepublic static Collection fields. Often used
-to store collections of constant values, these fields nonetheless represent a security
-hazard, as their contents may be modified, even if the field is declared as final.
+Reports modifiable public static Collection fields.
+Even though they are often used to store collections of constant values, these fields nonetheless represent a security
+ hazard, as their contents may be modified even if the field is declared as final.
Example:
public static final List<String> EVENTS = new ArrayList<>();
@@ -10,7 +10,7 @@ hazard, as their contents may be modified, even if the field is declared as
- Use the table below to specify methods returning unmodifiable collections.
- public static Collection fields initialized with these methods will not be reported.
+ Use the table in the Options section to specify methods returning unmodifiable collections.
+ public static collection fields initialized with these methods will not be reported.
\ No newline at end of file
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/SerializableCanHaveDefaultSerialUID.html b/plugins/InspectionGadgets/src/inspectionDescriptions/SerializableCanHaveDefaultSerialUID.html
index be5f6a287599..fb1cd6764189 100644
--- a/plugins/InspectionGadgets/src/inspectionDescriptions/SerializableCanHaveDefaultSerialUID.html
+++ b/plugins/InspectionGadgets/src/inspectionDescriptions/SerializableCanHaveDefaultSerialUID.html
@@ -1,8 +1,8 @@
-Inspection reports inheritors of Serializable, which 'serialVersionUID' differs from default generated one.
+Reports inheritors of Serializable whose serialVersionUID differs from the default generated ones.
-This can happen when custom scheme for 'serialVersionUID' used or when something in class really changed since previous
- 'serialVersionUID' change which can lead to problems during deserialization.
+This can happen when you use a custom scheme for serialVersionUID or when something in the class changed since the previous
+ modification of serialVersionUID, which can lead to problems during deserialization.
\ No newline at end of file
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/StaticFieldCanBeMovedToUse.html b/plugins/InspectionGadgets/src/inspectionDescriptions/StaticFieldCanBeMovedToUse.html
index 94b181d7cf97..16646ed1ccc9 100644
--- a/plugins/InspectionGadgets/src/inspectionDescriptions/StaticFieldCanBeMovedToUse.html
+++ b/plugins/InspectionGadgets/src/inspectionDescriptions/StaticFieldCanBeMovedToUse.html
@@ -1,9 +1,10 @@
-Reports any static fields which are only used in a different class than the one they
-are defined in. Such fields can be moved.
-Because this inspection requires global code analysis it is only available for Analyze|Inspect Code or
-Analyze|Run Inspection by Name and it will not report in the editor.
+Reports any static fields that are used only in a class that is different from the one in which they
+are defined. Such fields can be moved.
+
+Since this inspection requires a global code analysis, it is available only from Code | Inspect Code or
+ Code | Analyze Code | Run Inspection by Name and will not report in the editor.
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/SynchronizeOnValueBasedClass.html b/plugins/InspectionGadgets/src/inspectionDescriptions/SynchronizeOnValueBasedClass.html
index a5843e5a5af0..32c864c4b025 100644
--- a/plugins/InspectionGadgets/src/inspectionDescriptions/SynchronizeOnValueBasedClass.html
+++ b/plugins/InspectionGadgets/src/inspectionDescriptions/SynchronizeOnValueBasedClass.html
@@ -1,14 +1,16 @@
-Attempts to synchronize on an instance of a value-based class will produce compile-time warnings and raise run-time exceptions starting from Java 16.
+Reports attempts to synchronize on an instance of a value-based class that produce compile-time warnings and raise
+run-time exceptions starting from Java 16.
- For example, java.lang.Double is annotated with jdk.internal.ValueBased, so the following code will produce a compile-time warning
+ For example, java.lang.Double is annotated with jdk.internal.ValueBased, so the following code will
+ produce a compile-time warning:
-
+
Double d = 20.0;
synchronized (d) { ... } // javac warning
-
+
Since 2021.1
+New in 2021.1
\ No newline at end of file diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/TestCaseWithNoTestMethods.html b/plugins/InspectionGadgets/src/inspectionDescriptions/TestCaseWithNoTestMethods.html index b272492d5be7..c2c0f1dee33b 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/TestCaseWithNoTestMethods.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/TestCaseWithNoTestMethods.html @@ -1,9 +1,9 @@ -Reports non-abstract test cases which do not
-contain any test methods. Such test cases usually indicate unfinished code,
-or could be a refactoring leftover that should be removed.
-For example:
+Reports non-abstract test cases without any test methods.
+Such test cases usually indicate unfinished code + or could be a refactoring leftover that should be removed.
+Example:
public class CrucialTest {
@Before
@@ -13,10 +13,8 @@ or could be a refactoring leftover that should be removed.
}
-Use the checkbox below to specify that test cases which have super classes with -test methods should be ignored by this inspection. -
+
Use the Ignore test cases which have superclasses with test methods option to ignore test cases which have super classes + with test methods.
\ No newline at end of file diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/ThrowFromFinallyBlock.html b/plugins/InspectionGadgets/src/inspectionDescriptions/ThrowFromFinallyBlock.html index 0081b921cb73..84fe692698f2 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/ThrowFromFinallyBlock.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/ThrowFromFinallyBlock.html @@ -1,8 +1,9 @@
-Reportsthrow statements inside of finally
-blocks. While occasionally intended, such throw statements may mask exceptions thrown from try-catch and thus
-tremendously complicate debugging.
+Reports throw statements inside finally
+blocks.
+While occasionally intended, such throw statements may conceal exceptions thrown from try-catch and thus
+ tremendously complicate the debugging process.
diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/UseOfConcreteClass.html b/plugins/InspectionGadgets/src/inspectionDescriptions/UseOfConcreteClass.html index f8edbc72e992..6d552983169f 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/UseOfConcreteClass.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/UseOfConcreteClass.html @@ -1,7 +1,7 @@
-Reports uses of concrete classes, rather than interfaces. -Such declarations may represent a failure of abstraction, and may make testing more difficult. +Reports usages of concrete classes, rather than interfaces. +Such declarations may represent a failure of abstraction and may make testing more difficult.
Declarations whose classes come from system or third-party libraries will not be reported by this inspection.
Casts, instanceofs, and local variables are not reported in equals() method implementations.
@@ -26,8 +26,7 @@ Also, casts are not reported in clone() method implementations.
- Use the first checkbox below to ignore casts to abstract classes.
-- Use the subsequent checkboxes to control contexts where the problem is reported.
+ Use the Ignore abstract class type option to ignore casts to abstract classes. +Use the subsequent options to control contexts where the problem is reported.
\ No newline at end of file diff --git a/plugins/InspectionGadgets/src/inspectionDescriptions/UseOfObsoleteDateTimeApiInspection.html b/plugins/InspectionGadgets/src/inspectionDescriptions/UseOfObsoleteDateTimeApiInspection.html index 65b4f7b895b1..9770e68a46cc 100644 --- a/plugins/InspectionGadgets/src/inspectionDescriptions/UseOfObsoleteDateTimeApiInspection.html +++ b/plugins/InspectionGadgets/src/inspectionDescriptions/UseOfObsoleteDateTimeApiInspection.html @@ -1,9 +1,8 @@ -Reports any uses of java.util.Date, java.util.Calendar, java.util.GregorianCalendar, java.util.TimeZone, -and java.util.SimpleTimeZone. -While still supported, these classes were made obsolete by the JDK8 Date-Time API, and should probably -not be used in new development. +Reports usages ofjava.util.Date, java.util.Calendar, java.util.GregorianCalendar, java.util.TimeZone,
+and java.util.SimpleTimeZone.
+While still supported, these classes have been obsolete since JDK8 Date-Time API and should not be used in new development.