=> Move the bundles in the plugins they are related to.
--- /dev/null
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck.name=Missing Override
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck.param.javaFiveCompatibility=When this property is true this check will only check classes, interfaces, etc. that do not contain the extends or implements keyword or are not anonymous classes. This means it only checks methods overridden from java.lang.Object Java 5 Compatibility mode severely limits this check. It is recommended to only use it on Java 5 source.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.name=Equals Avoid Null
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.param.ignoreEqualsIgnoreCase=whether to ignore String.equalsIgnoreCase() invocations. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck.name=Javadoc Package
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck.param.allowLegacy=If set then allow the use of a package.html file.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.name=Declaration Order
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck.name=Anon Inner Length
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck.param.max=maximum allowable number of lines. Default is 20.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.name=Executable Statement Count
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.param.max=the maximum threshold allowed. Default is 30.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.param.tokens=members to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck.name=Whitespace After
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.name=Illegal Token Text
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.param.message=Message which is used to notify about violations; if empty then the default message is used.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.param.tokens=tokens to check. Default value is empty.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.param.format=illegal pattern
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.param.ignoreCase=Controls whether to ignore case when matching. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck.name=Class Fan Out Complexity
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck.param.max=the maximum threshold allowed. Default is 20.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck.name=Missing Deprecated
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck.name=Outer Type Number
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck.param.max=maximum allowable number of outer types. Default is 1.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck.name=Design For Extension
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck.name=Illegal Throws
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck.param.illegalClassNames=throw class names to reject
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck.param.ignoredMethodNames=names of methods to ignore. Default is "finalize".
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.name=Avoid Star Import
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.param.excludes=packages where star imports are allowed. Note that this property is not recursive, subpackages of excluded packages are not automatically excluded.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.param.allowClassImports=whether to allow starred class imports like <code>import java.util.*;</code>. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.param.allowStaticMemberImports=whether to allow starred static member imports like <code>import static org.junit.Assert.*;</code>. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck.name=Illegal Catch
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck.param.illegalClassNames=exception class names to reject
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck.name=Typecast Paren Pad
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck.param.option=policy on how to pad parentheses
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck.name=Avoid Static Import
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck.param.excludes=Allows for certain classes via a star notation to be excluded such as java.lang.Math.* or specific static members to be excluded like java.lang.System.out for a variable or java.lang.Math.random for a method. If you exclude a starred import on a class this automatically excludes each member individually. For example: Excluding java.lang.Math.*. will allow the import of each static member in the Math class individually like java.lang.Math.PI.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.name=Return Count
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.param.format=method names to ingone
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.param.max=maximum allowed number of return statments
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck.name=Multiple String Literals
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck.param.ignoreStringsRegexp=regexp pattern for ignored strings (with quotation marks)
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck.param.ignoreOccurrenceContext=Token type names where duplicate strings are ignored even if they don't match ignoredStringsRegexp. This allows you to exclude syntactical contexts like Annotations or static initializers from the check.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck.param.allowedDuplicates=The maximum number of occurences to allow without generating a warning. Default is 1.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.name=Require This
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.param.checkFields=whether we should check fields usage or not. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.param.checkMethods=whether we should check methods usage or not. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.name=Right Curly
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.param.tokens=blocks to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.param.option=policy on placement of a right curly brace ('}')
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck.name=Unnecessary Parentheses
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck.name=Illegal Token
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck.param.tokens=tokens to check. Default value is LITERAL_SWITCH, POST_INC, POST_DEC.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck.name=Parameter Number
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck.param.tokens=declarations to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck.param.max=maximum allowable number of parameters. Default is 7.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck.name=No Whitespace Before
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck.param.allowLineBreaks=whether whitespace is allowed if the token is at a linebreak. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck.name=Missing Switch Default
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.name=Regexp
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.duplicateLimit=Controls whether to check for duplicates of a required pattern, any negative value means no checking for duplicates, any positive value is used as the maximum number of allowed duplicates, if the limit is exceeded errors will be logged. Default is -1.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.message=message which is used to notify about violations, if empty then default(hard-coded) message is used.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.format=pattern
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.ignoreComments=Controls whether to ignore matches found within comments. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.illegalPattern=Controls whether the pattern is required or illegal. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.errorLimit=Controls the maximum number of errors before the check will abort. Default is 100.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.name=Javadoc Method
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.tokens=definitions to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingReturnTag=whether to ignore errors when a method returns non-void type does have a return tag in the javadoc. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingThrowsTags=whether to ignore errors when a method declares that it throws exceptions but does have matching throws tags in the javadoc. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowThrowsTagsForSubclasses=whether to allow documented exceptions that are subclass of one of declared exception. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingJavadoc=whether to ignore errors when a method javadoc is missed. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingParamTags=whether to ignore errors when a method has parameters but does not have matching param tags in the javadoc. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.scope=visibility scope where Javadoc comments are checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingPropertyJavadoc=Whether to allow missing Javadoc on accessor methods for properties (setters and getters). The setter and getter methods must match exactly the structures below. <code> public void setNumber(final int number) { mNumber = number; } public int getNumber() { return mNumber; } public boolean isSomething() { return false; } </code>. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowUndeclaredRTE=whether to allow documented exceptions that are not declared if they are a subclass of java.lang.RuntimeException. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.suppressLoadErrors=When set to false all problems with loading classes would be reported as violations. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.name=Regexp Singleline Java
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.ignoreCase=Controls whether to ignore case when searching. Default value is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.ignoreComments=Controls whether to ignore text in comments when searching. Default value is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.maximum=The maximum number of matches required in each file. Default value is 0.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.format=illegal pattern. Default value is ^$ (empty).
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.minimum=The minimum number of matches required in each file. Default value is 0.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.message=message which is used to notify about violations, if empty then default(hard-coded) message is used. Default value is "" (empty).
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck.name=Parameter Assignment
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.name=Javadoc Variable
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.param.scope=visibility scope where Javadoc comments are checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck.name=Illegal Instantiation
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck.param.classes=classes that should not be instantiated
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck.name=Method Length
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck.param.countEmpty=whether to count empty lines and single line comments of the form //. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck.param.max=maximum allowable number of lines. Default is 150.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck.param.tokens=blocks to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.name=Hide Utility Class Constructor
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck.name=Modified Control Variable
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.name=Magic Number
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.param.ignoreNumbers=non-magic numbers. Default is -1,0,1,2.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.param.ignoreHashCodeMethod=ignore magic numbers in hashCode methods. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.param.ignoreAnnotation=ignore magic numbers in annotation declarations. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck.name=Header
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck.param.header=the required header specified inline. Individual header lines must be separated by the string "\n" (even on platforms with a different line separator)
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck.param.ignoreLines=comma-separated list of line numbers to ignore
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck.name=Avoid Inline Conditionals
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck.name=Nested Try Depth
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck.param.max=allowed nesting depth. Default is 1.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck.name=Trailing Comment
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck.param.legalComment=pattern for text of trailing comment which is allowed. (this patter will not be applied to multiline comments and text of comment will be trimmed before matching)
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck.param.format=pattern for string allowed before comment.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck.name=Parameter Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck.name=Redundant Modifier
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck.name=Empty For Initializer Pad
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck.param.option=policy on how to pad an empty for iterator
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.name=Javadoc Style
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.checkHtml=Whether to check for incomplete html tags. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.scope=visibility scope where Javadoc comments are checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.checkEmptyJavadoc=Whether to check if the Javadoc is missing a describing text. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.tokens=definitions to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.checkFirstSentence=Whether to check the first sentence for proper end of sentence. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.name=Line Length
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.param.ignorePattern=pattern for lines to ignore
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.param.tabWidth=number of expanded spaces for a tab character. Default is 8.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.param.max=maximum allowable line length. Default is 80.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.name=Regexp Multiline
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.minimum=The minimum number of matches required in each file. Default value is 0.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.message=message which is used to notify about violations, if empty then default(hard-coded) message is used. Default value is "" (empty).
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.ignoreCase=Controls whether to ignore case when searching. Default value is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.format=illegal pattern. Default value is ^$ (empty).
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.maximum=The maximum number of matches required in each file. Default value is 0.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck.name=File Tab Character
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck.param.eachLine=whether to report on each line containing a tab, or just the first instance. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.name=Unused Imports
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.param.processJavadoc=whether to process Javadoc. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck.name=Simplify Boolean Expression
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck.name=Uncommented Main
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck.param.excludedClasses=pattern for qualified names of classes which are allowed to have a main method.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck.name=Local Variable Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck.param.tokens=Controls whether the check applies to variable declarations or catch clause parameters
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck.name=Interface Is Type
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck.param.allowMarkerInterfaces=Controls whether marker interfaces like Serializable are allowed. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.name=NPath Complexity
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.param.max=the maximum threshold allowed. Default is 200.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck.name=Simplify Boolean Return
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DoubleCheckedLockingCheck.name=Double Checked Locking
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck.name=Cyclomatic Complexity
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck.param.max=the maximum threshold allowed. Default is 10.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.name=Annotation Use Style
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.param.closingParens=Defines the policy for ending parenthesis. Default is never.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.param.elementStyle=Defines the annotation element styles. Default value is compact_no_array.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.param.trailingArrayComma=Defines the policy for trailing comma in arrays. Default is never.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck.name=Paren Pad
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck.param.option=policy on how to pad parentheses
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck.name=Method Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck.param.allowClassName=Controls whether to allow a method name to have the same name as the residing class name. This is not to be confused with a constructor. An easy mistake is to place a return type on a constructor declaration which turns it into a method.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck.name=Modifier Order
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck.name=Explicit Initialization
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.name=Static Variable Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.param.applyToProtected=Controls whether to apply the check to protected member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.param.applyToPrivate=Controls whether to apply the check to private member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.param.applyToPackage=Controls whether to apply the check to package-private member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.param.applyToPublic=Controls whether to apply the check to public member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck.name=Empty Statement
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.name=Illegal Type
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.ignoredMethodNames=methods that should not be checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.illegalClassNames=classes that should not be used as types in variable declarations, return values or parameters.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.legalAbstractClassNames=abstract classes that may be used as types.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.format=pattern for illegal class name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck.name=Method Param Pad
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck.param.option=policy on how to pad method parameter. Default is nospace.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck.param.allowLineBreaks=whether a line break between the identifier and left parenthesis is allowed. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.name=Javadoc Type
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.authorFormat=pattern for @author tag
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.tokens=definitions to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.scope=visibility scope where Javadoc comments are checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.allowMissingParamTags=whether to ignore errors when a class has type parameters but does not have matching param tags in the javadoc. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.allowUnknownTags=whether to ignore errors when a Javadoc tag is not recognised. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.versionFormat=pattern for @version tag
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck.name=Final Parameters
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck.param.tokens=blocks to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck.name=Empty For Iterator Pad
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck.param.option=policy on how to pad an empty for iterator
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck.name=Illegal Import
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck.param.illegalPkgs=packages to reject
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck.name=Comment pattern matcher
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck.param.format=Regular expression pattern to check. Default is TODO:
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck.name=Multiple Variable Declarations
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck.name=Write Tag
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck.param.tagSeverity=Severity level when tag is found and printed. Default is info.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck.param.tagFormat=Format of tag
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck.param.tag=Name of tag
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck.name=Operator Wrap
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck.param.option=policy on how to wrap lines. 'nl' : the operator must be on a new line, 'eol' : the operator must be at the end of the line. Default is 'nl'.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck.name=Regexp Header
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck.param.header=The required header specified inline. Individual header lines must be separated by the string "\n" (even on platforms with a different line separator), and regular expressions must not span multiple lines.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck.param.multiLines=Line numbers to repeat (zero or more times)
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck.name=Default Comes Last
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck.name=No Whitespace After
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck.param.allowLineBreaks=whether whitespace is allowed if the token is at a linebreak. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck.name=Throws Count
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck.param.max=maximum allowed number of throws statments
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck.name=Mutable Exception
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck.param.format=pattern for name of exception class.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck.name=Equals Hash Code
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.SuperFinalizeCheck.name=Super Finalize
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.name=Final Local Variable
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck.name=Suppress Warnings
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck.param.format=The warnings property is a regex pattern. Any warning being suppressed matching this pattern will be flagged. Default is ^$|^\s+$
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck.param.tokens=Tokens to check : CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF ENUM_CONSTANT_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, CTOR_DEF. Default value is LASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, ENUM_CONSTANT_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, CTOR_DEF.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck.name=Covariant Equals
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck.name=Empty Block
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck.param.tokens=blocks to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck.param.option=policy on block contents
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.name=Boolean Expression Complexity
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.param.tokens=tokens to check. Default is LAND,BAND,LOR,BOR,BXOR.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.param.max=the maximum allowed number of boolean operations in one expression. Default is 3.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck.name=Redundant import
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck.name=Package Annotation
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck.name=Array Type Style
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck.param.javaStyle=Controls whether to enforce Java style (true) or C style (false). Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.name=Indentation
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.param.tabWidth=number of expanded spaces for a tab character
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.param.caseIndent=how much to indent a case label
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.param.braceAdjustment=how far brace should be indented when on next line
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.param.basicOffset=how many spaces to use for new indentation level
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.name=Final Class
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck.name=Avoid Nested Blocks
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck.param.allowInSwitchCase=Allow nested blocks in case statements. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck.name=Need Braces
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck.param.tokens=blocks to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck.name=Abstract Class Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck.param.ignoreModifier=Controls whether to ignore checking for the abstract modifier on classes that match the name. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck.param.ignoreName=Controls whether to ignore checking the name. Realistically only useful if using the check to identify that match name and do not have the abstract modifier name. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MissingCtorCheck.name=Missing Constructor
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck.name=Package Declaration
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck.param.ignoreDirectoryName=whether to ignore checking that the package declaration matches the source directory name. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.name=JavaNCSS
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.param.classMaximum=the maximum allowed number of non commenting lines in a class. Default is 1500.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.param.methodMaximum=the maximum allowed number of non commenting lines in a method. Default is 50.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.param.fileMaximum=the maximum allowed number of non commenting lines in a file including all top level and nested classes. Default is 2000.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.name=Hidden Field
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.ignoreSetter=Controls whether to ignore the parameter of a property setter method, where the property setter method for field 'xyz' has name 'setXyz', one parameter named 'xyz', and return type void. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.ignoreConstructorParameter=Controls whether to ignore constructor parameters. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.ignoreAbstractMethods=Controls whether to ignore parameters of abstract methods. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.ignoreFormat=pattern for names to ignore
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.name=Regexp Singleline
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.format=illegal pattern. Default value is ^$ (empty).
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.ignoreCase=Controls whether to ignore case when searching. Default value is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.message=message which is used to notify about violations, if empty then default(hard-coded) message is used. Default value is "" (empty).
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.maximum=The maximum number of matches required in each file. Default value is 0.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.minimum=The minimum number of matches required in each file. Default value is 0.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck.name=File Length
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck.param.max=maximum allowable number of lines. Default is 2000.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck.name=Newline At End Of File
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck.param.fileExtensions=file type extension of the files to check.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck.param.lineSeparator=type of line separator. One of 'system' (system default), 'crlf' (Windows-style), 'cr' (Mac-style) and 'lf' (Unix-style).
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.name=Visibility Modifier
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.param.protectedAllowed=whether protected members are allowed. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.param.publicMemberPattern=pattern for public members that should be ignored. Default is ^serialVersionUID$.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.param.packageAllowed=whether package visible members are allowed. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck.name=String Literal Equality
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck.name=Class Data Abstraction Coupling
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck.param.max=the maximum threshold allowed. Default is 7.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck.name=Fall Through
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck.param.checkLastCaseGroup=Whether we need to check last case group or not. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck.param.reliefPattern=Regulare expression to match the relief comment that supresses the warning about a fall through.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck.name=Inner Assignment
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck.param.tokens=assignments to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck.name=Strict Duplicate Code
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck.param.charset=name of the file charset
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck.param.min=how many lines must be equal to be considered a duplicate. Default is 12.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.name=Import Order
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.separated=whether imports groups should be separated by, at least, one blank line. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.caseSensitive=whether string comparision should be case sensitive or not. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.groups=list of imports groups (every group identified either by a common prefix string, or by a regular expression enclosed in forward slashes (e.g. /regexp/)
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.option=policy on the relative order between regular imports and static imports. Values are top, above, inflow, under, bottom. See examples: http://checkstyle.sourceforge.net/property_types.html#importOrder
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.ordered=whether imports within group should be sorted. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.name=Whitespace Around
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.param.allowEmptyConstructors=allow empty constructor bodies. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.param.allowEmptyMethods=allow empty method bodies. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NoFinalizerCheck.name=No Finalizer
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.UpperEllCheck.name=Upper Ell
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck.name=Nested If Depth
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck.param.max=allowed nesting depth. Default is 1.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck.name=Package name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.name=Type Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.tokens=Control whether the check applies to classes or interfaces
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.applyToPackage=Controls whether to apply the check to package-private member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.applyToProtected=Controls whether to apply the check to protected member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.applyToPublic=Controls whether to apply the check to public member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.applyToPrivate=Controls whether to apply the check to private member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.name=Constant Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.param.applyToProtected=Controls whether to apply the check to protected member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.param.applyToPackage=Controls whether to apply the check to package-private member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.param.applyToPublic=Controls whether to apply the check to public member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.param.applyToPrivate=Controls whether to apply the check to private member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.SuperCloneCheck.name=Super Clone
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.name=Left Curly
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.param.maxLineLength=maximum number of characters in a line. Default is 80.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.param.tokens=blocks to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.param.option=policy on placement of a left curly brace ('{'). eol : the brace must always be on the end of the line, nl : he brace must always be on a new line, nlow : ff the brace will fit on the first line of the statement, taking into account maximum line length, then apply eol rule. Otherwise apply the nl rule. nlow is a mnemonic for 'new line on wrap'.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck.name=Local Final Variable Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.name=Member name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.param.applyToPackage=Controls whether to apply the check to package-private member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.param.applyToPublic=Controls whether to apply the check to public member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.param.applyToPrivate=Controls whether to apply the check to private member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.param.applyToProtected=Controls whether to apply the check to protected member
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck.name=Redundant Throws
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck.param.allowSubclasses=whether subclass of another declared exception is allowed in throws clause. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck.param.allowUnchecked=whether unchecked exceptions in throws are allowed or not. Default is false.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck.param.suppressLoadErrors=When set to false all problems with loading classes would be reported as violations. Default is true.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck.name=Array Trailing Comma
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck.name=Generic Whitespace
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck.name=No Clone
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck.name=Inner Type Last
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck.name=Outer Type Filename
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck.name=Nested For Depth
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck.param.max=allowed nesting depth.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.name=Method Count
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxTotal=maximum allowable number of methods at all scope levels.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxPrivate=maximum allowable number of private methods.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxPackage=maximum allowable number of package methods.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxProtected=maximum allowable number of protected methods.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxPublic=maximum allowable number of public methods.
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck.name=One Statement Per Line
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck.name=Class Type Parameter Name
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MethodTypeParameterNameCheck.name=Method Type Parameter Name
--- /dev/null
+Checks the style of array type definitions. Some like Java-style: public static void main(String[] args) and some like C-style: public static void main(String args[])
\ No newline at end of file
--- /dev/null
+Check that method/constructor/catch/foreach parameters are final.
\ No newline at end of file
--- /dev/null
+Checks that there is a newline at the end of each file. Any source files and text files in general should end with a newline character, especially when using SCM systems such as CVS. CVS will even print a warning when it encounters a file that doesn't end with a newline.
\ No newline at end of file
--- /dev/null
+Checks that the outer type name and the file name match. For example, the class Foo must be in a file named Foo.java.
--- /dev/null
+A check that makes sure that a specified pattern exists (or not) in the file.
\ No newline at end of file
--- /dev/null
+This rule allows to find any kind of pattern inside comments like TODO, NOPMD, ..., except NOSONAR
\ No newline at end of file
--- /dev/null
+<p>
+ The check to ensure that requires that comments be the only thing on a line. For the case of // comments that means that the only thing that should precede it is whitespace. It
+ doesn't check comments if they do not end line, i.e. it accept the following: Thread.sleep( 10 <some comment here> ); Format property is intended to deal with the "} //
+ while" example.
+</p>
+<p>
+ Rationale: Steve McConnel in "Code Complete" suggests that endline comments are a bad practice. An end line comment would be one that is on the same line as actual code. For
+ example:
+</p>
+<pre>
+ <code>
+ a = b + c; // Some insightful comment
+ d = e / f; // Another comment for this line
+ </code>
+</pre>
+
+<p>
+ Quoting "Code Complete" for the justfication:
+</p>
+<ul>
+ <li>"The comments have to be aligned so that they do not interfere with the visual structure of the code. If you don't align them neatly, they'll make your listing look like it's
+ been through a washing machine."
+ </li>
+ <li>"Endline comments tend to be hard to format...It takes time to align them. Such time is not spent learning more about the code; it's dedicated solely to the tedious task of
+ pressing the spacebar or tab key."
+ </li>
+ <li>"Endline comments are also hard to maintain. If the code on any line containing an endline comment grows, it bumps the comment farther out, and all the other endline comments
+ will have to bumped out to match. Styles that are hard to maintain aren't maintained...."
+ </li>
+ <li>"Endline comments also tend to be cryptic. The right side of the line doesn't offer much room and the desire to keep the comment on one line means the comment must be short.
+ Work
+ then goes into making the line as short as possible instead of as clear as possible. The comment usually ends up as cryptic as possible...."
+ </li>
+ <li>"A systemic problem with endline comments is that it's hard to write a meaningful comment for one line of code. Most endline comments just repeat the line of code, which
+ hurts
+ more than it helps."
+ </li>
+</ul>
+<p>
+ His comments on being hard to maintain when the size of the line changes are even more important in the age of automated refactorings.
+</p>
\ No newline at end of file
--- /dev/null
+Detects uncommented main methods.
\ No newline at end of file
--- /dev/null
+Checks that long constants are defined with an upper ell. That is ' L' and not 'l'.
+ This is in accordance to the Java Language Specification, <a href="http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#48282">Section 3.10.1</a>.
\ No newline at end of file
--- /dev/null
+Controls the style with the usage of annotations.
\ No newline at end of file
--- /dev/null
+Verifies that both the java.lang.Deprecated annotation is present and the @deprecated Javadoc tag is present when either is present.
\ No newline at end of file
--- /dev/null
+Verifies that the java.lang.Override annotation is present when the {@inheritDoc} javadoc tag is present.
\ No newline at end of file
--- /dev/null
+<p>This check makes sure that all package annotations are in the package-info.java file.</p>
+<p>According to the Java JLS 3rd ed.</p>
+<p>The JLS does not enforce the placement of package annotations. This placement may vary based on implementation. The JLS does highly recommend that all package annotations are placed in the package-info.java file. See <a href="http://java.sun.com/docs/books/jls/third_edition/html/j3TOC.html">Java Language specification, sections 7.4.1.1</a>.</p>
\ No newline at end of file
--- /dev/null
+<p> This check allows you to specify what warnings that SuppressWarnings is not allowed to suppress. You can also specify a list of TokenTypes that the configured warning(s) cannot be suppressed on.</p>
+<p>Limitations: This check does not consider conditionals inside the SuppressWarnings annotation.
+For example: @SupressWarnings((false) ? (true) ? "unchecked" : "foo" : "unused") According to the above example, the "unused" warning is being suppressed not the "unchecked" or "foo" warnings. All of these warnings will be considered and matched against regardless of what the conditional evaluates to.</p>
\ No newline at end of file
--- /dev/null
+Finds nested blocks.
\ No newline at end of file
--- /dev/null
+Checks for empty blocks.
\ No newline at end of file
--- /dev/null
+Checks for the placement of left curly braces for code blocks. The policy to verify is specified using property option. Policies <code>eol</code> and <code>nlow</code> take into account property maxLineLength.
\ No newline at end of file
--- /dev/null
+Checks for braces around code blocks.
\ No newline at end of file
--- /dev/null
+Checks the placement of right curly braces.
\ No newline at end of file
--- /dev/null
+Checks if array initialization contains optional trailing comma.
\ No newline at end of file
--- /dev/null
+Detects inline conditionals.
\ No newline at end of file
--- /dev/null
+Checks that if a class defines a covariant method equals, then it defines method equals(java.lang.Object).
\ No newline at end of file
--- /dev/null
+Checks that the parts of a class or interface declaration appear in the order suggested by the Code Convention for the Java Programming Language : <ul><li>Class (static) variables. First the public class variables, then the protected, then package level (no access modifier), and then the private.</li><li>Instance variables. First the public class variables, then the protected, then package level (no access modifier), and then the private.</li><li>Constructors</li><li>Methods</li></ul>
\ No newline at end of file
--- /dev/null
+Check that the default is after all the cases in a switch statement.
\ No newline at end of file
--- /dev/null
+Detect the double-checked locking idiom, a technique that tries to avoid synchronization overhead but is incorrect because of subtle artifacts of the java memory model.
\ No newline at end of file
--- /dev/null
+Detects empty statements (standalone ';').
\ No newline at end of file
--- /dev/null
+<p>Checks that any combination of String literals with optional assignment is on the left side of an equals() comparison.</p>
+<p>Rationale: Calling the equals() method on String literals will avoid a potential NullPointerException. Also, it is pretty common to see null check right before equals comparisons which is not necessary in the below example.</p>
+<p>For example:
+<pre>
+ String nullString = null;
+ nullString.equals("My_Sweet_String");
+</pre>
+</p>
+
+<p>
+should be refactored to:
+<pre>
+ String nullString = null;
+ "My_Sweet_String".equals(nullString);
+</pre>
+</p>
+<p>Limitations: If the equals method is overridden or a covariant equals method is defined and the implementation is incorrect (where s.equals(t) does not return the same result as t.equals(s)) then rearranging the called on object and parameter may have unexpected results.</p>
+<p>Java's Autoboxing feature has an affect on how this check is implemented. Pre Java 5 all IDENT + IDENT object concatenations would not cause a NullPointerException even if null. Those situations could have been included in this check. They would simply act as if they surrounded by String.valueof() which would concatenate the String null.</p>
+<p>The following example will cause a NullPointerException as a result of what autoboxing does.</p>
+<pre>
+ Integer i = null, j = null;
+ String number = "5"
+ number.equals(i + j);
+</pre>
+<p>Since, it is difficult to determine what kind of Object is being concatenated all ident concatenation is considered unsafe.</p>
\ No newline at end of file
--- /dev/null
+Checks that classes that override equals() also override hashCode().
\ No newline at end of file
--- /dev/null
+Checks if any class or object member explicitly initialized to default for its type value (null for object references, zero for numeric types and char and false for boolean.
\ No newline at end of file
--- /dev/null
+Checks for fall through in switch statements Finds locations where a case contains Java code - but lacks a break, return, throw or continue statement.
\ No newline at end of file
--- /dev/null
+Ensures that local variables that never get their values changed, must be declared final.
\ No newline at end of file
--- /dev/null
+Checks that a local variable or a parameter does not shadow a field that is defined in the same class.
\ No newline at end of file
--- /dev/null
+Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException is almost never acceptable.
\ No newline at end of file
--- /dev/null
+Checks for illegal instantiations where a factory method is preferred. Depending on the project, for some classes it might be preferable to create instances through factory methods rather than calling the constructor. A simple example is the <code>java.lang.Boolean</code> class. In order to save memory and CPU cycles, it is preferable to use the predefined constants TRUE and FALSE. Constructor invocations should be replaced by calls to <code>Boolean.valueOf()</code>. Some extremely performance sensitive projects may require the use of factory methods for other classes as well, to enforce the usage of number caches or object pools.
\ No newline at end of file
--- /dev/null
+Throwing java.lang.Error or java.lang.RuntimeException is almost never acceptable.
\ No newline at end of file
--- /dev/null
+Checks for illegal tokens. Certain language features often lead to hard to maintain code or are non-obvious to novice developers. Other features may be discouraged in certain frameworks, such as not having native methods in EJB components.
\ No newline at end of file
--- /dev/null
+Checks for illegal token text.
\ No newline at end of file
--- /dev/null
+Checks that particular class are never used as types in variable declarations, return values or parameters.
\ No newline at end of file
--- /dev/null
+Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2);.
\ No newline at end of file
--- /dev/null
+Checks for magic numbers.
\ No newline at end of file
--- /dev/null
+Checks that classes (except abstract one) define a constructor and don't rely on the default one.
\ No newline at end of file
--- /dev/null
+Checks that switch statement has default clause.
\ No newline at end of file
--- /dev/null
+Check for ensuring that for loop control variables are not modified inside the for block.
\ No newline at end of file
--- /dev/null
+Checks for multiple occurrences of the same string literal within a single file. Code duplication makes maintenance more difficult, so it can be better to replace the multiple occurrences with a constant.
\ No newline at end of file
--- /dev/null
+Checks that each variable declaration is in its own statement and on its own line.
\ No newline at end of file
--- /dev/null
+Restricts nested for blocks to a specified depth.
--- /dev/null
+Restricts nested if-else blocks to a specified depth (default = 1).
\ No newline at end of file
--- /dev/null
+Restricts nested try-catch-finally blocks to a specified depth (default = 1).
\ No newline at end of file
--- /dev/null
+<p> Checks that the clone method is not overridden from the Object class.</p>
+
+<p>Rationale: The clone method relies on strange/hard to follow rules that do not work it all situations. Consequently, it is difficult to override correctly. Below are some of the rules/reasons why the clone method should be avoided.
+<ul>
+ <li>Classes supporting the clone method should implement the Cloneable interface but the Cloneable interface does not include the clone method. As a result, it doesn't enforce the method override.</li>
+ <li>The Cloneable interface forces the Object's clone method to work correctly. Without implementing it, the Object's clone method will throw a CloneNotSupportedException.</li>
+ <li>Non-final classes must return the object returned from a call to super.clone().</li>
+ <li>Final classes can use a constructor to create a clone which is different from non-final classes.</li>
+ <li>If a super class implements the clone method incorrectly all subclasses calling super.clone() are doomed to failure.</li>
+ <li>If a class has references to mutable objects then those object references must be replaced with copies in the clone method after calling super.clone().</li>
+ <li>The clone method does not work correctly with final mutable object references because final references cannot be reassigned.</li>
+ <li>If a super class overrides the clone method then all subclasses must provide a correct clone implementation.</li>
+</ul></p>
+<p>Two alternatives to the clone method, in some cases, is a copy constructor or a static factory method to return copies of an object. Both of these approaches are simpler and do not conflict with final fields. The do not force the calling client to handle a CloneNotSuportException. They also are typed therefore no casting is necessary. Finally, they are more flexible since they can take interface types rather than concrete classes.</p>
+
+<p>Sometimes a copy constructor or static factory is not an acceptable alternative to the clone method. The example below highlights the limitation of a copy constructor (or static factory). Assume Square is a subclass for Shape.</p>
+<p>
+<pre>
+ Shape s1 = new Square();
+ System.out.println(s1 instanceof Square); //true
+</pre></p>
+<p>...assume at this point the code knows nothing of s1 being a Square that's the beauty of polymorphism but the code wants to copy the Square which is declared as a Shape, its super type...</p>
+<p>
+<pre>
+ Shape s2 = new Shape(s1); //using the copy constructor
+ System.out.println(s2 instanceof Square); //false
+</pre></p>
+
+<p>The working solution (without knowing about all subclasses and doing many casts) is to do the following (assuming correct clone implementation).<br/>
+<pre>
+ Shape s2 = s1.clone();
+ System.out.println(s2 instanceof Square); //true
+</pre></p>
+
+<p>Just keep in mind if this type of polymorphic cloning is required then a properly implemented clone method may be the best choice.</p>
+
+<p>Much of this information was taken from Effective Java: Programming Language Guide First Edition by Joshua Bloch pages 45-52. Give Bloch credit for writing an excellent book.</p>
+
+<p>This check is almost exactly the same as the "No Finalizer Check".</p>
\ No newline at end of file
--- /dev/null
+<p>Verifies there are no finalize() methods defined in a class.</p>
\ No newline at end of file
--- /dev/null
+Checks there is only one statement per line. The following line will be flagged as an error: <code>x = 1; y = 2; // Two statments on a single line.</code>
--- /dev/null
+Ensures there is a package declaration.
\ No newline at end of file
--- /dev/null
+Disallow assignment of parameters.
\ No newline at end of file
--- /dev/null
+Checks for redundant exceptions declared in throws clause such as duplicates, unchecked exceptions or subclasses of another declared exception.
\ No newline at end of file
--- /dev/null
+Checks that code doesn't rely on the this default.
\ No newline at end of file
--- /dev/null
+Restricts return statements to a specified count (default = 2).
\ No newline at end of file
--- /dev/null
+Checks for overly complicated boolean expressions.
\ No newline at end of file
--- /dev/null
+Checks for overly complicated boolean return statements.
\ No newline at end of file
--- /dev/null
+Checks that string literals are not used with == or !=.
\ No newline at end of file
--- /dev/null
+Checks that an overriding clone() method invokes super.clone().
\ No newline at end of file
--- /dev/null
+Checks that an overriding finalize() method invokes super.finalize().
\ No newline at end of file
--- /dev/null
+Checks if unnecessary parentheses are used in a statement or expression.
\ No newline at end of file
--- /dev/null
+Checks that classes are designed for inheritance.
\ No newline at end of file
--- /dev/null
+Checks that class which has only private constructors is declared as final.
\ No newline at end of file
--- /dev/null
+Make sure that utility classes (classes that contain only static methods) do not have a public constructor.
\ No newline at end of file
--- /dev/null
+Check nested (internal) classes/interfaces are declared at the bottom of the class after all method and field declarations.
--- /dev/null
+Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types. According to Bloch, an interface should describe a type. It is therefore inappropriate to define an interface that does not contain any methods but only constants. The Standard class javax.swing.SwingConstants is an example of a class that would be flagged by this check. The check can be configured to also disallow marker interfaces like java.io.Serializable, that do not contain methods or constants at all.
\ No newline at end of file
--- /dev/null
+Ensures that exceptions (defined as any class name conforming to some regular expression) are immutable.
\ No newline at end of file
--- /dev/null
+Restricts throws statements to a specified count (default = 1).
\ No newline at end of file
--- /dev/null
+Checks visibility of class members. Only static final members may be public; other class members must be private unless property protectedAllowed or packageAllowed is set.
\ No newline at end of file
--- /dev/null
+Performs a line-by-line comparison of all code lines and reports duplicate code if a sequence of lines differs only in indentation.
\ No newline at end of file
--- /dev/null
+<p>Checks that a source file begins with a specified header. Property headerFile specifies a file that contains the required header. Alternatively, the header specification can be set directly in the header property without the need for an external file.</p>
+<p>Property ignoreLines specifies the line numbers to ignore when matching lines in a header file. This property is very useful for supporting headers that contain copyright dates. For example, consider the following header:</p>
+<pre>
+ line 1: ////////////////////////////////////////////////////////////////////
+ line 2: // checkstyle:
+ line 3: // Checks Java source code for adherence to a set of rules.
+ line 4: // Copyright (C) 2002 Oliver Burn
+ line 5: ////////////////////////////////////////////////////////////////////
+</pre>
+<p>Since the year information will change over time, you can tell Checkstyle to ignore line 4 by setting property ignoreLines to 4.</p>
\ No newline at end of file
--- /dev/null
+<p>Checks the header of a source file against a header that contains a regular expression for each line of the source header.</p>
+ <p>Rationale: In some projects checking against a fixed header is not sufficient, e.g. the header might require a copyright line where the year information is not static. For example, consider the following header:</p>
+<pre>
+ line 1: ^/{71}$
+ line 2: ^// checkstyle:$
+ line 3: ^// Checks Java source code for adherence to a set of rules\.$
+ line 4: ^// Copyright \(C\) \d\d\d\d Oliver Burn$
+ line 5: ^// Last modification by \$Author.*\$$
+ line 6: ^/{71}$
+ line 7:
+ line 8: ^package
+ line 9:
+ line 10: ^import
+ line 11:
+ line 12: ^/\*\*
+ line 13: ^ \*([^/]|$)
+ line 14: ^ \*/
+</pre>
+<p>Lines 1 and 6 demonstrate a more compact notation for 71 '/' characters. Line 4 enforces that the copyright notice includes a four digit year. Line 5 is an example how to enforce revision control keywords in a file header. Lines 12-14 is a template for javadoc (line 13 is so complicated to remove conflict with and of javadoc comment).</p>
+<p>Different programming languages have different comment syntax rules, but all of them start a comment with a non-word character. Hence you can often use the non-word character class to abstract away the concrete comment syntax and allow checking the header for different languages with a single header definition. For example, consider the following header specification (note that this is not the full Apache license header):</p>
+<pre>
+ line 1: ^#!
+ line 2: ^<\?xml.*>$
+ line 3: ^\W*$
+ line 4: ^\W*Copyright 2006 The Apache Software Foundation or its licensors, as applicable\.$
+ line 5: ^\W*Licensed under the Apache License, Version 2\.0 \(the "License"\);$
+ line 6: ^\W*$
+</pre>
+<p>Lines 1 and 2 leave room for technical header lines, e.g. the "#!/bin/sh" line in Unix shell scripts, or the xml file header of XML files. Set the multiline property to "1, 2" so these lines can be ignored for file types where they do no apply. Lines 3 through 6 define the actual header content. Note how lines 2, 4 and 5 use escapes for characters that have special regexp semantics.</p>
+<p>Note: ignoreLines property has been removed from this check to simplify it. To make some line optional use "^.*$" regexp for this line. </p>
\ No newline at end of file
--- /dev/null
+Check that finds import statements that use the * notation.
\ No newline at end of file
--- /dev/null
+<p> Checks that there are no static import statements. Rationale: Importing static members can lead to naming conflicts between class' members. It may lead to poor code readability since it may no longer be clear what class a member resides in (without looking at the import statement).</p>
\ No newline at end of file
--- /dev/null
+Checks for imports from a set of illegal packages, like sun.*
\ No newline at end of file
--- /dev/null
+Checks the ordering/grouping of imports. Features are:<ul>
+ <li>groups imports: ensures that groups of imports come in a specific order (e.g., java. comes first, javax. comes second, then everything else)</li>
+ <li>adds a separation between groups : ensures that a blank line sit between each group</li>
+ <li>sorts imports inside each group: ensures that imports within each group are in lexicographic order</li>
+ <li>sorts according to case: ensures that the comparison between imports is case sensitive</li>
+ <li>groups static imports: ensures the relative order between regular imports and static imports</li>
+ </ul>
\ No newline at end of file
--- /dev/null
+Checks for redundant import statements. An import statement is considered redundant if:
+<ul>
+ <li>It is a duplicate of another import. This is, when a class is imported more than once.</li>
+ <li>The class imported is from the java.lang package, e.g. importing java.lang.String.</li>
+ <li>The class imported is from the same package.</li></ul>
\ No newline at end of file
--- /dev/null
+Checks for unused import statements.
\ No newline at end of file
--- /dev/null
+Checks correct indentation of Java Code.
\ No newline at end of file
--- /dev/null
+Checks the Javadoc of a method or constructor. By default, does not check for unused throws.
+ To allow documented java.lang.RuntimeExceptions that are not declared, set property allowUndeclaredRTE to true.
+ The scope to verify is specified using the Scope class and defaults to Scope.PRIVATE.
+ To verify another scope, set property scope to a different scope.
+
+ <br><br>Error messages about parameters and type parameters for which no param tags are present can be suppressed by defining property allowMissingParamTags.
+ Error messages about exceptions which are declared to be thrown, but for which no throws tag is present can be suppressed by defining property allowMissingThrowsTags.
+ Error messages about methods which return non-void but for which no return tag is present can be suppressed by defining property allowMissingReturnTag.
+
+ <br><br>Javadoc is not required on a method that is tagged with the @Override annotation.
+ However under Java 5 it is not possible to mark a method required for an interface (this was corrected under Java 6).
+ Hence Checkstyle supports using the convention of using a single {@inheritDoc} tag instead of all the other tags.
+
+ <br><br>Note that only inheritable items will allow the {@inheritDoc} tag to be used in place of comments.
+ Static methods at all visibilities, private non-static methods and constructors are not inheritable.
\ No newline at end of file
--- /dev/null
+<p>Checks that each Java package has a Javadoc file used for commenting. By default it only allows a package-info.java file, but can be configured to allow a package.html file. An error will be reported if both files exist as this is not allowed by the Javadoc tool.</p>
\ No newline at end of file
--- /dev/null
+Validates Javadoc comments to help ensure they are well formed. The following checks are performed:
+ <ul>
+ <li>Ensures the first sentence ends with proper punctuation (That is a period, question mark, or exclamation mark, by default).
+ Javadoc automatically places the first sentence in the method summary table and index. With out proper punctuation the Javadoc may be malformed.
+ All items eligible for the {@inheritDoc} tag are exempt from this requirement.</li>
+ <li>Check text for Javadoc statements that do not have any description.
+ This includes both completely empty Javadoc, and Javadoc with only tags such as @param and @return.</li>
+ <li>Check text for incomplete HTML tags. Verifies that HTML tags have corresponding end tags and issues an "Unclosed HTML tag found:" error if not.
+ An "Extra HTML tag found:" error is issued if an end tag is found without a previous open tag.</li>
+ <li>Check that a package Javadoc comment is well-formed (as described above) and NOT missing from any package-info.java files.</li>
+ <li>Check for allowed HTML tags. The list of allowed HTML tags is "a", "abbr", "acronym", "address", "area", "b",
+ "bdo", "big", "blockquote", "br", "caption", "cite", "code", "colgroup", "del", "div", "dfn", "dl", "em", "fieldset",
+ "h1" to "h6", "hr", "i", "img", "ins", "kbd", "li", "ol", "p", "pre", "q", "samp", "small", "span", "strong",
+ "sub", "sup", "table", "tbody", "td", "tfoot", "th", "thread", "tr", "tt", "ul"</li>
+ </ul>
\ No newline at end of file
--- /dev/null
+Checks Javadoc comments for class and interface definitions. By default, does not check for author or version tags.
+ The scope to verify is specified using the Scope class and defaults to Scope.PRIVATE. To verify another scope, set property scope to one of the Scope constants.
+ To define the format for an author tag or a version tag, set property authorFormat or versionFormat respectively to a regular expression.
+ <br><br>Error messages about type parameters for which no param tags are present can be suppressed by defining property allowMissingParamTags.
\ No newline at end of file
--- /dev/null
+Checks that a variable has Javadoc comment.
\ No newline at end of file
--- /dev/null
+Outputs a JavaDoc tag as information. Can be used e.g. with the stylesheets that sort the report by author name. To define the format for a tag, set property tagFormat to a regular expression. This check uses two different severity levels. The normal one is used for reporting when the tag is missing. The additional one (tagSeverity) is used for the level of reporting when the tag exists.
\ No newline at end of file
--- /dev/null
+Restricts nested boolean operators (&&, || and ^) to a specified depth (default = 3).
\ No newline at end of file
--- /dev/null
+This metric measures the number of instantiations of other classes within the given class.
\ No newline at end of file
--- /dev/null
+The number of other classes a given class relies on.
\ No newline at end of file
--- /dev/null
+Checks cyclomatic complexity of methods against a specified limit. The complexity is measured by the number of if, while, do, for, ?:, catch, switch, case statements, and operators && and || (plus one) in the body of a constructor, method, static initializer, or instance initializer. It is a measure of the minimum number of possible paths through the source and therefore the number of required tests. Generally 1-4 is considered good, 5-7 ok, 8-10 consider re-factoring, and 11+ re-factor now !
\ No newline at end of file
--- /dev/null
+Determines complexity of methods, classes and files by counting the Non Commenting Source Statements (NCSS). This check adheres to the specification for the JavaNCSS-Tool written by Chr. Clemens Lee.
+Rougly said the NCSS metric is calculated by counting the source lines which are not comments, (nearly) equivalent to counting the semicolons and opening curly braces.
+The NCSS for a class is summarized from the NCSS of all its methods, the NCSS of its nested classes and the number of member variable declarations.
+The NCSS for a file is summarized from the ncss of all its top level classes, the number of imports and the package declaration.
+<br>
+Rationale: Too large methods and classes are hard to read and costly to maintain. A large NCSS number often means that a method or class has too many responsabilities and/or functionalities which should be decomposed into smaller units.
\ No newline at end of file
--- /dev/null
+Checks the npath complexity of a method against a specified limit (default = 200). The NPATH metric computes the number of possible execution paths through a function. It takes into account the nesting of conditional statements and multi-part boolean expressions (e.g., A && B, C || D, etc.).
\ No newline at end of file
--- /dev/null
+Checks that the order of modifiers conforms to the suggestions in the Java Language specification, sections 8.1.1, 8.3.1 and 8.4.3. The correct order is : public, protected, private, abstract, static, final, transient, volatile, synchronized, native, strictfp.
\ No newline at end of file
--- /dev/null
+Checks for redundant modifiers in interface and annotation definitions.
\ No newline at end of file
--- /dev/null
+Checks that abstract class names conform to the specified format
\ No newline at end of file
--- /dev/null
+Checks that class parameter names conform to the specified format
+
+<p>
+The following code snippet illustrates this rule for format "^[A-Z]$":
+</p>
+<pre>
+class Something<type> { // Non-compliant
+}
+
+class Something<T> { // Compliant
+}
+</pre>
--- /dev/null
+Checks that constant names conform to the specified format
\ No newline at end of file
--- /dev/null
+Checks that local final variable names, including catch parameters, conform to the specified format
\ No newline at end of file
--- /dev/null
+Checks that local, non-final variable names conform to the specified format
\ No newline at end of file
--- /dev/null
+Checks that name of non-static fields conform to the specified format
\ No newline at end of file
--- /dev/null
+Checks that method names conform to the specified format
\ No newline at end of file
--- /dev/null
+Checks that method type parameter names conform to the specified format
+
+<p>
+The following code snippet illustrates this rule for format "^[A-Z]$":
+</p>
+<pre>
+public <type> type method() { // Non-compliant
+ return null;
+}
+
+public <T> T method() { // Compliant
+}
+</pre>
--- /dev/null
+Checks that package names conform to the specified format. The default value of format
+ has been chosen to match the requirements in the Java Language specification and the Sun coding conventions.
+ However both underscores and uppercase letters are rather uncommon, so most configurations should probably
+ assign value ^[a-z]+(\.[a-z][a-z0-9]*)*$ to format
\ No newline at end of file
--- /dev/null
+Checks that parameter names conform to the specified format
\ No newline at end of file
--- /dev/null
+Checks that static, non-final fields conform to the specified format
\ No newline at end of file
--- /dev/null
+Checks that type names conform to the specified format
\ No newline at end of file
--- /dev/null
+<p>A check for detecting that matches across multiple lines. Rationale: This check can be used to when the regular expression can be span multiple lines.</p>
\ No newline at end of file
--- /dev/null
+<p> A check for detecting single lines that match a supplied regular expression. Works with any file type. Rationale: This check can be used to prototype checks and to find common bad practice such as calling ex.printStacktrace(), System.out.println(), System.exit(), etc.</p>
\ No newline at end of file
--- /dev/null
+<p>This class is variation on RegexpSingleline for detecting single lines that match a supplied regular expression in Java files. It supports suppressing matches in Java comments.</p>
\ No newline at end of file
--- /dev/null
+Checks for long anonymous inner classes.
\ No newline at end of file
--- /dev/null
+Restricts the number of executable statements to a specified limit (default = 30).
\ No newline at end of file
--- /dev/null
+<p>Checks for long source files.</p>
+ <p>Rationale: If a source file becomes very long it is hard to understand. Therefore long classes should usually be refactored into several individual classes that focus on a specific task.</p>
\ No newline at end of file
--- /dev/null
+Checks for long lines.
\ No newline at end of file
--- /dev/null
+Checks the number of methods declared in each type. This includes the number of each scope (private, package, protected and public) as well as an overall total.
--- /dev/null
+Checks for long methods.
\ No newline at end of file
--- /dev/null
+<p> Checks for the number of types declared at the outer (or root) level in a file. Rationale: It is considered good practice to only define one outer type per file.</p>
\ No newline at end of file
--- /dev/null
+Checks the number of parameters that a method or constructor has.
\ No newline at end of file
--- /dev/null
+Checks the padding of an empty for initializer; that is whether a space is required at an empty for initializer, or such spaces are forbidden. Example : <code>for ( ; i < j; i++, j--)</code>
\ No newline at end of file
--- /dev/null
+Checks the padding of an empty for iterator; that is whether a space is required at an empty for iterator, or such spaces are forbidden. Example : <code>for (Iterator foo = very.long.line.iterator(); foo.hasNext(); )</code>
\ No newline at end of file
--- /dev/null
+<p>Checks that there are no tab characters ('\t') in the source code. Rationale:
+<ul>
+ <li>Developers should not need to configure the tab width of their text editors in order to be able to read source code.</li>
+ <li>From the Apache jakarta coding standards: In a distributed development environment, when the commit messages get sent to a mailing list, they are almost impossible to read if you use tabs.</li>
+</ul></p>
\ No newline at end of file
--- /dev/null
+<p>Checks that the whitespace around the Generic tokens < and > is correct to the typical convention. The convention is not configurable.</p>
+<p>
+For example the following is legal:
+</p>
+<pre>
+ List<Integer> x = new ArrayList<Integer>();
+ List<List<Integer>> y = new ArrayList<List<Integer>>();
+</pre>
+<p>
+But the following example is not:
+</p>
+<pre>
+ List < Integer > x = new ArrayList < Integer > ();
+ List < List < Integer > > y = new ArrayList < List < Integer > > ();
+</pre>
\ No newline at end of file
--- /dev/null
+Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation; and the left parenthesis of the parameter list.
\ No newline at end of file
--- /dev/null
+Checks that there is no whitespace after a token.
\ No newline at end of file
--- /dev/null
+Checks that there is no whitespace before a token.
\ No newline at end of file
--- /dev/null
+Checks the policy on how to wrap lines on operators.
\ No newline at end of file
--- /dev/null
+Checks the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden, with the exception that it does not check for padding of the right parenthesis at an empty for iterator.
\ No newline at end of file
--- /dev/null
+Checks the padding of parentheses for typecasts.
\ No newline at end of file
--- /dev/null
+Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator.
\ No newline at end of file
--- /dev/null
+Checks that a token is surrounded by whitespace.
\ No newline at end of file
--- /dev/null
+#------------------------------------------------------------------------------
+#
+# GENERIC WORDS, sorted alphabetically
+#
+#------------------------------------------------------------------------------
+
+action=Action
+active=Active
+add_verb=Add
+age=Age
+alerts=Alerts
+all=All
+and=And
+any=Any
+ascending=Ascending
+assignee=Assignee
+author=Author
+back=Back
+backup_verb=Backup
+blocker=Blocker
+bold=Bold
+build_date=Build date
+build_time=Build time
+calendar=Calendar
+cancel=Cancel
+category=Category
+changelog=Changelog
+change_verb=Change
+class=Class
+classes=Classes
+closed=Closed
+code=Code
+color=Color
+compare=Compare
+configure=Configure
+copy=Copy
+create=Create
+created=Created
+critical=Critical
+customize=Customize
+date=Date
+days=Days
+default=Default
+delete=Delete
+descending=Descending
+description=Description
+directories=Directories
+directory=Directory
+display=Display
+download_verb=Download
+edit=Edit
+events=Events
+false=False
+file=File
+files=Files
+filter_verb=Filter
+follow=Follow
+global=Global
+hide=Hide
+identifier_abbreviated=Id
+inactive=Inactive
+info=Info
+inheritance=Inheritance
+key=Key
+language=Language
+library=Library
+links=Links
+load_verb=Load
+login=Login
+major=Major
+max=Max
+me=Me
+min=Min
+minor=Minor
+more_actions=More actions
+name=Name
+none=None
+off=Off
+on=On
+open=Open
+open_verb=Open
+operations=Operations
+optional=Optional
+order=Order
+owner=Owner
+package=Package
+packages=Packages
+parameters=Parameters
+password=Password
+path=Path
+permalinks=Permalinks
+plugin=Plugin
+project=Project
+projects=Projects
+raw=Raw
+rename=Rename
+reset_verb=Reset
+result=Result
+results=Results
+x_results={0} results
+review=Review
+reviews=Reviews
+review_verb=Review
+rule=Rule
+rules=Rules
+save=Save
+search_verb=Search
+select_all=Select all
+select_verb=Select
+severity=Severity
+severity_abbreviated=Se.
+shared=Shared
+show_verb=Show
+size=Size
+status=Status
+status_abbreviated=St.
+sub_project=Sub-project
+sub_projects=Sub-projects
+sub_view=Sub-view
+sub_views=Sub-views
+table=Table
+template=Template
+title=Title
+to=To
+treemap=Treemap
+true=True
+unfollow=Unfollow
+unit_test=Unit test
+unit_tests=Unit tests
+unselect_all=Unselect all
+unselect_verb=Unselect
+updated=Updated
+update_verb=Update
+user=User
+value=Value
+variation=Variation
+version=Version
+view=View
+views=Views
+violations=Violations
+
+
+#------------------------------------------------------------------------------
+#
+# GENERIC EXPRESSIONS, sorted alphabetically
+#
+#------------------------------------------------------------------------------
+
+activate_all=Activate all
+add_a_column=Add a column
+added_over_x_days=Added over {0} days
+added_since=Added since {0}
+added_since_previous_analysis=Added since previous analysis
+added_since_previous_analysis_detailed=Added since previous analysis ({0})
+added_since_previous_version=Added since previous version
+added_since_previous_version_detailed=Added since previous version ({0})
+added_since_version=Added since version {0}
+alerts_feed=Alerts feed
+all_violations=All violations
+are_you_sure=Are you sure?
+assigned_to=Assigned to
+bulk_change=Bulk Change
+bulleted_point=Bulleted point
+coding_rules=Coding rules
+click_to_add_to_favourites=Click to add to favourites
+click_to_remove_from_favourites=Click to remove from favourites
+created_by=Created by
+deactivate_all=Deactivate all
+default_severity=Default severity
+default_sort_on=Default sort on
+delta_since_previous_analysis=Δ since previous analysis
+delta_since_previous_version=Δ since previous version
+delta_over_x_days=Δ over {0} days
+delta_since=Δ since {0}
+delta_since_version=Δ since version {0}
+disable_treemap=Disable treemap
+enable_treemap=Enable treemap
+equals=Equals
+false_positive=False-positive
+false_positives_only=False-positives only
+full_source=Full source
+greater_or_equals=Greater or equals
+greater_than=Greater than
+help_tips=Help tips
+less_or_equals=Less or equals
+less_than=Less than
+move_left=Move left
+move_right=Move right
+new_violations=New violations
+new_window=New window
+no_data=No data
+no_lines_match_your_filter_criteria=No lines match your filter criteria.
+no_results=No results
+over_x_days=over {0} days
+page_size=Page size
+paging_first=First
+paging_last=Last
+paging_next=Next
+paging_previous=Previous
+project_name=Project name
+remove_column=Remove this column
+results_not_display_due_to_security=Due to security settings, some results are not being displayed.
+save_and_close=Save & Close
+save_and_preview=Save & Preview
+select_a_metric=Select a metric
+set_as_default=Set as default
+shared_by=Shared by
+show_more=Show more
+since_x=since {0}
+since_previous_analysis=since previous analysis
+since_previous_analysis_detailed=since previous analysis ({0})
+since_version=since version {0}
+since_version_detailed=since version {0} ({1})
+since_previous_version=since previous version
+since_previous_version_detailed=since previous version ({0})
+time_changes=Time changes
+
+#------------------------------------------------------------------------------
+#
+# RESOURCE QUALIFIERS
+#
+#------------------------------------------------------------------------------
+
+qualifier.TRK=Project
+qualifier.BRC=Sub-project
+qualifier.DIR=Directory
+qualifier.PAC=Package
+qualifier.VW=View
+qualifier.SVW=Sub-view
+qualifier.FIL=File
+qualifier.CLA=File
+qualifier.UTS=Unit Test File
+
+qualifiers.TRK=Projects
+qualifiers.BRC=Sub-projects
+qualifiers.DIR=Directories
+qualifiers.PAC=Packages
+qualifiers.VW=Views
+qualifiers.SVW=Sub-views
+qualifiers.FIL=Files
+qualifiers.CLA=Files
+qualifiers.UTS=Unit Test Files
+
+
+#------------------------------------------------------------------------------
+#
+# PROJECT LINKS
+#
+#------------------------------------------------------------------------------
+
+project_links.homepage=Home
+project_links.ci=Continuous integration
+project_links.issue=Issues
+project_links.scm=Sources
+project_links.scm_ro=Read-only connection
+project_links.scm_dev=Developer connection
+
+
+#------------------------------------------------------------------------------
+#
+# EVENT CATEGORIES
+#
+#------------------------------------------------------------------------------
+
+event.category.Version=Version
+event.category.Alert=Alert
+event.category.Profile=Profile
+event.category.Other=Other
+
+
+#------------------------------------------------------------------------------
+#
+# LAYOUT
+#
+#------------------------------------------------------------------------------
+
+layout.home=Home
+layout.login=Log in
+layout.logout=Log out
+layout.configuration=Configuration
+layout.print=Print
+layout.permalink=Permalink
+layout.sonar.slogan=Embrace Quality
+layout.powered_by=Powered by
+layout.documentation=Documentation
+layout.ask_a_questions=Ask a question
+layout.plugins=Plugins
+layout.evaluation=Embedded database should be used for evaluation purpose only
+layout.ie6_warn=Your web browser is outdated. This website may not display correctly.
+
+sidebar.project_settings=Configuration
+sidebar.security=Security
+sidebar.system=System
+
+
+#------------------------------------------------------------------------------
+#
+# PAGE TITLES, sorted alphabetically
+#
+#------------------------------------------------------------------------------
+
+action_plans.page=Action Plans
+backup.page=Backup
+clouds.page=Clouds
+components.page=Components
+coverage.page=Coverage
+default_dashboards.page=Default Dashboards
+default_filters.page=My Filters
+dependencies.page=Dependencies
+duplications.page=Duplications
+email_configuration.page=Email Settings
+event_categories.page=Event Categories
+filters.page=Filters
+system_administrators.page=System Administrators
+manual_metrics.page=Manual Metrics
+manual_measures.page=Manual Measures
+manual_rules.page=Manual Rules
+my_profile.page=My Profile
+roles.page=Roles
+project_settings.page=Settings
+project_links.page=Links
+project_exclusions.page=Exclusions
+project_history.page=History
+quality_profiles.page=Quality Profiles
+reviews.page=Reviews
+settings.page=General Settings
+source.page=Source
+system_info.page=System Info
+timemachine.page=Time Machine
+user_groups.page=Groups
+users.page=Users
+violations.page=Violations
+violations_drilldown.page=Violations Drilldown
+update_center.page=Update Center
+lcom4_viewer.page=LCOM4
+resource_deletion.page={0} Deletion
+update_key.page=Update Key
+project_quality_profile.page=Quality Profile
+bulk_deletion.page=Bulk Deletion
+
+
+# GWT pages
+org.sonar.plugins.design.ui.page.DesignPage.page=Design
+org.sonar.plugins.design.ui.libraries.LibrariesPage.page=Libraries
+org.sonar.plugins.design.ui.dependencies.DependenciesTab.page=Dependencies
+
+
+#------------------------------------------------------------------------------
+#
+# SESSION
+#
+#------------------------------------------------------------------------------
+
+sessions.remember_me=Remember me on this computer
+sessions.log_in=Log in
+sessions.new_account=Not a member? <a href="{0}" tabindex="-1">Sign up</a> for an account.
+sessions.confirm_password=Confirm password
+sessions.sign_up=Sign up
+sessions.old_account=<a href="{0}" tabindex="-1">Log in</a> if you already have an account.
+session.flash_notice.authentication_failed=Authentication failed.
+session.flash_notice.logged_out=You have been logged out.
+
+
+#------------------------------------------------------------------------------
+#
+# FILTERS
+#
+#------------------------------------------------------------------------------
+
+filters.new=New filter
+filters.size=Size
+filters.color=Color
+filters.add_filter=Add filter
+filters.edit_filter=Edit filter
+filters.manage_filters=Manage filters
+filters.search_for=Display
+filters.advanced_search=Advanced search
+filters.default_period=Differential period
+filters.when_no_language_no_filter_apply=When no language is selected, no filter will apply
+filters.favourite_only=Favourites only
+filters.resource_key_like=Resource key like
+filters.use_star_to_match=Use the character * to match zero or more characters.
+filters.resource_name_like=Resource name like
+filters.do_you_want_to_delete=Do you want to delete this filter ?
+filters.during_last=During last
+filters.prior_to_last=Prior to last
+filters.search_by_name=Search by name
+filters.add_column=Add column
+filters.default_sorted_column=Default sorted column
+filters.treemap_not_supported_for_period_selection=Treemap does not support yet the selection of a period.
+filters.my_filters=My filters
+filters.no_filters=No filters
+filters.do_you_want_to_stop_following=Do you want to stop following this filter ?
+filters.criteria=Criteria
+filters.display_form.title=Display
+filters.display_form.as=Display as
+filters.display_form.table=Table
+filters.display_form.treemap=Treemap
+filters.build_date=Build date
+filters.col.date=Build date
+filters.col.language=Language
+filters.col.name=Name
+filters.col.links=Links
+filters.col.version=Version
+filters.col.key=Key
+filters.default=Default filters
+filters.default.description=These filters are displayed on the homepage.
+filters.shared=Shared filters
+filters.shared.description=These filters are shared by administrators and can be added to default filters.
+filters.directChildrenCriterion=Direct Children
+
+#------------------------------------------------------------------------------
+#
+# REVIEWS / PROJECT REVIEWS
+#
+#------------------------------------------------------------------------------
+
+reviews.review_number=Review #{0}
+reviews.flag_as_false_positive=False-positive
+reviews.unflag_as_false_positive=Not false-positive
+reviews.flag_as_false_positive_submit=False-positive
+reviews.unflag_as_false_positive_submit=Not false-positive
+reviews.do_you_want_to_delete_comment=Do you want to delete this comment?
+reviews.only_false_positives=Only false positives
+reviews.without_false_positives=Without false positives
+reviews.showing_false_positives_only=Showing false positives only
+reviews.reviews_filtered_by_date_x_to_y=Reviews filtered by date: {0} to {1}.
+reviews.why_false_positive=Why is it a false-positive ?
+reviews.why_not_false_positive=Why is it not a false-positive anymore ?
+reviews.user_does_not_exist=\ : user does not exist. \\nPlease select a valid user or leave the field blank.
+reviews.change_severity=Change severity
+reviews.comment=Comment
+reviews.comment_submit=Comment
+reviews.update_comment_submit=Update
+reviews.new_severity_label=New severity:
+reviews.change_severity_submit=Change severity
+reviews.assign=Assign
+reviews.assign_submit=Assign
+reviews.assign_to_me_submit=Assign to me
+reviews.resolved=Resolved
+reviews.resolved_submit=Resolved
+reviews.reopen=Reopen
+reviews.reopen_submit=Reopen
+reviews.edit=Edit
+reviews.delete=Delete
+reviews.status.REOPENED=Reopened
+reviews.status.RESOLVED=Resolved
+reviews.status.OPEN=Open
+reviews.status.CLOSED=Closed
+reviews.resolution.FALSE-POSITIVE=False-positive
+reviews.resolution.FIXED=Fixed
+reviews.link_to_action_plan=Plan
+reviews.action_plan_label=Action plan
+reviews.action_plan_submit=Link
+reviews.unlink_action_plan_submit=Unlink
+reviews.no_action_plan=None
+reviews.planned_for_x=Planned for {0}
+reviews.planned_for_label=Planned for
+reviews.an_action_plan_must_be_created_first=An action plan should be first created to plan the remediation effort of this violation.
+reviews.hide_this_message=Hide this message
+reviews.filtered_by=Filtered by
+reviews.remove_this_filter=Remove this filter
+reviews.filtered_by.statuses=Status
+reviews.filtered_by.resolutions=Resolution
+reviews.filtered_by.severities=Severity
+reviews.filtered_by.authors=Author
+reviews.filtered_by.assignees=Assignee
+reviews.filtered_by.action_plan_id=Action plan
+reviews.filtered_by.unplanned=Unplanned
+reviews.filtered_by.from=From date
+reviews.filtered_by.to=To date
+
+
+#------------------------------------------------------------------------------
+#
+# ACTION PLANS
+#
+#------------------------------------------------------------------------------
+
+action_plans.page_title=Manage Action Plans
+action_plans.add_action_plan=Add action plan
+action_plans.col.status=St.
+action_plans.col.name=Name
+action_plans.col.due_for=Due for
+action_plans.col.progress=Progress
+action_plans.col.description=Description
+action_plans.col.author=Author
+action_plans.col.closed_on=Closed on
+action_plans.col.operations=Operations
+action_plans.no_action_plan=No action plan
+action_plans.no_reviews_linked_to_action_plan=No reviews linked to this action plan yet.
+action_plans.confirm_delete=Delete this action plan? Associated reviews will not be deleted.
+action_plans.confirm_close=Close this action plan? There are still open reviews linked to it.
+action_plans.create_new_action_plan=Create a new action plan
+action_plans.create_action_plan=Create action plan
+action_plans.edit_action_plan=Edit action plan
+action_plans.same_name_in_same_project=An action plan with this name already exists in this project.
+action_plans.date_format_help=The date should be entered using the following pattern: 'day/month/year'. For instance, '31/12/2011'.
+action_plans.date_not_valid=Date not valid
+action_plans.date_cant_be_in_past=The dead-line can't be in the past
+action_plans.x_out_of_x_reviews_solved={0} of {1} reviews solved
+action_plans.resolved_reviews_x_percent=Resolved reviews - {0}% ({1} reviews)
+action_plans.open_reviews_x_percent=Open reviews - {0}% ({1} reviews)
+action_plans.reopen=Reopen
+action_plans.close=Close
+action_plans.closed_action_plan=Closed action plans
+
+
+#------------------------------------------------------------------------------
+#
+# DEPENDENCIES
+#
+#------------------------------------------------------------------------------
+
+dependencies.search_library=Search library
+dependencies.search_help=Find out which projects depend on a given library.<br/>Search by group, artifact or name. E.g.: org.apache.struts, struts-core or Struts
+dependencies.select_library=Select library
+dependencies.select_version=Select version
+dependencies.used_by=Used by
+dependencies.not_used=Not used
+
+
+#------------------------------------------------------------------------------
+#
+# DASHBOARD / DASHBOARDS
+#
+#------------------------------------------------------------------------------
+
+dashboard.cannot_render_widget_x=Can not render widget {0}: {1}
+dashboard.back_to_dashboard=Back to dashboard
+dashboard.configure_widgets=Configure widgets
+dashboard.manage_dashboards=Manage dashboards
+dashboard.add_widget=Add widget
+dashboard.please_configure_the_widget_x=Please configure the widget <b>{0}</b>.
+dashboard.global_dashboards=Global Dashboards
+dashboard.project_dashboards=Project Dashboards
+dashboard.my_global_dashboards=My Global Dashboards
+dashboard.my_project_dashboards=My Project Dashboards
+dashboard.no_dashboard=No dashboard
+dashboard.do_you_want_to_delete_dashboard=Do you want to delete this dashboard ?
+dashboard.available_dashboards=Available Dashboards
+dashboard.shared_dashboards=Shared Dashboards
+dashboard.create_dashboard=New dashboard
+dashboard.create_project_dashboard=Create project dashboard
+dashboard.create_global_dashboard=Create global dashboard
+dashboard.edit_dashboard=Edit dashboard
+dashboard.update_dashboard=Update dashboard
+dashboard.not_found=This dashboard was not found
+dashboard.error_create_existing_name=A dashboard already exists with the same name
+dashboard.error_follow_existing_name=A dashboard already exists with the same name
+dashboard.default_restored=Default dashboards are restored
+dashboard.error_delete_default=This dashboard can't be deleted as long as it's defined as a default dashboard
+dashboard.error_unshare_default=This dashboard can't be unshared as long as it's defined as a default dashboard
+dashboard.global_dashboards.description=These dashboards are displayed to anonymous users or users who have not customized their dashboards.
+dashboard.project_dashboards.description=These dashboards are displayed to anonymous users or users who have not customized their dashboards.
+dashboard.shared_dashboards.description=These dashboards can be added to default dashboards.
+dashboard.username.default=[Sonar]
+
+
+#------------------------------------------------------------------------------
+#
+# SETTINGS
+#
+#------------------------------------------------------------------------------
+settings.save_category=Save {0} Settings
+property.category.email=Email
+property.category.encryption=Encryption
+property.category.general=General
+property.category.security=Security
+property.category.java=Java
+property.category.differentialViews=Differential Views
+property.category.codeCoverage=Code Coverage
+property.category.duplications=Duplications
+property.category.localization=Localization
+property.category.server_id=Server ID
+
+property.error.notBoolean=Valid options are "true" and "false"
+property.error.notInteger=Only digits are allowed
+property.error.notFloat=Not a floating point number
+property.error.notInOptions=Not a valid option
+
+
+
+#------------------------------------------------------------------------------
+#
+# DASHBOARDS
+#
+#------------------------------------------------------------------------------
+
+# Default dashboard
+dashboard.Dashboard.name=Dashboard
+dashboard.Hotspots.name=Hotspots
+dashboard.Reviews.name=Reviews
+dashboard.TimeMachine.name=Time Machine
+
+#------------------------------------------------------------------------------
+#
+# SEARCH ENGINE FOR RESOURCES
+#
+#------------------------------------------------------------------------------
+search.results=results
+search.duration=({0} seconds)
+
+#------------------------------------------------------------------------------
+#
+# WIDGETS
+#
+#------------------------------------------------------------------------------
+
+widgets.more=More
+widget.error_occurred_please_read_logs=An error occurred while trying to display the widget "{0}". Please contact the administrator.
+
+widget.alerts.name=Alerts
+widget.alerts.description=Display current alerts on the project.
+widget.alerts.no_alert=No alerts
+widget.alerts.alerts=Alerts
+
+widget.code_coverage.name=Code coverage
+widget.code_coverage.description=Reports on units tests and code coverage by unit tests.
+widget.code_coverage.line_coverage.suffix=\ line coverage
+widget.code_coverage.branch_coverage.suffix=\ branch coverage
+widget.code_coverage.on_new_code=On new code
+widget.code_coverage.no_new_lines_to_cover=No new lines to cover
+widget.code_coverage.test_success=Unit test success
+widget.code_coverage.failures.suffix=\ failures
+widget.code_coverage.errors.suffix=\ errors
+widget.code_coverage.tests.suffix=\ tests
+widget.code_coverage.skipped.suffix=\ skipped
+
+# id of this widget does not use underscore in order to be backward-compatible with previous version of JaCoCo plugin
+widget.it-coverage.name=Integration test coverage
+widget.it-coverage.description=Reports on code coverage by integration tests
+widget.it-coverage.line_coverage.suffix=\ line coverage
+widget.it-coverage.branch_coverage.suffix=\ branch coverage
+widget.it-coverage.lines_to_cover.suffix=\ lines to cover
+widget.it-coverage.on_new_code=On new code
+widget.it-coverage.no_new_lines_to_cover=No new lines to cover
+
+
+widget.comments_duplications.name=Comments & Duplications
+widget.comments_duplications.description=Reports on copy/paste and documentation
+widget.comments_duplications.comments=Comments
+widget.comments_duplications.lines.suffix=\ lines
+widget.comments_duplications.blank.suffix=\ blank
+widget.comments_duplications.docu_api.suffix=\ docu. API
+widget.comments_duplications.undocu_api.suffix=\ undocu. API
+widget.comments_duplications.commented_locs.suffix=\ commented LOCs
+widget.comments_duplications.duplications=Duplications
+widget.comments_duplications.blocks.suffix=\ blocks
+widget.comments_duplications.files.suffix=\ files
+
+widget.complexity.name=Complexity
+widget.complexity.description=Reports on complexity, average complexity and complexity distribution.
+widget.complexity.per_method.suffix=\ /method
+widget.complexity.per_paragraph.suffix=\ /paragraph
+widget.complexity.per_class.suffix=\ /class
+widget.complexity.per_file.suffix=\ /file
+widget.complexity.total=Total
+
+widget.custom_measures.name=Custom Measures
+widget.custom_measures.description=Display a list of selected measures.
+
+widget.description.name=Description
+widget.description.description=Displays general project information
+widget.description.key=Key
+widget.description.language=Language
+widget.description.profile=Profile
+widget.description.profile_version_x=version {0}
+widget.description.alerts=Alerts
+widget.description.alerts_rss_feed=RSS Feed
+widget.description.links=Links
+
+widget.events.name=Events
+widget.events.description=Reports events on the project life cycle such as versions and alerts.
+
+widget.rules.name=Rules Compliance
+widget.rules.description=Reports violations and compliance index on coding standards.
+widget.rules.violations=Violations
+widget.rules.rules_compliance=Rules compliance
+widget.rules.added=Added:
+widget.rules.removed=Removed:
+
+widget.size.name=Size metrics
+widget.size.description=Reports general metrics on the size of the project.
+widget.size.lines_of_code=Lines of code
+widget.size.lines=Lines
+widget.size.generated.suffix=\ generated
+widget.size.lines.suffix=\ lines
+widget.size.statements.suffix=\ statements
+widget.size.files.suffix=\ files
+widget.size.classes=Classes
+widget.size.files=Files
+widget.size.packages.suffix=\ packages
+widget.size.directories.suffix=\ directories
+widget.size.methods.suffix=\ methods
+widget.size.accessors.suffix=\ accessors
+widget.size.paragraphs.suffix=\ paragraphs
+widget.size.projects.suffix=\ projects
+
+widget.timeline.name=Timeline
+widget.timeline.description=Displays up to 3 metrics on a history chart.
+widget.timeline.timeline_not_displayed=No history
+
+widget.time_machine.name=History Table
+widget.time_machine.description=Displays up to 10 metrics in a table, showing their value for a specified number of past snapshots.
+
+widget.ckjm.name=Chidamber & Kemerer
+widget.ckjm.description=Reports on LCOM4 and RFC average and distribution.
+widget.ckjm.lcom4=LCOM4
+widget.ckjm.per_class.suffix=\ /class
+widget.ckjm.files_having_lcom_greater_than_one=\ files having LCOM4>1
+widget.ckjm.rfc=Response for Class
+
+widget.file_design.name=File design
+widget.file_design.description=Reports on files dependency cycles and tangle index.
+widget.file_design.file_tangle_index=File tangle index
+widget.file_design.cycles.suffix=\ cycles
+widget.file_design.suspect_file_dependencies=Suspect file dependencies
+
+widget.package_design.name=Package design
+widget.package_design.description=Reports on package dependency cycles and tangle index.
+widget.package_design.package_tangle_index=Package tangle index
+widget.package_design.cycles.suffix=\ cycles
+widget.package_design.dependencies_to_cut=Dependencies to cut
+widget.package_design.between_packages.suffix=\ between packages
+widget.package_design.between_files.suffix=\ between files
+
+widget.hotspot_metric.name=Metric hotspot
+widget.hotspot_metric.description=Shows the files that have the worst result for a specific metric.
+widget.hotspot_metric.more=More
+widget.hotspot_metric.hotspots_by_x=Hotspots by {0}
+
+widget.hotspot_most_violated_rules.name=Most violated rules
+widget.hotspot_most_violated_rules.name_when_period=Most new violated rules
+widget.hotspot_most_violated_rules.description=Shows the rules that are the most violated.
+widget.hotspot_most_violated_rules.no_violation_for_severity=No result
+widget.hotspot_most_violated_rules.any_severity=Any severity
+
+widget.hotspot_most_violated_resources.name=Most violated resources
+widget.hotspot_most_violated_resources.description=Shows the resources that have the most violations.
+widget.hotspot_most_violated_resources.no_resource=No result
+
+widget.my_reviews.name=My active reviews
+widget.my_reviews.description=Shows open/reopened reviews assigned to the current user.
+widget.my_reviews.no_review=No review.
+
+widget.project_reviews.name=Active reviews
+widget.project_reviews.description=Shows all the open/reopened reviews.
+
+widget.false_positive_reviews.name=False positives
+widget.false_positive_reviews.description=Shows all the false positives found on the project.
+
+widget.reviews_per_developer.name=Active reviews per developer
+widget.reviews_per_developer.description=Shows the number of open/reopened reviews per developer.
+widget.reviews_per_developer.not_assigned=Not assigned
+
+widget.action_plans.name=Action plans
+widget.action_plans.description=Shows all the open action plans of the project
+widget.action_plans.title=Open action plans
+widget.action_plans.no_action_plan=No action plan
+
+widget.planned_reviews.name=Planned reviews
+widget.planned_reviews.description=Shows all the planned reviews of the project, gathered by action plan
+widget.planned_reviews.no_action_plan=No action plan
+
+widget.unplanned_reviews.name=Unplanned reviews
+widget.unplanned_reviews.description=Shows all the reviews of the project that are not planned yet in an action plan
+
+widget.reviews_metrics.name=Review Activity
+widget.reviews_metrics.description=Reports metrics about reviews
+widget.reviews_metrics.no_data=No data
+widget.reviews_metrics.active_reviews=Active reviews
+widget.reviews_metrics.unassigned.suffix=\ unassigned
+widget.reviews_metrics.unplanned.suffix=\ unplanned
+widget.reviews_metrics.false_positives=False positives
+widget.reviews_metrics.unreviewed_violations=Unreviewed violations
+widget.reviews_metrics.added_unreviewed_violations=Added:
+
+widget.treemap-widget.name=Treemap of components
+widget.treemap-widget.description=Displays a treemap of all direct components of the selected resource
+
+widget.image.name=Image
+widget.image.description=Shows an image with a link
+
+widget.filter.name=Filter
+widget.filter.description=Shows a pre-configured filter
+widget.filter.edit=Edit my filters
+
+widget.resource_id=project
+
+#------------------------------------------------------------------------------
+#
+# COMPONENTS
+#
+#------------------------------------------------------------------------------
+
+components.no_projects_have_been_analysed=No projects have been analysed.
+components.explanation_launch_sonar_to_have_results=If Maven and Sonar are installed with default parameters on the same box, just launch the command <code>mvn sonar:sonar</code> to analyse your first project. In any other case, please refer to the <a href="http://www.sonarsource.org/documentation">documentation</a>.
+components.note_changes_impact_all_users=Note that these changes will impact all users and all projects.
+
+
+#------------------------------------------------------------------------------
+#
+# DRILLDOWN
+#
+#------------------------------------------------------------------------------
+
+drilldown.drilldown_on=Drilldown on
+
+violations_drilldown.click_for_more_on_x=Click for more on {0} : {1}
+violations_drilldown.col.severity=Severity
+violations_drilldown.col.rule=Rule
+violations_drilldown.no_violations=No violations
+
+
+#------------------------------------------------------------------------------
+#
+# RESOURCE VIEWER
+#
+#------------------------------------------------------------------------------
+
+resource_viewer.resource_deleted=This resource has been deleted.
+
+
+#------------------------------------------------------------------------------
+#
+# VIOLATIONS VIEWER
+#
+#------------------------------------------------------------------------------
+
+violations_viewer.review_filter.false_positives=False positives
+violations_viewer.review_filter.active=Active
+violations_viewer.review_filter.unassigned=Unassigned
+violations_viewer.review_filter.unplanned=Unplanned
+violations_viewer.review_filter.unreviewed_violations=Unreviewed violations
+
+
+#------------------------------------------------------------------------------
+#
+# DUPLICATION VIEWER
+#
+#------------------------------------------------------------------------------
+
+duplications.no_duplicated_block=No duplicated blocks.
+duplications.dups_found_on_deleted_resource=This file contains duplicated blocks with some deleted resources. This project should be reanalyzed to remove these obsolete duplicated blocks.
+duplications.old_format_should_reanalyze=This file contains duplications but a new analysis must be done in order to be able to display them.
+duplications.blocks=Blocks
+duplications.number_of_lines=Nb Lines
+duplications.from_line=From line
+duplications.file=File
+duplications.details=Details
+duplications.expand=Expand
+duplications.collapse=Collapse
+
+
+#------------------------------------------------------------------------------
+#
+# COVERAGE VIEWER
+#
+#------------------------------------------------------------------------------
+coverage_viewer.on_new_code=On new code
+coverage_viewer.unit_tests=Unit Tests
+coverage_viewer.integration_tests=Integration Tests
+
+
+#------------------------------------------------------------------------------
+#
+# GENERIC CODE VIEWER
+#
+#------------------------------------------------------------------------------
+code_viewer.create_violation.new_rule=New Rule
+code_viewer.create_violation.rules=Rules
+code_viewer.create_violation.submit=Create Violation
+code_viewer.create_violation.missing_rule=Missing rule
+code_viewer.create_violation.missing_message=Missing message
+code_viewer.create_violation.missing_severity=Missing severity
+code_viewer.create_violation.no_rules=No rules. Please contact your administrator.
+code_viewer.create_violation.bad_assignee=Unknown assignee
+
+
+#------------------------------------------------------------------------------
+#
+# DEPENDENCIES VIEWER
+#
+#------------------------------------------------------------------------------
+dependencies.ca=Afferent (incoming) couplings
+dependencies.ce=Efferent (outgoing) couplings
+
+
+#------------------------------------------------------------------------------
+#
+# MANUAL MEASURES
+#
+#------------------------------------------------------------------------------
+
+manual_measures.add_measure_link=Add measure
+manual_measures.manage_metrics_link=Manage metrics
+manual_measures.col.domain=Domain
+manual_measures.col.metric=Metric
+manual_measures.col.value=Value
+manual_measures.col.description=Description
+manual_measures.col.author=Author
+manual_measures.col.date=Date
+manual_measures.col.operations=Operations
+manual_measures.col.last_change=Last change
+manual_measures.col.last_change_label=By {0} at {1}
+manual_measures.add_measure_title=Add manual measure
+manual_measures.save_button=Save
+manual_measures.save_and_add_button=Save & Add new
+manual_measures.pending_message=Pending measures are marked with orange box. Their values will be integrated to project during next analysis.
+
+
+#------------------------------------------------------------------------------
+#
+# MANUAL MEASURES
+#
+#------------------------------------------------------------------------------
+
+manual_rules.should_provide_real_description=Rule created on the fly. A description should be provided.
+
+
+#------------------------------------------------------------------------------
+#
+# PROJECT HISTORY SERVICE
+#
+#------------------------------------------------------------------------------
+
+project_history.description=Handle events and delete quality snapshots from history.
+project_history.col.year=Year
+project_history.col.month=Month
+project_history.col.day=Day
+project_history.col.time=Time
+project_history.col.events=Events
+project_history.col.action=Action
+project_history.col.version=Version
+project_history.col.alert=Alert
+project_history.col.profile=Profile
+project_history.delete=Delete
+project_history.last_snapshot=Last snapshot
+project_history.delete_snapshot=Delete snapshot
+project_history.snapshot_deleted=The snapshot is deleted.
+project_history.are_you_sure_delete_snapshot_x=Are you sure you want to delete the snapshot created on "{0}"?
+project_history.rename_version=Rename
+project_history.create_version=Create
+project_history.remove_version=Remove
+project_history.do_you_want_to_remove_version=Are you sure you want to remove "{0}" from this snapshot?
+project_history.version_updated=Version was updated to "{0}" for current project and all its sub-projects.
+project_history.version_created=Version "{0}" was created for current project and all its sub-projects.
+project_history.version_removed=Version "{0}" was removed from current project and all its sub-projects.
+project_history.version_already_exists=Version "{0}" already exists.
+project_history.rename_event=Rename
+project_history.create_event=Create
+project_history.remove_event=Remove
+project_history.event_updated=Event was successfully updated.
+project_history.event_deleted=Event "{0}" was deleted.
+project_history.event_created=Event "{0}" was created.
+project_history.event_already_exists=Event "{0}" already exists.
+
+
+#------------------------------------------------------------------------------
+#
+# PROJECT / MODULE "UPDATE KEY" PAGE
+#
+#------------------------------------------------------------------------------
+update_key.update_resource_key=Update Key
+update_key.description=This administration page allows to change the key of a project and of its modules. Those changes must be done BEFORE analyzing the project with the new keys otherwise this operation will fail.
+update_key.bulk_update=Bulk Update
+update_key.fine_grained_key_update=Fine-grained Update
+update_key.old_key=Old key
+update_key.new_key=New key
+update_key.rename=Rename
+update_key.reset=Reset
+update_key.new_key_cant_be_blank_for_x=The new key can not be blank for "{0}".
+update_key.same_key_for_x=The new key is the same as the original one ("{0}"), nothing has been updated.
+update_key.cant_update_x_because_resource_already_exist_with_key_x="{0}" can not be renamed because "{1}" is the key of an existing resource. The update has been canceled.
+update_key.error_occured_while_renaming_key_of_x=An error occurred while renaming the key "{0}": {1}
+update_key.key_updated=The key has successfully been updated for all required resources.
+update_key.fieds_cant_be_blank_for_bulk_update=The two fields can not be blank for the bulk update.
+update_key.bulk_change_description=The bulk update allows to replace a part of the current key(s) by another string on the current project and all its submodules - if applicable.
+update_key.current_key_for_project_x_is_x=The key of the "{0}" project is currently "<b>{1}</b>".
+update_key.are_you_sure_to_rename_x=Are you sure you want to rename "{0}", as well as all its modules and resources ?
+update_key.replace=Replace
+update_key.by=By
+update_key.replace_example=Ex.: "org.myCompany"
+update_key.by_example=Ex.: "com.myNewCompany"
+update_key.cant_update_because_duplicate_keys=The replacement of "{0}" by "{1}" is impossible as it would result in duplicate keys (in red below):
+update_key.keys_will_be_updated_as_follows=The resources will be updated as follows (updated keys in bold):
+update_key.duplicate_key=Duplicate key
+update_key.bulk_update_confirmation_page=Do you really want to perform the bulk update on project keys?
+update_key.bulk_update_impossible=Bulk update can not be performed
+update_key.no_key_to_update=No key contains the string to replace ("{0}").
+
+
+#------------------------------------------------------------------------------
+#
+# PROJECT QUALITY PROFILE PAGE
+#
+#------------------------------------------------------------------------------
+project_quality_profile.select_profile_for_x=Select the quality profile to be used when analyzing the "{0}" project:
+project_quality_profile.project_cannot_be_update_with_profile_x=The current project can not be updated with the following profile: "{0}".
+project_quality_profile.profile_successfully_updated=Quality profile successfully updated.
+project_quality_profile.default_profile=default
+
+
+#------------------------------------------------------------------------------
+#
+# PROJECT (RESOURCE) DELETION PAGE
+#
+#------------------------------------------------------------------------------
+
+project_deletion.delete_resource=Delete {0}
+project_deletion.operation_cannot_be_undone=This operation can not be undone.
+project_deletion.delete_resource_confirmation=Are you sure you want to delete this {0}?
+
+
+#------------------------------------------------------------------------------
+#
+# TIME MACHINE
+#
+#------------------------------------------------------------------------------
+
+time_machine.show_date=Show date
+time_machine.show_event=Show event
+time_machine.distributions=Distributions
+time_machine.distribution_chart=Distribution chart
+time_machine.compare_on_chart=Compare on chart
+time_machine.set_as_default_for_all_users=Set as default (for all users)
+
+
+#------------------------------------------------------------------------------
+#
+# CLOUDS
+#
+#------------------------------------------------------------------------------
+
+cloud.quick_wins=Quick wins
+cloud.top_risk=Top risk
+
+
+#------------------------------------------------------------------------------
+#
+# QUALITY PROFILES
+#
+#------------------------------------------------------------------------------
+
+quality_profiles.quality_profiles=Quality profiles
+quality_profiles.new_profile=New profile
+quality_profiles.compare_profiles=Compare profiles
+quality_profiles.restore_profile=Restore profile
+quality_profiles.x_language_profiles= {0} profiles
+quality_profiles.optional_configuration_file=Optional configuration file
+quality_profiles.create_x_language_profile=Create {0} profile
+quality_profiles.are_you_sure_want_x_profile_as_default=Are you sure that you want to set the profile "{0}" as default ?
+quality_profiles.profile_x_created=Profile "{0}" created. Set it as default or link it to a project to use it for next measures.
+quality_profiles.profile_x_already_exists=This profile already exists: {0}.
+quality_profiles.please_type_profile_name=Please type a profile name.
+quality_profiles.profile_x_deleted=Profile "{0}" is deleted.
+quality_profiles.default_profile_is_x=Default profile is "{0}".
+quality_profiles.profile_x_not_activated=Profile "{0}" is created but not activated.
+quality_profiles.please_upload_backup_file=Please upload a backup file.
+quality_profiles.profile_x_associated_to_x_projects=Profile "{0}" associated to {1} projects.
+quality_profiles.profile_name_cant_be_blank=Profile name can not be blank.
+quality_profiles.profile_name_already_exists=This profile name already exists.
+quality_profiles.new_name=New name
+quality_profiles.name_for_new_profile=Name for the new profile
+quality_profiles.are_you_sure_want_delete_profile_x=Are you sure that you want to delete the profile "{0}" ?
+quality_profiles.editing_profile=Editing profile
+quality_profiles.profile_inheritance=Profile inheritance
+quality_profiles.available_projects=Available projects
+quality_profiles.associated_projects=Associated projects
+quality_profiles.no_projects_associated_to_profile_x=No projects are explicitly associated to the profile "{0}".
+quality_profiles.projects_warning=List of projects explicitly associated to this Quality profile :
+quality_profiles.including_x_overriding.suffix=, incl. {0} overriding
+quality_profiles.profile_cant_be_edited=This profile can not be edited.
+quality_profiles.set_parent=Set parent
+quality_profiles.inherit_rules_from_profile=Inherit rules configuration from the profile
+quality_profiles.no_changes_done_on_this_profile=No changes has been done on this quality profile.
+quality_profiles.changelog_from=Changelog from
+quality_profiles.no_version=no version
+quality_profiles.last_version_x_with_date=last version {0} ({1})
+quality_profiles.version_x_with_date=version {0} ({1})
+quality_profiles.profile_version=Profile version
+quality_profiles.severity_changed_from_x_to=Severity changed from {0}<b>{1}</b> to
+quality_profiles.severity_was_x=Severity was {0}<b>{1}</b>
+quality_profiles.severity_set_to_x=Severity set to {0}<b>{1}</b>
+quality_profiles.parameter_set_to_x=Parameter <b>{0}</b> set to <b>{1}</b>
+quality_profiles.parameter_was_x=Parameter <b>{0}</b> was <b>{1}</b>
+quality_profiles.parameter_reset_to_default_value_x=Parameter <b>{0}</b> reset to default value (was <b>{1}</b>)
+quality_profiles.parameter_changed_from_x_to_x=Parameter <b>{0}</b> changed from <b>{1}</b> to <b>{2}</b>
+quality_profiles.only_in_profile_x=Only in {0}
+quality_profiles.with_different_configuration=With different configuration
+quality_profiles.with_same_configuration=With same configuration
+quality_profiles.x_rules_only_in={0} rules only in
+quality_profiles.x_rules_have_different_configuration={0} rules have a different configuration
+quality_profiles.export_all_rules=All rules
+
+
+#------------------------------------------------------------------------------
+#
+# RULES CONFIGURATION
+#
+#------------------------------------------------------------------------------
+
+rules_configuration.tab.new_rule=New rule
+rules_configuration.tab.edit_rule=Edit rule
+rules_configuration.profile_cant_be_updated_description=This profile can not be updated but it can be used as a template for your own configuration. Just copy it from the profiles page.
+rules_configuration.x_found_in_active_rules={0} found in active rules
+rules_configuration.x_found_in_inactive_rules={0} found in inactive rules
+rules_configuration.expand_collapse=expand/collapse
+rules_configuration.html_allowed=HTML is allowed.
+rules_configuration.inherited_from_parent=Inherited from parent
+rules_configuration.overrides_parent_definition=Overrides parent definition
+rules_configuration.parent_parameter.empty=empty
+rules_configuration.copy_rule=Copy rule
+rules_configuration.edit_rule=Edit rule
+rules_configuration.revert_to_parent_definition=Revert to parent definition
+rules_configuration.not_inherited=Not inherited
+rules_configuration.inherited=Inherited
+rules_configuration.overrides=Overrides
+rules_configuration.rule_not_valid_message_x=Rule is not valid: <br/>{0}
+rules_configuration.rule_deleted=Rule deleted
+rules_configuration.unknown_rule=Unknown rule
+rules_configuration.x_rules_have_been_activated={0} rules have been activated.
+rules_configuration.x_rules_have_been_deactivated={0} rules have been deactivated.
+rules_configuration.extend_description=Extend description
+rules_configuration.edit_note=Edit note
+rules_configuration.add_note=Add note
+rules_configuration.confirm_delete_note=Do you really want to delete this note?
+rules_configuration.rule_inherited_from_profile_x=Rule inherited from profile "{0}"
+rules_configuration.rule_overriding_from_profile_x=Rule overrides parent definition from profile "{0}"
+rules_configuration.original_value=Original value
+rules_configuration.original_severity=Original severity
+rules_configuration.repository=Repository
+
+
+#------------------------------------------------------------------------------
+#
+# RULES DOCUMENTATION PAGE
+#
+#------------------------------------------------------------------------------
+rules.more_about_rule_on_profile_x=More about this rule on profile "{0}"
+rules.identification=Identification
+rules.parameters=Parameters
+
+
+#------------------------------------------------------------------------------
+#
+# EMAIL CONFIGURATION
+#
+#------------------------------------------------------------------------------
+email_configuration.smtp_host=SMTP host
+email_configuration.smtp_host.description=For example "smtp.gmail.com". Leave blank to disable email sending.
+email_configuration.smtp_port=SMTP port
+email_configuration.smtp_port.description=Port number to connect with SMTP server.
+email_configuration.smtp_secure_connection=Use secure connection
+email_configuration.smtp_secure_connection.description=Whether to use secure connection and its type.
+email_configuration.smtp_username=SMTP username
+email_configuration.smtp_username.description=Optional - if you use authenticated SMTP, enter your username.
+email_configuration.smtp_password=SMTP password
+email_configuration.smtp_password.description=Optional - as above, enter your password if you use authenticated SMTP.
+email_configuration.from_address=From address
+email_configuration.from_address.description=Emails will come from this address. For example - "noreply@sonarsource.com". Note that server may ignore this setting (like does GMail).
+email_configuration.email_prefix=Email prefix
+email_configuration.email_prefix.description=This prefix will be prepended to all outgoing email subjects.
+email_configuration.save_settings=Save Email Settings
+email_configuration.saving_settings=Saving
+email_configuration.settings_saved=Settings are saved.
+
+email_configuration.test.title=Test Configuration
+email_configuration.test.to_address=To
+email_configuration.test.to_address_required=You must provide address where to send test email
+email_configuration.test.subject=Subject
+email_configuration.test.subject_text=Test Message from Sonar
+email_configuration.test.message=Message
+email_configuration.test.message_text=This is a test message from Sonar
+email_configuration.test.send=Send Test Email
+email_configuration.test.sending=Sending Test Email
+email_configuration.test.email_was_sent_to_x=Email was sent to {0}
+
+
+#------------------------------------------------------------------------------
+#
+# SERVER KEY CONFIGURATION
+#
+#------------------------------------------------------------------------------
+server_id_configuration.page=Server ID
+server_id_configuration.generate_button=Generate ID
+server_id_configuration.generating_button=Generating ID...
+server_id_configuration.bad_key=The ID is not valid anymore. Please check the organisation and the IP address.
+server_id_configuration.information=The Server ID is a unique identifier of this Sonar instance. It is used for example to obtain a license key for the SonarSource's commercial plugins. Two fields have to be provided to generate the ID : organisation name and one of the IP addresses of the machine that hosts this server.
+server_id_configuration.organisation.title=Organisation
+server_id_configuration.organisation.desc=Name of the organisation
+server_id_configuration.ip.title=Fixed IP Address
+server_id_configuration.ip.desc=A server ID is linked to the IP address of the hosting machine that runs Sonar. If the server IP address was to change, the server ID will have to be regenerated. The valid addresses are :
+server_id_configuration.generation_error=Organisation and/or IP address are not valid.
+
+
+#------------------------------------------------------------------------------
+#
+# NOTIFICATIONS
+#
+#------------------------------------------------------------------------------
+notification.channel.EmailNotificationChannel=Email
+notification.dispatcher.ChangesInReviewAssignedToMeOrCreatedByMe=Changes in review assigned to me or created by me
+notification.dispatcher.NewViolationsOnMyFavouriteProject=New violations on my favourite projects introduced during the first differential view period
+
+
+#------------------------------------------------------------------------------
+#
+# ALERTS
+#
+#------------------------------------------------------------------------------
+
+alerts.no_alerts=No alerts.
+alerts.notes.description=<p>Only project measures are checked against thresholds. Modules, packages and classes are ignored.</p>Project health icons represent :
+alerts.notes.ok=at least one threshold is defined, no threshold is reached.
+alerts.notes.warn=at least one warning threshold is reached, no error threshold is reached.
+alerts.notes.error=at least one error threshold is reached.
+alerts.new_alert=New alert
+alerts.editing_alert=Editing alert
+alerts.create_alert=Create alert
+alerts.select_metric=Select a metric
+alerts.warning_threshold=Warning threshold
+alerts.warning_tooltip=A warning is triggered when this value is reached.
+alerts.error_threshold=Error threshold
+alerts.error_tooltip=An error is triggered when this value is reached.
+alerts.alert_created=Alert is created.
+alerts.alert_updated=Alert is updated.
+alerts.alert_deleted=Alert is deleted.
+alerts.operator.<=is less than
+alerts.operator.>=is greater than
+alerts.operator.\==equals
+alerts.operator.!\==is not
+
+#------------------------------------------------------------------------------
+#
+# EVENTS
+#
+#------------------------------------------------------------------------------
+
+events.add_an_event=Add an event
+events.name_required=Name (required)
+
+
+#------------------------------------------------------------------------------
+#
+# MY PROFILE
+#
+#------------------------------------------------------------------------------
+my_profile.login=Login
+my_profile.name=Name
+my_profile.email=Email
+my_profile.groups=Groups
+my_profile.password.title=Change password
+my_profile.password.old=Old value
+my_profile.password.new=New value
+my_profile.password.confirm=Confirm new value
+my_profile.password.submit=Change password
+my_profile.notifications.title=Notifications
+my_profile.notifications.submit=Save changes
+my_profile.password.changed=Password changed
+my_profile.password.empty=Password can not be empty
+my_profile.password.mismatch=Password mismatch
+my_profile.password.wrong_old=Wrong old password
+
+
+#------------------------------------------------------------------------------
+#
+# BULK RESOURCE DELETION
+#
+#------------------------------------------------------------------------------
+bulk_deletion.resource.projects=Projects
+bulk_deletion.resource.views=Views
+bulk_deletion.resource.devs=Developers
+bulk_deletion.resource_name_filter_by_name=Filter by name:
+bulk_deletion.filter=Filter
+bulk_deletion.page_size=Page size
+bulk_deletion.select_all=Select all
+bulk_deletion.select_all_x_resources=Select all {0} resources
+bulk_deletion.clear_selection=Clear selection of all {0} resources
+bulk_deletion.following_deletions_failed=The following resources could not be deleted. Please check the logs to know more about it.
+bulk_deletion.hide_message=Hide message
+bulk_deletion.sure_to_delete_the_resources=Are you sure you want to delete the selected resources?
+bulk_deletion.please_select_at_least_one_resource=Please select at least one resource to delete.
+bulk_deletion.deletion_manager.deleting_resources=Deleting resources...
+bulk_deletion.deletion_manager.no_resource_to_delete=No results.
+bulk_deletion.deletion_manager.currently_deleting_x_out_of_x=Currently deleting resources... ({0} out of {1})
+bulk_deletion.deletion_manager.deletion_completed=Resource deletion completed.
+bulk_deletion.deletion_manager.however_failures_occurred=However, some failures occurred.
+bulk_deletion.started_since_x=Started {0} ago
+
+
+#------------------------------------------------------------------------------
+#
+# TREEMAP
+#
+#------------------------------------------------------------------------------
+treemap.click_help=Left click to zoom in. Right click to zoom out.
+
+
+
+#------------------------------------------------------------------------------
+#
+# RULE SEVERITIES
+#
+#------------------------------------------------------------------------------
+
+severity.BLOCKER=Blocker
+severity.CRITICAL=Critical
+severity.MAJOR=Major
+severity.MINOR=Minor
+severity.INFO=Info
+
+#------------------------------------------------------------------------------
+#
+# METRIC DOMAINS
+#
+#------------------------------------------------------------------------------
+
+metric_domain.Size=Size
+metric_domain.Tests=Tests
+metric_domain.Integration Tests=Integration Tests
+metric_domain.Complexity=Complexity
+metric_domain.Documentation=Documentation
+metric_domain.Rules=Rules
+metric_domain.General=General
+metric_domain.Duplication=Duplication
+metric_domain.Design=Design
+metric_domain.SCM=SCM
+metric_domain.Management=Management
+metric_domain.Reviews=Reviews
+
+
+#------------------------------------------------------------------------------
+#
+# METRICS
+#
+#------------------------------------------------------------------------------
+
+metric.accessors.name=Accessors
+metric.accessors.description=Accessors
+
+metric.alert_status.name=Alert
+metric.alert_status.description=Alert
+
+metric.classes.name=Classes
+metric.classes.description=Classes
+
+metric.comment_blank_lines.name=Blank comments
+metric.comment_blank_lines.description=Comments that do not contain comments
+
+metric.comment_lines.name=Comment lines
+metric.comment_lines.description=Number of comment lines
+
+metric.comment_lines_density.name=Comments (%)
+metric.comment_lines_density.description=Comments balanced by ncloc + comment lines
+
+metric.commented_out_code_lines.name=Commented-out LOC
+metric.commented_out_code_lines.description=Commented lines of code
+
+metric.complexity.name=Complexity
+metric.complexity.description=Cyclomatic complexity
+
+metric.directories.name=Directories
+metric.directories.description=Directories
+
+metric.files.name=Files
+metric.files.description=Number of files
+
+metric.functions.name=Methods
+metric.functions.description=Methods
+
+metric.generated_lines.name=Generated Lines
+metric.generated_lines.description=Number of generated lines
+
+metric.generated_ncloc.name=Generated lines of code
+metric.generated_ncloc.description=Generated non Commenting Lines of Code
+
+metric.lines.name=Lines
+metric.lines.description=Lines
+
+metric.ncloc.name=Lines of code
+metric.ncloc.description=Non Commenting Lines of Code
+
+metric.packages.name=Packages
+metric.packages.description=Packages
+
+metric.paragraphs.name=Paragraphs
+metric.paragraphs.description=Number of paragraphs
+
+metric.public_api.name=Public API
+metric.public_api.description=Public API
+
+metric.public_documented_api_density.name=Public documented API (%)
+metric.public_documented_api_density.description=Public documented classes and methods balanced by ncloc
+
+metric.public_undocumented_api.name=Public undocumented API
+metric.public_undocumented_api.description=Public undocumented classes, methods and variables
+
+metric.statements.name=Statements
+metric.statements.description=Number of statements
+
+
+
+metric.class_complexity.name=Complexity /class
+metric.class_complexity.description=Complexity average by class
+
+metric.function_complexity.name=Complexity /method
+metric.function_complexity.description=Complexity average by method
+
+metric.file_complexity.name=Complexity /file
+metric.file_complexity.description=Complexity average by file
+
+metric.paragraph_complexity.name=Complexity /paragraph
+metric.paragraph_complexity.description=Complexity average by paragraph
+
+metric.class_complexity_distribution.name=Classes distribution /complexity
+metric.class_complexity_distribution.description=Classes distribution /complexity
+
+metric.function_complexity_distribution.name=Methods distribution /complexity
+metric.function_complexity_distribution.description=Methods distribution /complexity
+
+metric.file_complexity_distribution.name=Files distribution /complexity
+metric.file_complexity_distribution.description=Files distribution /complexity
+
+metric.paragraph_complexity_distribution.name=Paragraph distribution /complexity
+metric.paragraph_complexity_distribution.description=Paragraph distribution /complexity
+
+#--------------------------------------------------------------------------------------------------------------------
+#
+# UNIT TESTS
+#
+#--------------------------------------------------------------------------------------------------------------------
+
+metric.tests.name=Unit tests
+metric.tests.description=Number of unit tests
+
+metric.test_execution_time.name=Unit tests duration
+metric.test_execution_time.description=Execution duration of unit tests
+
+metric.test_errors.name=Unit test errors
+metric.test_errors.description=Number of unit test errors
+
+metric.skipped_tests.name=Skipped unit tests
+metric.skipped_tests.description=Number of skipped unit tests
+
+metric.test_failures.name=Unit test failures
+metric.test_failures.description=Number of unit test failures
+
+metric.test_success_density.name=Unit test success (%)
+metric.test_success_density.description=Density of successful unit tests
+
+metric.test_data.name=Unit tests details
+metric.test_data.description=Unit tests details
+
+metric.coverage.name=Coverage
+metric.coverage.description=Coverage by unit tests
+
+metric.new_coverage.name=New coverage
+metric.new_coverage.description=Coverage of new/changed code
+
+metric.lines_to_cover.name=Lines to cover
+metric.lines_to_cover.description=Lines to cover
+
+metric.new_lines_to_cover.name=New lines to cover
+metric.new_lines_to_cover.description=New lines to cover
+
+metric.uncovered_lines.name=Uncovered lines
+metric.uncovered_lines.description=Uncovered lines
+
+metric.new_uncovered_lines.name=New uncovered lines
+metric.new_uncovered_lines.description=New uncovered lines
+
+metric.line_coverage.name=Line coverage
+metric.line_coverage.description=Line coverage
+
+metric.new_line_coverage.name=New line coverage
+metric.new_line_coverage.description=Line coverage of added/changed code
+
+metric.coverage_line_hits_data.name=Coverage hits by line
+metric.coverage_line_hits_data.description=Coverage hits by line
+
+metric.conditions_to_cover.name=Branches to cover
+metric.conditions_to_cover.description=Branches to cover
+
+metric.new_conditions_to_cover.name=New branches to cover
+metric.new_conditions_to_cover.description=New branches to cover
+
+metric.uncovered_conditions.name=Uncovered branches
+metric.uncovered_conditions.description=Uncovered branches
+
+metric.new_uncovered_conditions.name=New uncovered branches
+metric.new_uncovered_conditions.description=New uncovered branches
+
+metric.branch_coverage.name=Branch coverage
+metric.branch_coverage.description=Branch coverage
+
+metric.new_branch_coverage.name=New branch coverage
+metric.new_branch_coverage.description=Branch coverage of new/changed code
+
+metric.branch_coverage_hits_data.name=Branch coverage hits
+metric.branch_coverage_hits_data.description=Branch coverage hits
+
+metric.conditions_by_line.name=Branches by line
+metric.conditions_by_line.description=Branches by line
+
+metric.covered_conditions_by_line.name=Covered branches by line
+metric.covered_conditions_by_line.description=Covered branches by line
+
+
+#--------------------------------------------------------------------------------------------------------------------
+#
+# INTEGRATION TESTS
+#
+#--------------------------------------------------------------------------------------------------------------------
+
+metric.it_coverage.name=IT Coverage
+metric.it_coverage.description=Integration Test Coverage
+
+metric.it_lines_to_cover.name=IT Lines to Cover
+metric.it_lines_to_cover.description=Lines to cover by Integration Tests
+
+metric.it_uncovered_lines.name=IT Uncovered Lines
+metric.it_uncovered_lines.description=Uncovered lines by Integration Tests
+
+metric.it_line_coverage.name=IT Line Coverage
+metric.it_line_coverage.description=Line coverage by Integration Tests
+
+metric.it_coverage_line_hits_data.name=IT Coverage hits by line
+metric.it_coverage_line_hits_data.description=Coverage hits by line by Integration Tests
+
+metric.it_conditions_to_cover.name=IT Branches to Cover
+metric.it_conditions_to_cover.description=Branches to cover by Integration Tests
+
+metric.it_uncovered_conditions.name=IT Uncovered Branches
+metric.it_uncovered_conditions.description=Uncovered branches by Integration Tests
+
+metric.it_branch_coverage.name=IT Branch Coverage
+metric.it_branch_coverage.description=Branch coverage by Integration Tests
+
+metric.it_conditions_by_line.name=IT Branches by Line
+metric.it_conditions_by_line.description=IT Branches by line
+
+metric.it_covered_conditions_by_line.name=IT Covered Branches by Line
+metric.it_covered_conditions_by_line.description=IT Covered branches by line
+
+metric.new_it_coverage.name=New IT Coverage
+metric.new_it_coverage.description=Integration Test Coverage of new/changed code
+
+metric.new_it_lines_to_cover.name=New Lines to Cover by IT
+metric.new_it_lines_to_cover.description=New lines to cover by integration tests
+
+metric.new_it_uncovered_lines.name=New Lines Uncovered by IT
+metric.new_it_uncovered_lines.description=New lines that are not covered by integration tests
+
+metric.new_it_line_coverage.name=New IT Line Coverage
+metric.new_it_line_coverage.description=Integration Test Line coverage of added/changed code
+
+metric.new_it_conditions_to_cover.name=New Branches to Cover by IT
+metric.new_it_conditions_to_cover.description=New branches to cover by integration tests
+
+metric.new_it_uncovered_conditions.name=New Branches Uncovered by IT
+metric.new_it_uncovered_conditions.description=New branches that are not covered by IT
+
+metric.new_it_branch_coverage.name=New IT Branch Coverage
+metric.new_it_branch_coverage.description=Integration Test Branch Coverage of new/changed code
+
+#--------------------------------------------------------------------------------------------------------------------
+#
+# DUPLICATIONS
+#
+#--------------------------------------------------------------------------------------------------------------------
+
+metric.duplicated_lines.name=Duplicated lines
+metric.duplicated_lines.description=Duplicated lines
+
+metric.duplicated_blocks.name=Duplicated blocks
+metric.duplicated_blocks.description=Duplicated blocks
+
+metric.duplicated_files.name=Duplicated files
+metric.duplicated_files.description=Duplicated files
+
+metric.duplicated_lines_density.name=Duplicated lines (%)
+metric.duplicated_lines_density.description=Duplicated lines balanced by statements
+
+metric.duplications_data.name=Duplications details
+metric.duplications_data.description=Duplications details
+
+#--------------------------------------------------------------------------------------------------------------------
+#
+# CODING RULES
+#
+#--------------------------------------------------------------------------------------------------------------------
+
+metric.usability.name=Usability
+metric.usability.description=Usability
+
+metric.reliability.name=Reliability
+metric.reliability.description=Reliability
+
+metric.efficiency.name=Efficiency
+metric.efficiency.description=Efficiency
+
+metric.portability.name=Portability
+metric.portability.description=Portability
+
+metric.maintainability.name=Maintainability
+metric.maintainability.description=Maintainability
+
+metric.weighted_violations.name=Weighted violations
+metric.weighted_violations.description=Weighted Violations
+
+metric.violations_density.name=Rules compliance
+metric.violations_density.description=Rules compliance
+
+metric.violations.name=Violations
+metric.violations.description=Violations
+
+metric.blocker_violations.name=Blocker violations
+metric.blocker_violations.description=Blocker violations
+
+metric.critical_violations.name=Critical violations
+metric.critical_violations.description=Critical violations
+
+metric.major_violations.name=Major violations
+metric.major_violations.description=Major violations
+
+metric.minor_violations.name=Minor violations
+metric.minor_violations.description=Minor violations
+
+metric.info_violations.name=Info violations
+metric.info_violations.description=Info violations
+
+metric.new_violations.name=New violations
+metric.new_violations.description=New Violations
+
+metric.new_blocker_violations.name=New Blocker violations
+metric.new_blocker_violations.description=New Blocker violations
+
+metric.new_critical_violations.name=New Critical violations
+metric.new_critical_violations.description=New Critical violations
+
+metric.new_major_violations.name=New Major violations
+metric.new_major_violations.description=New Major violations
+
+metric.new_minor_violations.name=New Minor violations
+metric.new_minor_violations.description=New Minor violations
+
+metric.new_info_violations.name=New Info violations
+metric.new_info_violations.description=New Info violations
+
+#--------------------------------------------------------------------------------------------------------------------
+#
+# DESIGN
+#
+#--------------------------------------------------------------------------------------------------------------------
+
+metric.abstractness.name=Abstractness
+metric.abstractness.description=Abstractness
+
+metric.instability.name=Instability
+metric.instability.description=Instability
+
+metric.distance.name=Distance
+metric.distance.description=Distance
+
+metric.dit.name=Depth in Tree
+metric.dit.description=Depth in Inheritance Tree
+
+metric.noc.name=Number of Children
+metric.noc.description=Number of Children
+
+metric.rfc.name=Response for Class
+metric.rfc.description=Response for Class
+
+metric.rfc_distribution.name=Class distribution /RFC
+metric.rfc_distribution.description=Class distribution /RFC
+
+metric.lcom4.name=LCOM4
+metric.lcom4.description=Lack of Cohesion of Methods
+
+metric.lcom4_blocks.name=LCOM4 blocks
+metric.lcom4_blocks.description=LCOM4 blocks
+
+metric.lcom4_distribution.name=Class distribution /LCOM4
+metric.lcom4_distribution.description=Class distribution /LCOM4
+
+metric.suspect_lcom4_density.name=Suspect LCOM4 density
+metric.suspect_lcom4_density.description=Density of classes having LCOM4>1
+
+metric.ca.name=Afferent couplings
+metric.ca.description=Afferent couplings
+
+metric.ce.name=Efferent couplings
+metric.ce.description=Efferent couplings
+
+metric.dsm.name=Dependency Matrix
+metric.dsm.description=Dependency Matrix
+
+metric.package_cycles.name=Package cycles
+metric.package_cycles.description=Package cycles
+
+metric.package_tangle_index.name=Package tangle index
+metric.package_tangle_index.description=Package tangle index
+
+metric.package_tangles.name=File dependencies to cut
+metric.package_tangles.description=File dependencies to cut
+
+metric.package_feedback_edges.name=Package dependencies to cut
+metric.package_feedback_edges.description=Package dependencies to cut
+
+metric.package_edges_weight.name=Package edges weight
+metric.package_edges_weight.description=Package edges weight
+
+metric.file_cycles.name=File cycles
+metric.file_cycles.description=File cycles
+
+metric.file_tangle_index.name=File tangle index
+metric.file_tangle_index.description=File tangle index
+
+metric.file_tangles.name=File tangles
+metric.file_tangles.description=Files tangles
+
+metric.file_feedback_edges.name=Suspect file dependencies
+metric.file_feedback_edges.description=Suspect file dependencies
+
+metric.file_edges_weight.name=File edges weight
+metric.file_edges_weight.description=File edges weight
+
+metric.commits.name=Commits
+metric.commits.description=Commits
+
+metric.last_commit_date.name=Last commit
+metric.last_commit_date.description=Last commit
+
+metric.revision.name=Revision
+metric.revision.description=Revision
+
+metric.authors_by_line.name=Authors by line
+metric.authors_by_line.description=Authors by line
+
+metric.revisions_by_line.name=Revisions by line
+metric.revisions_by_line.description=Revisions by line
+
+metric.last_commit_datetimes_by_line.name=Last commit dates by line
+metric.last_commit_datetimes_by_line.description=Last commit dates by line
+
+metric.profile.name=Profile
+metric.profile.description=Selected quality profile
+
+metric.profile_version.name=Profile version
+metric.profile_version.description=Selected quality profile version
+
+
+#--------------------------------------------------------------------------------------------------------------------
+#
+# MANUAL METRICS
+#
+#--------------------------------------------------------------------------------------------------------------------
+metric.burned_budget.name=Burned budget
+metric.burned_budget.description=The budget already used in the project
+
+metric.business_value.name=Business value
+metric.business_value.description=An indication on the value of the project for the business
+
+metric.team_size.name=Team size
+metric.team_size.description=Size of the project team
+
+
+#--------------------------------------------------------------------------------------------------------------------
+#
+# REVIEWS METRICS
+#
+#--------------------------------------------------------------------------------------------------------------------
+metric.unreviewed_violations.name=Unreviewed violations
+metric.unreviewed_violations.description=Violations that have not been reviewed yet
+
+metric.new_unreviewed_violations.name=New unreviewed violations
+metric.new_unreviewed_violations.description=New violations that have not been reviewed yet
+
+metric.false_positive_reviews.name=False-positive reviews
+metric.false_positive_reviews.description=Active false-positive reviews
+
+metric.active_reviews.name=Active reviews
+metric.active_reviews.description=Active open and reopened reviews
+
+metric.unassigned_reviews.name=Unassigned reviews
+metric.unassigned_reviews.description=Active unassigned reviews
+
+metric.unplanned_reviews.name=Unplanned reviews
+metric.unplanned_reviews.description=Active unplanned reviews
+
+
+#--------------------------------------------------------------------------------------------------------------------
+#
+# [GWT] UNIT TEST VIEWER
+#
+#--------------------------------------------------------------------------------------------------------------------
+unittest.duration=Duration
+unittest.name=Unit test name
+unittest.skipped=skipped
+unittest.tests=Tests
+unittest.failures=Failures/Errors
<configuration>
<rules>
<requireFilesSize>
- <maxsize>4600000</maxsize>
- <minsize>4000000</minsize>
+ <maxsize>4800000</maxsize>
+ <minsize>4600000</minsize>
<files>
<file>${project.build.directory}/${project.build.finalName}.jar</file>
</files>
--- /dev/null
+rule.findbugs.IMSE_DONT_CATCH_IMSE.name=Bad practice - Dubious catching of IllegalMonitorStateException
+rule.findbugs.BX_BOXING_IMMEDIATELY_UNBOXED.name=Performance - Primitive value is boxed and then immediately unboxed
+rule.findbugs.IJU_SETUP_NO_SUPER.name=Correctness - TestCase defines setUp that doesn't call super.setUp()
+rule.findbugs.TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED.name=Correctness - Value annotated as carrying a type qualifier used where a value that must not carry that qualifier is required
+rule.findbugs.TLW_TWO_LOCK_WAIT.name=Multithreaded correctness - Wait with two locks held
+rule.findbugs.RV_01_TO_INT.name=Correctness - Random value from 0 to 1 is coerced to the integer 0
+rule.findbugs.NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE.name=Dodgy - Parameter must be nonnull but is marked as nullable
+rule.findbugs.RV_ABSOLUTE_VALUE_OF_RANDOM_INT.name=Correctness - Bad attempt to compute absolute value of signed 32-bit random integer
+rule.findbugs.EC_INCOMPATIBLE_ARRAY_COMPARE.name=Correctness - equals(...) used to compare incompatible arrays
+rule.findbugs.UL_UNRELEASED_LOCK_EXCEPTION_PATH.name=Multithreaded correctness - Method does not release lock on all exception paths
+rule.findbugs.SE_NONSTATIC_SERIALVERSIONID.name=Bad practice - serialVersionUID isn't static
+rule.findbugs.UCF_USELESS_CONTROL_FLOW.name=Dodgy - Useless control flow
+rule.findbugs.BC_IMPOSSIBLE_CAST.name=Correctness - Impossible cast
+rule.findbugs.XSS_REQUEST_PARAMETER_TO_SEND_ERROR.name=Security - Servlet reflected cross site scripting vulnerability
+rule.findbugs.DM_NEW_FOR_GETCLASS.name=Performance - Method allocates an object, only to get the class object
+rule.findbugs.OBL_UNSATISFIED_OBLIGATION.name=Experimental - Method may fail to clean up stream or resource
+rule.findbugs.UW_UNCOND_WAIT.name=Multithreaded correctness - Unconditional wait
+rule.findbugs.DLS_DEAD_LOCAL_STORE_OF_NULL.name=Dodgy - Dead store of null to local variable
+rule.findbugs.NM_CLASS_NAMING_CONVENTION.name=Class names should start with an upper case letter
+rule.findbugs.RC_REF_COMPARISON_BAD_PRACTICE_BOOLEAN.name=Correctness - Suspicious reference comparison of Boolean values
+rule.findbugs.MWN_MISMATCHED_NOTIFY.name=Multithreaded correctness - Mismatched notify()
+rule.findbugs.NM_VERY_CONFUSING.name=Correctness - Very confusing method names
+rule.findbugs.FI_NULLIFY_SUPER.name=Bad practice - Finalizer nullifies superclass finalizer
+rule.findbugs.MTIA_SUSPECT_STRUTS_INSTANCE_FIELD.name=Dodgy - Class extends Struts Action class and uses instance variables
+rule.findbugs.DM_STRING_CTOR.name=Performance - Method invokes inefficient new String(String) constructor
+rule.findbugs.STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE.name=Multithreaded correctness - Call to static DateFormat
+rule.findbugs.NP_NULL_PARAM_DEREF_NONVIRTUAL.name=Correctness - Non-virtual method call passes null for nonnull parameter
+rule.findbugs.FI_EMPTY.name=Bad practice - Empty finalizer should be deleted
+rule.findbugs.CD_CIRCULAR_DEPENDENCY.name=Experimental - Test for circular dependencies among classes
+rule.findbugs.EC_UNRELATED_TYPES.name=Correctness - Call to equals() comparing different types
+rule.findbugs.EI_EXPOSE_STATIC_REP2.name=Malicious code vulnerability - May expose internal static state by storing a mutable object into a static field
+rule.findbugs.DMI_INVOKING_TOSTRING_ON_ANONYMOUS_ARRAY.name=Correctness - Invocation of toString on an anonymous array
+rule.findbugs.SIC_INNER_SHOULD_BE_STATIC_ANON.name=Performance - Could be refactored into a named static inner class
+rule.findbugs.STI_INTERRUPTED_ON_UNKNOWNTHREAD.name=Correctness - Static Thread.interrupted() method invoked on thread instance
+rule.findbugs.CN_IDIOM_NO_SUPER_CALL.name=Bad practice - clone method does not call super.clone()
+rule.findbugs.VA_FORMAT_STRING_BAD_ARGUMENT.name=Correctness - Format string placeholder incompatible with passed argument
+rule.findbugs.EQ_DOESNT_OVERRIDE_EQUALS.name=Dodgy - Class doesn't override equals in superclass
+rule.findbugs.BC_IMPOSSIBLE_DOWNCAST_OF_TOARRAY.name=Correctness - Impossible downcast of toArray() result
+rule.findbugs.SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION.name=Bad practice - Class is Externalizable but doesn't define a void constructor
+rule.findbugs.TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_ALWAYS_SINK.name=Correctness - Value required to have type qualifier, but marked as unknown
+rule.findbugs.SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS.name=Performance - Could be refactored into a static inner class
+rule.findbugs.EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS.name=Bad practice - Equals checks for noncompatible operand
+rule.findbugs.RV_RETURN_VALUE_OF_PUTIFABSENT_IGNORED.name=Correctness - Return value of putIfAbsent ignored, value passed to putIfAbsent reused
+rule.findbugs.STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE.name=Multithreaded correctness - Call to static Calendar
+rule.findbugs.MS_CANNOT_BE_FINAL.name=Malicious code vulnerability - Field isn't final and can't be protected from malicious code
+rule.findbugs.IS_INCONSISTENT_SYNC.name=Multithreaded correctness - Inconsistent synchronization
+rule.findbugs.SE_NO_SERIALVERSIONID.name=Bad practice - Class is Serializable, but doesn't define serialVersionUID
+rule.findbugs.EI_EXPOSE_REP2.name=Malicious code vulnerability - May expose internal representation by incorporating reference to mutable object
+rule.findbugs.NM_METHOD_CONSTRUCTOR_CONFUSION.name=Correctness - Apparent method/constructor confusion
+rule.findbugs.ICAST_INTEGER_MULTIPLY_CAST_TO_LONG.name=Dodgy - Result of integer multiplication cast to long
+rule.findbugs.QF_QUESTIONABLE_FOR_LOOP.name=Dodgy - Complicated, subtle or wrong increment in for-loop
+rule.findbugs.DLS_DEAD_STORE_OF_CLASS_LITERAL.name=Correctness - Dead store of class literal
+rule.findbugs.NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER.name=Bad practice - Use of identifier that is a keyword in later versions of Java
+rule.findbugs.BC_VACUOUS_INSTANCEOF.name=Dodgy - instanceof will always return true
+rule.findbugs.INT_VACUOUS_BIT_OPERATION.name=Dodgy - Vacuous bit mask operation on integer value
+rule.findbugs.NP_NULL_INSTANCEOF.name=Correctness - A known null value is checked to see if it is an instance of a type
+rule.findbugs.SIC_THREADLOCAL_DEADLY_EMBRACE.name=Correctness - Deadly embrace of non-static inner class and thread local
+rule.findbugs.EQ_UNUSUAL.name=Dodgy - Unusual equals method
+rule.findbugs.IJU_NO_TESTS.name=Correctness - TestCase has no tests
+rule.findbugs.EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC.name=Correctness - equals method overrides equals in superclass and may not be symmetric
+rule.findbugs.XFB_XML_FACTORY_BYPASS.name=Dodgy - Method directly allocates a specific implementation of xml interfaces
+rule.findbugs.SWL_SLEEP_WITH_LOCK_HELD.name=Multithreaded correctness - Method calls Thread.sleep() with a lock held
+rule.findbugs.CN_IDIOM.name=Bad practice - Class implements Cloneable but does not define or use clone method
+rule.findbugs.WA_AWAIT_NOT_IN_LOOP.name=Multithreaded correctness - Condition.await() not in loop
+rule.findbugs.DM_FP_NUMBER_CTOR.name=Performance - Method invokes inefficient floating-point Number constructor; use static valueOf instead
+rule.findbugs.SF_SWITCH_NO_DEFAULT.name=Switch statement found where default case is missing
+rule.findbugs.NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE.name=Dodgy - Possible null pointer dereference due to return value of called method
+rule.findbugs.NP_CLONE_COULD_RETURN_NULL.name=Bad practice - Clone method may return null
+rule.findbugs.MS_OOI_PKGPROTECT.name=Malicious code vulnerability - Field should be moved out of an interface and made package protected
+rule.findbugs.DM_BOXED_PRIMITIVE_TOSTRING.name=Performance - Method allocates a boxed primitive just to call toString
+rule.findbugs.EQ_ABSTRACT_SELF.name=Bad practice - Abstract class defines covariant equals() method
+rule.findbugs.DM_STRING_TOSTRING.name=Performance - Method invokes toString() method on a String
+rule.findbugs.SE_METHOD_MUST_BE_PRIVATE.name=Correctness - Method must be private in order for serialization to work
+rule.findbugs.DL_SYNCHRONIZATION_ON_BOOLEAN.name=Multithreaded correctness - Synchronization on Boolean could lead to deadlock
+rule.findbugs.UWF_UNWRITTEN_FIELD.name=Correctness - Unwritten field
+rule.findbugs.IS2_INCONSISTENT_SYNC.name=Multithreaded correctness - Inconsistent synchronization
+rule.findbugs.IM_AVERAGE_COMPUTATION_COULD_OVERFLOW.name=Dodgy - Computation of average could overflow
+rule.findbugs.BIT_SIGNED_CHECK_HIGH_BIT.name=Correctness - Check for sign of bitwise operation
+rule.findbugs.FL_MATH_USING_FLOAT_PRECISION.name=Correctness - Method performs math using floating point precision
+rule.findbugs.WS_WRITEOBJECT_SYNC.name=Multithreaded correctness - Class's writeObject() method is synchronized but nothing else is
+rule.findbugs.RV_RETURN_VALUE_IGNORED.name=Correctness - Method ignores return value
+rule.findbugs.SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE.name=Security - Nonconstant string passed to execute method on an SQL statement
+rule.findbugs.JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS.name=Bad practice - Fields of immutable classes should be final
+rule.findbugs.AM_CREATES_EMPTY_ZIP_FILE_ENTRY.name=Bad practice - Creates an empty zip file entry
+rule.findbugs.DM_NEXTINT_VIA_NEXTDOUBLE.name=Performance - Use the nextInt method of Random rather than nextDouble to generate a random integer
+rule.findbugs.UI_INHERITANCE_UNSAFE_GETRESOURCE.name=Bad practice - Usage of GetResource may be unsafe if class is extended
+rule.findbugs.SIO_SUPERFLUOUS_INSTANCEOF.name=Correctness - Unnecessary type check done using instanceof operator
+rule.findbugs.EQ_OTHER_NO_OBJECT.name=Correctness - equals() method defined that doesn't override equals(Object)
+rule.findbugs.USM_USELESS_ABSTRACT_METHOD.name=Experimental - Abstract Method is already defined in implemented interface
+rule.findbugs.MTIA_SUSPECT_SERVLET_INSTANCE_FIELD.name=Dodgy - Class extends Servlet class and uses instance variables
+rule.findbugs.DM_USELESS_THREAD.name=Multithreaded correctness - A thread was created using the default empty run method
+rule.findbugs.ML_SYNC_ON_UPDATED_FIELD.name=Multithreaded correctness - Method synchronizes on an updated field
+rule.findbugs.CO_SELF_NO_OBJECT.name=Bad practice - Covariant compareTo() method defined
+rule.findbugs.BC_UNCONFIRMED_CAST.name=Dodgy - Unchecked/unconfirmed cast
+rule.findbugs.FI_FINALIZER_NULLS_FIELDS.name=Bad practice - Finalizer nulls fields
+rule.findbugs.BIT_AND.name=Correctness - Incompatible bit masks (BIT_AND)
+rule.findbugs.FE_FLOATING_POINT_EQUALITY.name=Dodgy - Test for floating point equality
+rule.findbugs.TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_NEVER_SINK.name=Correctness - Value required to not have type qualifier, but marked as unknown
+rule.findbugs.NP_NULL_PARAM_DEREF.name=Correctness - Method call passes null for nonnull parameter
+rule.findbugs.FB_MISSING_EXPECTED_WARNING.name=Experimental - Missing expected or desired warning from FindBugs
+rule.findbugs.DMI_INVOKING_HASHCODE_ON_ARRAY.name=Correctness - Invocation of hashCode on an array
+rule.findbugs.QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT.name=Correctness - Method assigns boolean literal in boolean expression
+rule.findbugs.SA_FIELD_SELF_COMPARISON.name=Correctness - Self comparison of field with itself
+rule.findbugs.UR_UNINIT_READ_CALLED_FROM_SUPER_CONSTRUCTOR.name=Correctness - Uninitialized read of field method called from constructor of superclass
+rule.findbugs.ES_COMPARING_PARAMETER_STRING_WITH_EQ.name=Bad practice - Comparison of String parameter using == or !=
+rule.findbugs.INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE.name=Correctness - Bad comparison of nonnegative value with negative constant
+rule.findbugs.INT_BAD_COMPARISON_WITH_SIGNED_BYTE.name=Correctness - Bad comparison of signed byte
+rule.findbugs.IO_APPENDING_TO_OBJECT_OUTPUT_STREAM.name=Correctness - Doomed attempt to append to an object output stream
+rule.findbugs.FI_MISSING_SUPER_CALL.name=Bad practice - Finalizer does not call superclass finalizer
+rule.findbugs.VA_FORMAT_STRING_EXTRA_ARGUMENTS_PASSED.name=Correctness - More arguments are passed that are actually used in the format string
+rule.findbugs.HE_EQUALS_USE_HASHCODE.name=Bad practice - Class defines equals() and uses Object.hashCode()
+rule.findbugs.IJU_BAD_SUITE_METHOD.name=Correctness - TestCase declares a bad suite method
+rule.findbugs.DMI_CONSTANT_DB_PASSWORD.name=Security - Hardcoded constant database password
+rule.findbugs.REC_CATCH_EXCEPTION.name=Dodgy - Exception is caught when Exception is not thrown
+rule.findbugs.PS_PUBLIC_SEMAPHORES.name=Dodgy - Class exposes synchronization and semaphores in its public interface
+rule.findbugs.EC_UNRELATED_INTERFACES.name=Correctness - Call to equals() comparing different interface types
+rule.findbugs.UCF_USELESS_CONTROL_FLOW_NEXT_LINE.name=Correctness - Useless control flow to next line
+rule.findbugs.LG_LOST_LOGGER_DUE_TO_WEAK_REFERENCE.name=Experimental - Potential lost logger changes due to weak reference in OpenJDK
+rule.findbugs.NP_UNWRITTEN_FIELD.name=Correctness - Read of unwritten field
+rule.findbugs.DMI_UNSUPPORTED_METHOD.name=Dodgy - Call to unsupported method
+rule.findbugs.RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE.name=Dodgy - Redundant comparison of non-null value to null
+rule.findbugs.EC_BAD_ARRAY_COMPARE.name=Correctness - Invocation of equals() on an array, which is equivalent to ==
+rule.findbugs.EI_EXPOSE_REP.name=Malicious code vulnerability - May expose internal representation by returning reference to mutable object
+rule.findbugs.NP_DEREFERENCE_OF_READLINE_VALUE.name=Dodgy - Dereference of the result of readLine() without nullcheck
+rule.findbugs.UPM_UNCALLED_PRIVATE_METHOD.name=Performance - Private method is never called
+rule.findbugs.NP_NULL_ON_SOME_PATH.name=Correctness - Possible null pointer dereference
+rule.findbugs.NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT.name=Bad practice - equals() method does not check for null argument
+rule.findbugs.EC_NULL_ARG.name=Correctness - Call to equals() with null argument
+rule.findbugs.SE_BAD_FIELD_STORE.name=Bad practice - Non-serializable value stored into instance field of a serializable class
+rule.findbugs.VO_VOLATILE_REFERENCE_TO_ARRAY.name=Multithreaded correctness - A volatile reference to an array doesn't treat the array elements as volatile
+rule.findbugs.NP_SYNC_AND_NULL_CHECK_FIELD.name=Multithreaded correctness - Synchronize and null check on the same field.
+rule.findbugs.DM_EXIT.name=Bad practice - Method invokes System.exit(...)
+rule.findbugs.RC_REF_COMPARISON.name=Bad practice - Suspicious reference comparison
+rule.findbugs.SE_NO_SUITABLE_CONSTRUCTOR.name=Bad practice - Class is Serializable but its superclass doesn't define a void constructor
+rule.findbugs.DC_DOUBLECHECK.name=Multithreaded correctness - Possible double check of field
+rule.findbugs.DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT.name=Correctness - Double.longBitsToDouble invoked on an int
+rule.findbugs.RpC_REPEATED_CONDITIONAL_TEST.name=Correctness - Repeated conditional tests
+rule.findbugs.WMI_WRONG_MAP_ITERATOR.name=Performance - Inefficient use of keySet iterator instead of entrySet iterator
+rule.findbugs.DLS_DEAD_LOCAL_STORE.name=Dodgy - Dead store to local variable
+rule.findbugs.INT_BAD_REM_BY_1.name=Correctness - Integer remainder modulo 1
+rule.findbugs.RV_RETURN_VALUE_IGNORED_BAD_PRACTICE.name=Bad practice - Method ignores exceptional return value
+rule.findbugs.SA_LOCAL_SELF_ASSIGNMENT.name=Dodgy - Self assignment of local variable
+rule.findbugs.MS_SHOULD_BE_FINAL.name=Malicious code vulnerability - Field isn't final but should be
+rule.findbugs.SIC_INNER_SHOULD_BE_STATIC.name=Performance - Should be a static inner class
+rule.findbugs.NP_GUARANTEED_DEREF.name=Correctness - Null value is guaranteed to be dereferenced
+rule.findbugs.SE_READ_RESOLVE_MUST_RETURN_OBJECT.name=Bad practice - The readResolve method must be declared with a return type of Object.
+rule.findbugs.NP_LOAD_OF_KNOWN_NULL_VALUE.name=Dodgy - Load of known null value
+rule.findbugs.BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION.name=Performance - Primitive value is boxed then unboxed to perform primitive coercion
+rule.findbugs.CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE.name=Bad practice - Class defines clone() but doesn't implement Cloneable
+rule.findbugs.CO_ABSTRACT_SELF.name=Bad practice - Abstract class defines covariant compareTo() method
+rule.findbugs.BAC_BAD_APPLET_CONSTRUCTOR.name=Experimental - Bad Applet Constructor relies on uninitialized AppletStub
+rule.findbugs.EQ_GETCLASS_AND_CLASS_CONSTANT.name=Bad practice - equals method fails for subtypes
+rule.findbugs.DB_DUPLICATE_SWITCH_CLAUSES.name=Dodgy - Method uses the same code for two switch clauses
+rule.findbugs.DB_DUPLICATE_BRANCHES.name=Dodgy - Method uses the same code for two branches
+rule.findbugs.UOE_USE_OBJECT_EQUALS.name=Experimental - Calls to equals on a final class that doesn't override Object's equals method
+rule.findbugs.FI_USELESS.name=Bad practice - Finalizer does nothing but call superclass finalizer
+rule.findbugs.NP_ALWAYS_NULL.name=Correctness - Null pointer dereference
+rule.findbugs.DMI_VACUOUS_SELF_COLLECTION_CALL.name=Correctness - Vacuous call to collections
+rule.findbugs.DLS_DEAD_LOCAL_STORE_IN_RETURN.name=Correctness - Useless assignment in return statement
+rule.findbugs.IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD.name=Correctness - JUnit assertion in run method will not be noticed by JUnit
+rule.findbugs.DMI_EMPTY_DB_PASSWORD.name=Security - Empty database password
+rule.findbugs.DM_BOOLEAN_CTOR.name=Performance - Method invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead
+rule.findbugs.BC_IMPOSSIBLE_DOWNCAST.name=Correctness - Impossible downcast
+rule.findbugs.BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS.name=Bad practice - Equals method should not assume anything about the type of its argument
+rule.findbugs.RV_EXCEPTION_NOT_THROWN.name=Correctness - Exception created and dropped rather than thrown
+rule.findbugs.VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG.name=Correctness - Primitive array passed to function expecting a variable number of object arguments
+rule.findbugs.LI_LAZY_INIT_UPDATE_STATIC.name=Multithreaded correctness - Incorrect lazy initialization and update of static field
+rule.findbugs.SA_FIELD_SELF_ASSIGNMENT.name=Correctness - Self assignment of field
+rule.findbugs.EQ_ALWAYS_FALSE.name=Correctness - equals method always returns false
+rule.findbugs.DMI_RANDOM_USED_ONLY_ONCE.name=Bad practice - Random object created and used only once
+rule.findbugs.NM_CLASS_NOT_EXCEPTION.name=Bad practice - Class is not derived from an Exception, even though it is named as such
+rule.findbugs.SA_LOCAL_DOUBLE_ASSIGNMENT.name=Dodgy - Double assignment of local variable
+rule.findbugs.NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS.name=Correctness - Method call passes null for nonnull parameter (ALL_TARGETS_DANGEROUS)
+rule.findbugs.NP_TOSTRING_COULD_RETURN_NULL.name=Bad practice - toString method may return null
+rule.findbugs.BC_BAD_CAST_TO_ABSTRACT_COLLECTION.name=Dodgy - Questionable cast to abstract collection
+rule.findbugs.NM_LCASE_HASHCODE.name=Class defines hashcode(); should it be hashCode()?
+rule.findbugs.RU_INVOKE_RUN.name=Multithreaded correctness - Invokes run on a thread (did you mean to start it instead?)
+rule.findbugs.DMI_INVOKING_TOSTRING_ON_ARRAY.name=Correctness - Invocation of toString on an array
+rule.findbugs.NM_METHOD_NAMING_CONVENTION.name=Method names should start with a lower case letter
+rule.findbugs.RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES.name=Dodgy - Redundant comparison of two null values
+rule.findbugs.SA_LOCAL_SELF_COMPUTATION.name=Correctness - Nonsensical self computation involving a variable (e.g., x & x)
+rule.findbugs.MS_MUTABLE_HASHTABLE.name=Malicious code vulnerability - Field is a mutable Hashtable
+rule.findbugs.RV_DONT_JUST_NULL_CHECK_READLINE.name=Dodgy - Method discards result of readLine after checking if it is nonnull
+rule.findbugs.ES_COMPARING_STRINGS_WITH_EQ.name=Bad practice - Comparison of String objects using == or !=
+rule.findbugs.DL_SYNCHRONIZATION_ON_SHARED_CONSTANT.name=Multithreaded correctness - Synchronization on interned String could lead to deadlock
+rule.findbugs.MF_METHOD_MASKS_FIELD.name=Correctness - Method defines a variable that obscures a field
+rule.findbugs.EQ_SELF_USE_OBJECT.name=Correctness - Covariant equals() method defined, Object.equals(Object) inherited
+rule.findbugs.ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND.name=Correctness - int value cast to float and then passed to Math.round
+rule.findbugs.GC_UNRELATED_TYPES.name=Correctness - No relationship between generic parameter and method argument
+rule.findbugs.BC_IMPOSSIBLE_INSTANCEOF.name=Correctness - instanceof will always return false
+rule.findbugs.SBSC_USE_STRINGBUFFER_CONCATENATION.name=Performance - Method concatenates strings using + in a loop
+rule.findbugs.ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL.name=Correctness - int value cast to double and then passed to Math.ceil
+rule.findbugs.UG_SYNC_SET_UNSYNC_GET.name=Multithreaded correctness - Unsynchronized get method, synchronized set method
+rule.findbugs.RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION.name=Correctness - Invalid syntax for regular expression
+rule.findbugs.SA_FIELD_SELF_COMPUTATION.name=Correctness - Nonsensical self computation involving a field (e.g., x & x)
+rule.findbugs.DMI_SCHEDULED_THREAD_POOL_EXECUTOR_WITH_ZERO_CORE_THREADS.name=Correctness - Creation of ScheduledThreadPoolExecutor with zero core threads
+rule.findbugs.DMI_USELESS_SUBSTRING.name=Dodgy - Invocation of substring(0), which returns the original value
+rule.findbugs.IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD.name=Dodgy - Ambiguous invocation of either an inherited or outer method
+rule.findbugs.OS_OPEN_STREAM.name=Bad practice - Method may fail to close stream
+rule.findbugs.HE_INHERITS_EQUALS_USE_HASHCODE.name=Bad practice - Class inherits equals() and uses Object.hashCode()
+rule.findbugs.SE_NONFINAL_SERIALVERSIONID.name=Bad practice - serialVersionUID isn't final
+rule.findbugs.EQ_SELF_NO_OBJECT.name=Bad practice - Covariant equals() method defined
+rule.findbugs.SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH.name=Dead store due to switch statement fall through
+rule.findbugs.SW_SWING_METHODS_INVOKED_IN_SWING_THREAD.name=Bad practice - Certain swing methods needs to be invoked in Swing thread
+rule.findbugs.VA_FORMAT_STRING_ILLEGAL.name=Correctness - Illegal format string
+rule.findbugs.DM_NUMBER_CTOR.name=Performance - Method invokes inefficient Number constructor; use static valueOf instead
+rule.findbugs.RV_REM_OF_RANDOM_INT.name=Dodgy - Remainder of 32-bit signed random integer
+rule.findbugs.EQ_COMPARING_CLASS_NAMES.name=Correctness - equals method compares class names rather than class objects
+rule.findbugs.ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD.name=Dodgy - Write to static field from instance method
+rule.findbugs.TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED.name=Correctness - Value annotated as never carrying a type qualifier used where value carrying that qualifier is required
+rule.findbugs.NS_NON_SHORT_CIRCUIT.name=Dodgy - Questionable use of non-short-circuit logic
+rule.findbugs.VA_FORMAT_STRING_NO_PREVIOUS_ARGUMENT.name=Correctness - No previous argument for format string
+rule.findbugs.SE_PRIVATE_READ_RESOLVE_NOT_INHERITED.name=Dodgy - private readResolve method not inherited by subclasses
+rule.findbugs.RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE.name=Dodgy - Redundant nullcheck of value known to be non-null
+rule.findbugs.NM_LCASE_TOSTRING.name=Class defines tostring(); should it be toString()?
+rule.findbugs.HSC_HUGE_SHARED_STRING_CONSTANT.name=Performance - Huge string constants is duplicated across multiple class files
+rule.findbugs.SE_TRANSIENT_FIELD_NOT_RESTORED.name=Bad practice - Transient field that isn't set by deserialization.
+rule.findbugs.JLM_JSR166_LOCK_MONITORENTER.name=Multithreaded correctness - Synchronization performed on java.util.concurrent Lock
+rule.findbugs.EQ_ALWAYS_TRUE.name=Correctness - equals method always returns true
+rule.findbugs.ISC_INSTANTIATE_STATIC_CLASS.name=Bad practice - Needless instantiation of class that only supplies static methods
+rule.findbugs.ICAST_IDIV_CAST_TO_DOUBLE.name=Dodgy - int division result cast to double or float
+rule.findbugs.RC_REF_COMPARISON_BAD_PRACTICE.name=Correctness - Suspicious reference comparison to constant
+rule.findbugs.FI_EXPLICIT_INVOCATION.name=Bad practice - Explicit invocation of finalizer
+rule.findbugs.ESync_EMPTY_SYNC.name=Multithreaded correctness - Empty synchronized block
+rule.findbugs.DMI_USING_REMOVEALL_TO_CLEAR_COLLECTION.name=Correctness - Don't use removeAll to clear a collection
+rule.findbugs.SE_BAD_FIELD.name=Non-transient non-serializable instance field in serializable class
+rule.findbugs.NP_STORE_INTO_NONNULL_FIELD.name=Correctness - Store of null value into field annotated NonNull
+rule.findbugs.IT_NO_SUCH_ELEMENT.name=Bad practice - Iterator next() method can't throw NoSuchElementException
+rule.findbugs.HRS_REQUEST_PARAMETER_TO_HTTP_HEADER.name=Security - HTTP Response splitting vulnerability
+rule.findbugs.DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED.name=Dodgy - Thread passed where Runnable expected
+rule.findbugs.NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH.name=Correctness - Value is null and guaranteed to be dereferenced on exception path
+rule.findbugs.RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE.name=Dodgy - Redundant nullcheck of value known to be null
+rule.findbugs.DMI_CALLING_NEXT_FROM_HASNEXT.name=Correctness - hasNext method invokes next
+rule.findbugs.HE_HASHCODE_USE_OBJECT_EQUALS.name=Bad practice - Class defines hashCode() and uses Object.equals()
+rule.findbugs.VA_FORMAT_STRING_EXPECTED_MESSAGE_FORMAT_SUPPLIED.name=Correctness - MessageFormat supplied where printf style format expected
+rule.findbugs.NP_BOOLEAN_RETURN_NULL.name=Bad practice - Method with Boolean return type returns explicit null
+rule.findbugs.RI_REDUNDANT_INTERFACES.name=Dodgy - Class implements same interface as superclass
+rule.findbugs.DL_SYNCHRONIZATION_ON_UNSHARED_BOXED_PRIMITIVE.name=Multithreaded correctness - Synchronization on boxed primitive values
+rule.findbugs.STCAL_STATIC_CALENDAR_INSTANCE.name=Multithreaded correctness - Static Calendar
+rule.findbugs.RR_NOT_CHECKED.name=Bad practice - Method ignores results of InputStream.read()
+rule.findbugs.IL_INFINITE_RECURSIVE_LOOP.name=Correctness - An apparent infinite recursive loop
+rule.findbugs.DMI_NONSERIALIZABLE_OBJECT_WRITTEN.name=Dodgy - Non serializable object written to ObjectOutput
+rule.findbugs.GC_UNCHECKED_TYPE_IN_GENERIC_CALL.name=Bad practice - Unchecked type in generic call
+rule.findbugs.IMA_INEFFICIENT_MEMBER_ACCESS.name=Experimental - Method accesses a private member variable of owning class
+rule.findbugs.FI_PUBLIC_SHOULD_BE_PROTECTED.name=Malicious code vulnerability - Finalizer should be protected, not public
+rule.findbugs.RV_CHECK_FOR_POSITIVE_INDEXOF.name=Dodgy - Method checks to see if result of String.indexOf is positive
+rule.findbugs.ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT.name=Dodgy - Unsigned right shift cast to short/byte
+rule.findbugs.DM_STRING_VOID_CTOR.name=Performance - Method invokes inefficient new String() constructor
+rule.findbugs.RE_POSSIBLE_UNINTENDED_PATTERN.name=Correctness - "." used for regular expression
+rule.findbugs.WL_USING_GETCLASS_RATHER_THAN_CLASS_LITERAL.name=Multithreaded correctness - Sychronization on getClass rather than class literal
+rule.findbugs.ICAST_BAD_SHIFT_AMOUNT.name=Correctness - Integer shift by an amount not in the range 0..31
+rule.findbugs.SF_SWITCH_FALLTHROUGH.name=Switch statement found where one case falls through to the next case
+rule.findbugs.DP_DO_INSIDE_DO_PRIVILEGED.name=Bad practice - Method invoked that should be only be invoked inside a doPrivileged block
+rule.findbugs.NO_NOTIFY_NOT_NOTIFYALL.name=Multithreaded correctness - Using notify() rather than notifyAll()
+rule.findbugs.SS_SHOULD_BE_STATIC.name=Performance - Unread field: should this field be static?
+rule.findbugs.DM_RUN_FINALIZERS_ON_EXIT.name=Bad practice - Method invokes dangerous method runFinalizersOnExit
+rule.findbugs.MS_FINAL_PKGPROTECT.name=Malicious code vulnerability - Field should be both final and package protected
+rule.findbugs.BC_BAD_CAST_TO_CONCRETE_COLLECTION.name=Dodgy - Questionable cast to concrete collection
+rule.findbugs.BIT_IOR_OF_SIGNED_BYTE.name=Correctness - Bitwise OR of signed byte value
+rule.findbugs.MSF_MUTABLE_SERVLET_FIELD.name=Multithreaded correctness - Mutable servlet field
+rule.findbugs.SE_BAD_FIELD_INNER_CLASS.name=Bad practice - Non-serializable class has a serializable inner class
+rule.findbugs.BIT_ADD_OF_SIGNED_BYTE.name=Correctness - Bitwise add of signed byte value
+rule.findbugs.FI_FINALIZER_ONLY_NULLS_FIELDS.name=Bad practice - Finalizer only nulls fields
+rule.findbugs.DE_MIGHT_IGNORE.name=Bad practice - Method might ignore exception
+rule.findbugs.XSS_REQUEST_PARAMETER_TO_SERVLET_WRITER.name=Security - Servlet reflected cross site scripting vulnerability
+rule.findbugs.ML_SYNC_ON_FIELD_TO_GUARD_CHANGING_THAT_FIELD.name=Multithreaded correctness - Synchronization on field in futile attempt to guard that field
+rule.findbugs.SQL_BAD_PREPARED_STATEMENT_ACCESS.name=Correctness - Method attempts to access a prepared statement parameter with index 0
+rule.findbugs.DM_CONVERT_CASE.name=Internationalization - Consider using Locale parameterized version of invoked method
+rule.findbugs.SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS.name=Dodgy - Transient field of class that isn't Serializable.
+rule.findbugs.NN_NAKED_NOTIFY.name=Multithreaded correctness - Naked notify
+rule.findbugs.VA_FORMAT_STRING_MISSING_ARGUMENT.name=Correctness - Format string references missing argument
+rule.findbugs.IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION.name=Bad practice - Superclass uses subclass during initialization
+rule.findbugs.SA_LOCAL_SELF_COMPARISON.name=Correctness - Self comparison of value with itself
+rule.findbugs.IM_BAD_CHECK_FOR_ODD.name=Dodgy - Check for oddness that won't work for negative numbers
+rule.findbugs.NP_CLOSING_NULL.name=Correctness - close() invoked on a value that is always null
+rule.findbugs.XSS_REQUEST_PARAMETER_TO_JSP_WRITER.name=Security - JSP reflected cross site scripting vulnerability
+rule.findbugs.IS_FIELD_NOT_GUARDED.name=Multithreaded correctness - Field not guarded against concurrent access
+rule.findbugs.DM_GC.name=Performance - Explicit garbage collection; extremely dubious except in benchmarking code
+rule.findbugs.IM_MULTIPLYING_RESULT_OF_IREM.name=Correctness - Integer multiply of result of integer remainder
+rule.findbugs.SE_COMPARATOR_SHOULD_BE_SERIALIZABLE.name=Bad practice - Comparator doesn't implement Serializable
+rule.findbugs.HE_HASHCODE_NO_EQUALS.name=Bad practice - Class defines hashCode() but not equals()
+rule.findbugs.MF_CLASS_MASKS_FIELD.name=Correctness - Class defines field that masks a superclass field
+rule.findbugs.NM_VERY_CONFUSING_INTENTIONAL.name=Bad practice - Very confusing method names (but perhaps intentional)
+rule.findbugs.SR_NOT_CHECKED.name=Bad practice - Method ignores results of InputStream.skip()
+rule.findbugs.LI_LAZY_INIT_STATIC.name=Multithreaded correctness - Incorrect lazy initialization of static field
+rule.findbugs.DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION.name=Correctness - Can't use reflection to check for presence of annotation without runtime retention
+rule.findbugs.ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH.name=Bad practice - Method may fail to close database resource on exception
+rule.findbugs.BIT_IOR.name=Correctness - Incompatible bit masks (BIT_IOR)
+rule.findbugs.ODR_OPEN_DATABASE_RESOURCE.name=Bad practice - Method may fail to close database resource
+rule.findbugs.IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN.name=Correctness - A parameter is dead upon entry to a method but overwritten
+rule.findbugs.SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING.name=Security - A prepared statement is generated from a nonconstant String
+rule.findbugs.UUF_UNUSED_FIELD.name=Performance - Unused field
+rule.findbugs.RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE.name=Correctness - Nullcheck of value previously dereferenced
+rule.findbugs.EQ_OTHER_USE_OBJECT.name=Correctness - equals() method defined that doesn't override Object.equals(Object)
+rule.findbugs.SP_SPIN_ON_FIELD.name=Multithreaded correctness - Method spins on field
+rule.findbugs.SI_INSTANCE_BEFORE_FINALS_ASSIGNED.name=Bad practice - Static initializer creates instance before all static final fields assigned
+rule.findbugs.NP_ALWAYS_NULL_EXCEPTION.name=Correctness - Null pointer dereference in method on exception path
+rule.findbugs.MS_EXPOSE_REP.name=Malicious code vulnerability - Public static method may expose internal representation by returning array
+rule.findbugs.VA_FORMAT_STRING_BAD_CONVERSION_TO_BOOLEAN.name=Dodgy - Non-Boolean argument formatted using %b format specifier
+rule.findbugs.MS_PKGPROTECT.name=Malicious code vulnerability - Field should be package protected
+rule.findbugs.NP_NONNULL_RETURN_VIOLATION.name=Correctness - Method may return null, but is declared @NonNull
+rule.findbugs.J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION.name=Bad practice - Store of non serializable object into HttpSession
+rule.findbugs.NM_SAME_SIMPLE_NAME_AS_SUPERCLASS.name=Bad practice - Class names shouldn't shadow simple name of superclass
+rule.findbugs.DMI_BLOCKING_METHODS_ON_URL.name=Performance - The equals and hashCode methods of URL are blocking
+rule.findbugs.HE_SIGNATURE_DECLARES_HASHING_OF_UNHASHABLE_CLASS.name=Correctness - Signature declares use of unhashable class in hashed construct
+rule.findbugs.UR_UNINIT_READ.name=Correctness - Uninitialized read of field in constructor
+rule.findbugs.WA_NOT_IN_LOOP.name=Multithreaded correctness - Wait not in loop
+rule.findbugs.DMI_FUTILE_ATTEMPT_TO_CHANGE_MAXPOOL_SIZE_OF_SCHEDULED_THREAD_POOL_EXECUTOR.name=Correctness - Futile attempt to change max pool size of ScheduledThreadPoolExecutor
+rule.findbugs.RV_RETURN_VALUE_IGNORED2.name=Correctness - Method ignores return value
+rule.findbugs.NM_FIELD_NAMING_CONVENTION.name=Field names should start with a lower case letter
+rule.findbugs.FB_UNEXPECTED_WARNING.name=Experimental - Unexpected/undesired warning from FindBugs
+rule.findbugs.BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR.name=Correctness - Primitive value is unboxed and coerced for ternary operator
+rule.findbugs.DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED.name=Bad practice - Classloaders should only be created inside doPrivileged block
+rule.findbugs.NM_WRONG_PACKAGE.name=Correctness - Method doesn't override method in superclass due to wrong package for parameter
+rule.findbugs.IL_CONTAINER_ADDED_TO_ITSELF.name=Correctness - A collection is added to itself
+rule.findbugs.CI_CONFUSED_INHERITANCE.name=Dodgy - Class is final but declares protected field
+rule.findbugs.HE_USE_OF_UNHASHABLE_CLASS.name=Correctness - Use of class without a hashCode() method in a hashed data structure
+rule.findbugs.IJU_SUITE_NOT_STATIC.name=Correctness - TestCase implements a non-static suite method
+rule.findbugs.RS_READOBJECT_SYNC.name=Multithreaded correctness - Class's readObject() method is synchronized
+rule.findbugs.AM_CREATES_EMPTY_JAR_FILE_ENTRY.name=Bad practice - Creates an empty jar file entry
+rule.findbugs.VA_FORMAT_STRING_BAD_CONVERSION_FROM_ARRAY.name=Correctness - Array formatted in useless way using format string
+rule.findbugs.SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH_TO_THROW.name=Dead store due to switch statement fall through to throw
+rule.findbugs.RV_ABSOLUTE_VALUE_OF_HASHCODE.name=Correctness - Bad attempt to compute absolute value of signed 32-bit hashcode
+rule.findbugs.EQ_DONT_DEFINE_EQUALS_FOR_ENUM.name=Correctness - Covariant equals() method defined for enum
+rule.findbugs.SA_FIELD_DOUBLE_ASSIGNMENT.name=Correctness - Double assignment of field
+rule.findbugs.DMI_COLLECTION_OF_URLS.name=Performance - Maps and sets of URLs can be performance hogs
+rule.findbugs.NM_SAME_SIMPLE_NAME_AS_INTERFACE.name=Bad practice - Class names shouldn't shadow simple name of implemented interface
+rule.findbugs.UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR.name=Correctness - Field not initialized in constructor
+rule.findbugs.TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK.name=Correctness - Value that might carry a type qualifier is always used in a way prohibits it from having that type qualifier
+rule.findbugs.SE_NONLONG_SERIALVERSIONID.name=Bad practice - serialVersionUID isn't long
+rule.findbugs.RV_REM_OF_HASHCODE.name=Dodgy - Remainder of hashCode could be negative
+rule.findbugs.NS_DANGEROUS_NON_SHORT_CIRCUIT.name=Dodgy - Potentially dangerous use of non-short-circuit logic
+rule.findbugs.USM_USELESS_SUBCLASS_METHOD.name=Experimental - Method superfluously delegates to parent class method
+rule.findbugs.ITA_INEFFICIENT_TO_ARRAY.name=Performance - Method uses toArray() with zero-length array argument
+rule.findbugs.DM_MONITOR_WAIT_ON_CONDITION.name=Multithreaded correctness - Monitor wait() called on Condition
+rule.findbugs.BOA_BADLY_OVERRIDDEN_ADAPTER.name=Correctness - Class overrides a method implemented in super class Adapter wrongly
+rule.findbugs.IC_INIT_CIRCULARITY.name=Dodgy - Initialization circularity
+rule.findbugs.NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER.name=Bad practice - Use of identifier that is a keyword in later versions of Java
+rule.findbugs.EC_UNRELATED_CLASS_AND_INTERFACE.name=Correctness - Call to equals() comparing unrelated class and interface
+rule.findbugs.TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK.name=Correctness - Value that might not carry a type qualifier is always used in a way requires that type qualifier
+rule.findbugs.FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER.name=Correctness - Doomed test for equality to NaN
+rule.findbugs.NM_CONFUSING.name=Bad practice - Confusing method names
+rule.findbugs.VA_FORMAT_STRING_ARG_MISMATCH.name=Correctness - Number of format-string arguments does not correspond to number of placeholders
+rule.findbugs.NP_NULL_ON_SOME_PATH_EXCEPTION.name=Correctness - Possible null pointer dereference in method on exception path
+rule.findbugs.DL_SYNCHRONIZATION_ON_BOXED_PRIMITIVE.name=Multithreaded correctness - Synchronization on boxed primitive could lead to deadlock
+rule.findbugs.IJU_TEARDOWN_NO_SUPER.name=Correctness - TestCase defines tearDown that doesn't call super.tearDown()
+rule.findbugs.SE_READ_RESOLVE_IS_STATIC.name=Correctness - The readResolve method must not be declared as a static method.
+rule.findbugs.NP_NULL_ON_SOME_PATH_MIGHT_BE_INFEASIBLE.name=Dodgy - Possible null pointer dereference on path that might be infeasible
+rule.findbugs.UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS.name=Correctness - Uncallable method defined in anonymous class
+rule.findbugs.VA_FORMAT_STRING_BAD_CONVERSION.name=Correctness - The type of a supplied argument doesn't match format specifier
+rule.findbugs.EC_ARRAY_AND_NONARRAY.name=Correctness - equals() used to compare array and nonarray
+rule.findbugs.NM_BAD_EQUAL.name=Class defines equal(Object); should it be equals(Object)?
+rule.findbugs.EC_UNRELATED_TYPES_USING_POINTER_EQUALITY.name=Correctness - Using pointer equality to compare different types
+rule.findbugs.STI_INTERRUPTED_ON_CURRENTTHREAD.name=Correctness - Unneeded use of currentThread() call, to call interrupted()
+rule.findbugs.RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION.name=Correctness - File.separator used for regular expression
+rule.findbugs.MWN_MISMATCHED_WAIT.name=Multithreaded correctness - Mismatched wait()
+rule.findbugs.IL_INFINITE_LOOP.name=Correctness - An apparent infinite loop
+rule.findbugs.NP_IMMEDIATE_DEREFERENCE_OF_READLINE.name=Dodgy - Immediate dereference of the result of readLine()
+rule.findbugs.SC_START_IN_CTOR.name=Multithreaded correctness - Constructor invokes Thread.start()
+rule.findbugs.STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE.name=Multithreaded correctness - Static DateFormat
+rule.findbugs.HE_EQUALS_NO_HASHCODE.name=Bad practice - Class defines equals() but not hashCode()
+rule.findbugs.UL_UNRELEASED_LOCK.name=Multithreaded correctness - Method does not release lock on all paths
+rule.findbugs.PZLA_PREFER_ZERO_LENGTH_ARRAYS.name=Dodgy - Consider returning a zero length array rather than null
+rule.findbugs.SKIPPED_CLASS_TOO_BIG.name=Dodgy - Class too big for analysis
+rule.findbugs.NP_ARGUMENT_MIGHT_BE_NULL.name=Correctness - Method does not check for null argument
+rule.findbugs.UM_UNNECESSARY_MATH.name=Performance - Method calls static Math class method on a constant value
+rule.findbugs.NM_WRONG_PACKAGE_INTENTIONAL.name=Bad practice - Method doesn't override method in superclass due to wrong package for parameter
+rule.findbugs.NP_NONNULL_PARAM_VIOLATION.name=Correctness - Method call passes null to a nonnull parameter
+rule.findbugs.BIT_AND_ZZ.name=Correctness - Check to see if ((...) & 0) == 0
+rule.findbugs.HRS_REQUEST_PARAMETER_TO_COOKIE.name=Security - HTTP cookie formed from untrusted input
+rule.findbugs.SQL_BAD_RESULTSET_ACCESS.name=Correctness - Method attempts to access a result set field with index 0
+rule.findbugs.INT_VACUOUS_COMPARISON.name=Dodgy - Vacuous comparison of integer value
+rule.findbugs.EQ_COMPARETO_USE_OBJECT_EQUALS.name=Bad practice - Class defines compareTo(...) and uses Object.equals()
+rule.findbugs.DMI_HARDCODED_ABSOLUTE_FILENAME.name=Dodgy - Code contains a hard coded reference to an absolute pathname
+rule.findbugs.DMI_COLLECTIONS_SHOULD_NOT_CONTAIN_THEMSELVES.name=Correctness - Collections should not contain themselves
+rule.findbugs.URF_UNREAD_FIELD.name=Performance - Unread field
+rule.findbugs.DLS_OVERWRITTEN_INCREMENT.name=Correctness - Overwritten increment
+rule.findbugs.BIT_SIGNED_CHECK.name=Bad practice - Check for sign of bitwise operation
+rule.findbugs.UWF_NULL_FIELD.name=Correctness - Field only ever set to null
+rule.findbugs.DE_MIGHT_DROP.name=Bad practice - Method might drop exception
+rule.findbugs.DMI_BAD_MONTH.name=Correctness - Bad constant value for month
+rule.findbugs.MS_MUTABLE_ARRAY.name=Malicious code vulnerability - Field is a mutable array
+rule.findbugs.SE_INNER_CLASS.name=Bad practice - Serializable inner class
+rule.findbugs.OS_OPEN_STREAM_EXCEPTION_PATH.name=Bad practice - Method may fail to close stream on exception
+rule.findbugs.AT_OPERATION_SEQUENCE_ON_CONCURRENT_ABSTRACTION.name=Sequence of calls to concurrent abstraction may not be atomic
+rule.findbugs.BX_UNBOXING_IMMEDIATELY_REBOXED.name=Boxed value is unboxed and then immediately reboxed
+rule.findbugs.CO_COMPARETO_RESULTS_MIN_VALUE.name=compareTo()/compare() returns Integer.MIN_VALUE
+rule.findbugs.DLS_DEAD_LOCAL_STORE_SHADOWS_FIELD.name=Dead store to local variable that shadows field
+rule.findbugs.DMI_ARGUMENTS_WRONG_ORDER.name=Reversed method arguments
+rule.findbugs.DMI_BIGDECIMAL_CONSTRUCTED_FROM_DOUBLE.name=BigDecimal constructed from double that isn't represented precisely
+rule.findbugs.DMI_DOH.name=D'oh! A nonsensical method invocation
+rule.findbugs.DMI_ENTRY_SETS_MAY_REUSE_ENTRY_OBJECTS.name=Adding elements of an entry set may fail due to reuse of Entry objects
+rule.findbugs.DM_DEFAULT_ENCODING.name=Reliance on default encoding
+rule.findbugs.ICAST_INT_2_LONG_AS_INSTANT.name=int value converted to long and used as absolute time
+rule.findbugs.INT_BAD_COMPARISON_WITH_INT_VALUE.name=Bad comparison of int value with long constant
+rule.findbugs.JML_JSR166_CALLING_WAIT_RATHER_THAN_AWAIT.name=Using monitor style wait methods on util.concurrent abstraction
+rule.findbugs.NP_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD.name=Read of unwritten public or protected field
+rule.findbugs.OBL_UNSATISFIED_OBLIGATION_EXCEPTION_EDGE.name=Method may fail to clean up stream or resource on checked exception
+rule.findbugs.PZ_DONT_REUSE_ENTRY_OBJECTS_IN_ITERATORS.name=Don't reuse entry objects in iterators
+rule.findbugs.RV_CHECK_COMPARETO_FOR_SPECIFIC_RETURN_VALUE.name=Code checks for specific values returned by compareTo
+rule.findbugs.RV_NEGATING_RESULT_OF_COMPARETO.name=Negating the result of compareTo()/compare()
+rule.findbugs.RV_RETURN_VALUE_IGNORED_INFERRED.name=Method ignores return value, is this OK?
+rule.findbugs.SA_LOCAL_SELF_ASSIGNMENT_INSTEAD_OF_FIELD.name=Self assignment of local rather than assignment to field
+rule.findbugs.URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD.name=Unread public/protected field
+rule.findbugs.UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD.name=Unused public or protected field
+rule.findbugs.UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD.name=Unwritten public or protected field
+rule.findbugs.VA_FORMAT_STRING_USES_NEWLINE.name=Format string should use %n rather than \\n
+rule.findbugs.VO_VOLATILE_INCREMENT.name=An increment to a volatile field isn't atomic
+rule.findbugs.PT_ABSOLUTE_PATH_TRAVERSAL.name=Absolute path traversal in servlet
+rule.findbugs.PT_RELATIVE_PATH_TRAVERSAL.name=Relative path traversal in servlet
+rule.findbugs.NP_NONNULL_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR.name=Nonnull field is not initialized
+rule.findbugs.MS_SHOULD_BE_REFACTORED_TO_BE_FINAL.name=Field isn't final but should be refactored to be so
+rule.findbugs.BC_UNCONFIRMED_CAST_OF_RETURN_VALUE.name=Unchecked/unconfirmed cast of return value from method
+rule.findbugs.TQ_COMPARING_VALUES_WITH_INCOMPATIBLE_TYPE_QUALIFIERS.name=Comparing values with incompatible type qualifiers
--- /dev/null
+<p>The code calls <code>putNextEntry()</code>, immediately
+followed by a call to <code>closeEntry()</code>. This results
+in an empty JarFile entry. The contents of the entry
+should be written to the JarFile between the calls to
+<code>putNextEntry()</code> and
+<code>closeEntry()</code>.</p>
\ No newline at end of file
--- /dev/null
+<p>The code calls <code>putNextEntry()</code>, immediately
+followed by a call to <code>closeEntry()</code>. This results
+in an empty ZipFile entry. The contents of the entry
+should be written to the ZipFile between the calls to
+<code>putNextEntry()</code> and
+<code>closeEntry()</code>.</p>
\ No newline at end of file
--- /dev/null
+<p>This code contains a sequence of calls to a concurrent abstraction (such as a concurrent hash map). These calls will not be executed atomically.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This constructor calls methods in the parent Applet that rely on the AppletStub. Since the AppletStub
+ isn't initialized until the init() method of this applet is called, these methods will not perform
+ correctly.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+This code casts a Collection to an abstract collection
+(such as <code>List</code>, <code>Set</code>, or <code>Map</code>).
+Ensure that you are guaranteed that the object is of the type
+you are casting to. If all you need is to be able
+to iterate through a collection, you don't need to cast it to a Set or List.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code casts an abstract collection (such as a Collection, List, or Set)
+to a specific concrete implementation (such as an ArrayList or HashSet).
+This might not be correct, and it may make your code fragile, since
+it makes it harder to switch to other concrete implementations at a future
+point. Unless you have a particular reason to do so, just use the abstract
+collection class.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The <code>equals(Object o)</code> method shouldn't make any assumptions
+about the type of <code>o</code>. It should simply return
+false if <code>o</code> is not the same type as <code>this</code>.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This cast will always throw a ClassCastException.
+</p>
\ No newline at end of file
--- /dev/null
+This cast will always throw a ClassCastException. The analysis believes it knows the precise type of the value being cast, and the attempt to downcast it to a subtype will always fail by throwing a ClassCastException.
\ No newline at end of file
--- /dev/null
+<p>This code is casting the result of calling toArray() on a collection to a type more specific than Object[], as in:</p>
+<pre>
+ String[] getAsArray(Collection<String> c) {
+ return (String[]) c.toArray();
+ }
+</pre>
+<p>This will usually fail by throwing a ClassCastException. The <code>toArray()</code> of almost all collections return an <code>Object[]</code>. They can't really do anything else, since the Collection object has no reference to the declared generic type of the collection.</p>
+<p>The correct way to do get an array of a specific type from a collection is to use <code>c.toArray(new String[]);</code> or <code>c.toArray(new String[c.size()]);</code> (the latter is slightly more efficient).</p>
+<p>There is one common/known exception exception to this. The toArray() method of lists returned by Arrays.asList(...) will return a covariantly typed array. For example, <code>Arrays.asArray(new String[] { "a" }).toArray()</code> will return a String []. FindBugs attempts to detect and suppress such cases, but may miss some.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This instanceof test will always return false. Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This cast is unchecked, and not all instances of the type casted from can be cast to
+the type it is being cast to. Ensure that your program logic ensures that this
+cast will not fail.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code performs an unchecked cast of the return value of a method.
+The code might be calling the method in such a way that the cast is guaranteed to be
+safe, but FindBugs is unable to verify that the cast is safe. Check that your program logic ensures that this
+cast will not fail.
+</p>
--- /dev/null
+<p>
+This instanceof test will always return true (unless the value being tested is null).
+Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+If you really want to test the value for being null, perhaps it would be clearer to do
+better to do a null test rather than an instanceof test.
+</p>
\ No newline at end of file
--- /dev/null
+<p> Adds a byte value and a value which is known to the 8 lower bits clear.
+Values loaded from a byte array are sign extended to 32 bits
+before any any bitwise operations are performed on the value.
+Thus, if <code>b[0]</code> contains the value <code>0xff</code>, and
+<code>x</code> is initially 0, then the code
+<code>((x << 8) + b[0])</code> will sign extend <code>0xff</code>
+to get <code>0xffffffff</code>, and thus give the value
+<code>0xffffffff</code> as the result.
+</p>
+
+<p>In particular, the following code for packing a byte array into an int is badly wrong: </p>
+<pre>
+int result = 0;
+for(int i = 0; i < 4; i++)
+ result = ((result << 8) + b[i]);
+</pre>
+
+<p>The following idiom will work instead: </p>
+<pre>
+int result = 0;
+for(int i = 0; i < 4; i++)
+ result = ((result << 8) + (b[i] & 0xff));
+</pre>
\ No newline at end of file
--- /dev/null
+<p> This method compares an expression of the form (e & C) to D,
+which will always compare unequal
+due to the specific values of constants C and D.
+This may indicate a logic error or typo.</p>
\ No newline at end of file
--- /dev/null
+<p> This method compares an expression of the form (e & 0) to 0,
+which will always compare equal.
+This may indicate a logic error or typo.</p>
\ No newline at end of file
--- /dev/null
+<p> This method compares an expression of the form (e | C) to D.
+which will always compare unequal
+due to the specific values of constants C and D.
+This may indicate a logic error or typo.</p>
+
+<p> Typically, this bug occurs because the code wants to perform
+a membership test in a bit set, but uses the bitwise OR
+operator ("|") instead of bitwise AND ("&").</p>
\ No newline at end of file
--- /dev/null
+<p> Loads a value from a byte array and performs a bitwise OR with
+that value. Values loaded from a byte array are sign extended to 32 bits
+before any any bitwise operations are performed on the value.
+Thus, if <code>b[0]</code> contains the value <code>0xff</code>, and
+<code>x</code> is initially 0, then the code
+<code>((x << 8) | b[0])</code> will sign extend <code>0xff</code>
+to get <code>0xffffffff</code>, and thus give the value
+<code>0xffffffff</code> as the result.
+</p>
+
+<p>In particular, the following code for packing a byte array into an int is badly wrong: </p>
+<pre>
+int result = 0;
+for(int i = 0; i < 4; i++)
+ result = ((result << 8) | b[i]);
+</pre>
+
+<p>The following idiom will work instead: </p>
+<pre>
+int result = 0;
+for(int i = 0; i < 4; i++)
+ result = ((result << 8) | (b[i] & 0xff));
+</pre>
\ No newline at end of file
--- /dev/null
+<p> This method compares an expression such as
+<pre>((event.detail & SWT.SELECTED) > 0)</pre>.
+Using bit arithmetic and then comparing with the greater than operator can
+lead to unexpected results (of course depending on the value of
+SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate
+for a bug. Even when SWT.SELECTED is not negative, it seems good practice
+to use '!= 0' instead of '> 0'.
+</p>
+<p>
+<em>Boris Bokowski</em>
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method compares an expression such as
+<pre>((event.detail & SWT.SELECTED) > 0)</pre>.
+Using bit arithmetic and then comparing with the greater than operator can
+lead to unexpected results (of course depending on the value of
+SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate
+for a bug. Even when SWT.SELECTED is not negative, it seems good practice
+to use '!= 0' instead of '> 0'.
+</p>
+<p>
+<em>Boris Bokowski</em>
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method overrides a method found in a parent class, where that class is an Adapter that implements
+a listener defined in the java.awt.event or javax.swing.event package. As a result, this method will not
+get called when the event occurs.</p>
\ No newline at end of file
--- /dev/null
+<p>A primitive is boxed, and then immediately unboxed. This probably is due to a manual
+ boxing in a place where an unboxed value is required, thus forcing the compiler
+to immediately undo the work of the boxing.
+</p>
\ No newline at end of file
--- /dev/null
+<p>A primitive boxed value constructed and then immediately converted into a different primitive type
+(e.g., <code>new Double(d).intValue()</code>). Just perform direct primitive coercion (e.g., <code>(int) d</code>).</p>
\ No newline at end of file
--- /dev/null
+<p>A wrapped primitive value is unboxed and converted to another primitive type as part of the
+evaluation of a conditional ternary operator (the <code> b ? e1 : e2</code> operator). The
+semantics of Java mandate that if <code>e1</code> and <code>e2</code> are wrapped
+numeric values, the values are unboxed and converted/coerced to their common type (e.g,
+if <code>e1</code> is of type <code>Integer</code>
+and <code>e2</code> is of type <code>Float</code>, then <code>e1</code> is unboxed,
+converted to a floating point value, and boxed. See JLS Section 15.25.
+</p>
\ No newline at end of file
--- /dev/null
+<p>A boxed value is unboxed and then immediately reboxed.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This class has a circular dependency with other classes. This makes building these classes
+ difficult, as each is dependent on the other to build correctly. Consider using interfaces
+ to break the hard dependency.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This class is declared to be final, but declares fields to be protected. Since the class
+ is final, it can not be derived from, and the use of protected is confusing. The access
+ modifier for the field should be changed to private or public to represent the true
+ use for the field.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ Class implements Cloneable but does not define or
+ use the clone method.</p>
\ No newline at end of file
--- /dev/null
+<p> This non-final class defines a clone() method that does not call super.clone().
+If this class ("<i>A</i>") is extended by a subclass ("<i>B</i>"),
+and the subclass <i>B</i> calls super.clone(), then it is likely that
+<i>B</i>'s clone() method will return an object of type <i>A</i>,
+which violates the standard contract for clone().</p>
+
+<p> If all clone() methods call super.clone(), then they are guaranteed
+to use Object.clone(), which always returns an object of the correct type.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a clone() method but the class doesn't implement Cloneable.
+There are some situations in which this is OK (e.g., you want to control how subclasses
+can clone themselves), but just make sure that this is what you intended.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a covariant version of <code>compareTo()</code>.
+ To correctly override the <code>compareTo()</code> method in the
+ <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
+ must have type <code>java.lang.Object</code>.</p>
\ No newline at end of file
--- /dev/null
+<p>In some situation, this compareTo or compare method returns the constant Integer.MIN_VALUE,
+which is an exceptionally bad practice. The only thing that matters about the return value of
+compareTo is the sign of the result. But people will sometimes negate the return value of compareTo,
+expecting that this will negate the sign of the result. And it will, except in the case where
+the value returned is Integer.MIN_VALUE. So just return -1 rather than Integer.MIN_VALUE.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a covariant version of <code>compareTo()</code>.
+ To correctly override the <code>compareTo()</code> method in the
+ <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
+ must have type <code>java.lang.Object</code>.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method uses the same code to implement two branches of a conditional branch.
+ Check to ensure that this isn't a coding mistake.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method uses the same code to implement two clauses of a switch statement.
+ This could be a case of duplicate code, but it might also indicate
+ a coding mistake.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This method may contain an instance of double-checked locking.
+ This idiom is not correct according to the semantics of the Java memory
+ model. For more information, see the web page
+ <a href="http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html"
+ >http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html</a>.</p>
\ No newline at end of file
--- /dev/null
+<p> This method might drop an exception. In general, exceptions
+ should be handled or reported in some way, or they should be thrown
+ out of the method.</p>
\ No newline at end of file
--- /dev/null
+<p> This method might ignore an exception. In general, exceptions
+ should be handled or reported in some way, or they should be thrown
+ out of the method.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This instruction assigns a value to a local variable,
+but the value is not read or used in any subsequent instruction.
+Often, this indicates an error, because the value computed is never
+used.
+</p>
+<p>
+Note that Sun's javac compiler often generates dead stores for
+final local variables. Because FindBugs is a bytecode-based tool,
+there is no easy way to eliminate these false positives.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This statement assigns to a local variable in a return statement. This assignment
+has effect. Please verify that this statement does the right thing.
+</p>
\ No newline at end of file
--- /dev/null
+<p>The code stores null into a local variable, and the stored value is not
+read. This store may have been introduced to assist the garbage collector, but
+as of Java SE 6.0, this is no longer needed or useful.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This instruction assigns a value to a local variable, but the value is not read or used in
+any subsequent instruction. Often, this indicates an error, because the value computed is never
+used. There is a field with the same name as the local variable. Did you mean to assign to that
+variable instead?</p>
\ No newline at end of file
--- /dev/null
+<p>
+This instruction assigns a class literal to a variable and then never uses it.
+<a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">The behavior of this differs in Java 1.4 and in Java 5.</a>
+In Java 1.4 and earlier, a reference to <code>Foo.class</code> would force the static initializer
+for <code>Foo</code> to be executed, if it has not been executed already.
+In Java 5 and later, it does not.
+</p>
+<p>See Sun's <a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">article on Java SE compatibility</a>
+for more details and examples, and suggestions on how to force class initialization in Java 5.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code performs an increment operation (e.g., <code>i++</code>) and then
+immediately overwrites it. For example, <code>i = i++</code> immediately
+overwrites the incremented value with the original value.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The code synchronizes on a boxed primitive constant, such as an Boolean.
+<pre>
+private static Boolean inited = Boolean.FALSE;
+...
+ synchronized(inited) {
+ if (!inited) {
+ init();
+ inited = Boolean.TRUE;
+ }
+ }
+...
+</pre>
+</p>
+<p>Since there normally exist only two Boolean objects, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness
+and possible deadlock</p>
\ No newline at end of file
--- /dev/null
+<p> The code synchronizes on a boxed primitive constant, such as an Integer.
+<pre>
+private static Integer count = 0;
+...
+ synchronized(count) {
+ count++;
+ }
+...
+</pre>
+</p>
+<p>Since Integer objects can be cached and shared,
+this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness
+and possible deadlock</p>
\ No newline at end of file
--- /dev/null
+<p> The code synchronizes on interned String.
+<pre>
+private static String LOCK = "LOCK";
+...
+ synchronized(LOCK) { ...}
+...
+</pre>
+</p>
+<p>Constant Strings are interned and shared across all other classes loaded by the JVM. Thus, this could
+is locking on something that other code might also be locking. This could result in very strange and hard to diagnose
+blocking and deadlock behavior. See <a href="http://www.javalobby.org/java/forums/t96352.html">http://www.javalobby.org/java/forums/t96352.html</a> and <a href="http://jira.codehaus.org/browse/JETTY-352">http://jira.codehaus.org/browse/JETTY-352</a>.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The code synchronizes on an apparently unshared boxed primitive,
+such as an Integer.
+<pre>
+private static final Integer fileLock = new Integer(1);
+...
+ synchronized(fileLock) {
+ .. do something ..
+ }
+...
+</pre>
+</p>
+<p>It would be much better, in this code, to redeclare fileLock as
+<pre>
+private static final Object fileLock = new Object();
+</pre>
+The existing code might be OK, but it is confusing and a
+future refactoring, such as the "Remove Boxing" refactoring in IntelliJ,
+might replace this with the use of an interned Integer object shared
+throughout the JVM, leading to very confusing behavior and potential deadlock.
+</p>
\ No newline at end of file
--- /dev/null
+<p> Unless an annotation has itself been annotated with @Retention(RetentionPolicy.RUNTIME), the annotation can't be observed using reflection
+(e.g., by using the isAnnotationPresent method).
+ .</p>
\ No newline at end of file
--- /dev/null
+<p>The arguments to this method call seem to be in the wrong order. For example, a call
+<code>Preconditions.checkNotNull("message", message)</code> has reserved arguments: the value
+to be checked is the first argument.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code passes a constant month
+value outside the expected range of 0..11 to a method.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code creates a BigDecimal from a double value that doesn't translate well to a decimal number. For example,
+one might assume that writing <code>new BigDecimal(0.1)</code> in Java creates a BigDecimal which is exactly equal to 0.1
+(an unscaled value of 1, with a scale of 1), but it is actually equal to 0.1000000000000000055511151231257827021181583404541015625.
+You probably want to use the <code>BigDecimal.valueOf(double d)</code> method, which uses the String representation of the double to
+create the BigDecimal (e.g., <code>BigDecimal.valueOf(0.1)</code> gives 0.1).</p>
\ No newline at end of file
--- /dev/null
+<p> The equals and hashCode
+method of URL perform domain name resolution, this can result in a big performance hit.
+See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information.
+Consider using <code>java.net.URI</code> instead.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+The hasNext() method invokes the next() method. This is almost certainly wrong,
+since the hasNext() method is not supposed to change the state of the iterator,
+and the next method is supposed to change the state of the iterator.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This call to a generic collection's method would only make sense if a collection contained
+itself (e.g., if <code>s.contains(s)</code> were true). This is unlikely to be true and would cause
+problems if it were true (such as the computation of the hash code resulting in infinite recursion).
+It is likely that the wrong value is being passed as a parameter.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This method or field is or uses a Map or Set of URLs. Since both the equals and hashCode
+method of URL perform domain name resolution, this can result in a big performance hit.
+See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information.
+Consider using <code>java.net.URI</code> instead.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>This code creates a database connect using a hardcoded, constant password. Anyone with access to either the source code or the compiled code can
+ easily learn the password.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This partical method invocation doesn't make sense, for reasons that should be apparent from inspection.</p>
\ No newline at end of file
--- /dev/null
+<p>This code creates a database connect using a blank or empty password. This indicates that the database is not protected by a password.
+</p>
\ No newline at end of file
--- /dev/null
+<p>The entrySet() method is allowed to return a view of the underlying Map in which a single Entry
+ object is reused and returned during the iteration. As of Java 1.6, both IdentityHashMap and EnumMap
+ did so. When iterating through such a Map, the Entry value is only valid until you advance to the
+ next iteration. If, for example, you try to pass such an entrySet to an addAll method, things will
+ go badly wrong.</p>
\ No newline at end of file
--- /dev/null
+<p>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html">Javadoc</a>)
+While ScheduledThreadPoolExecutor inherits from ThreadPoolExecutor, a few of the inherited tuning methods are not useful for it. In particular, because it acts as a fixed-sized pool using corePoolSize threads and an unbounded queue, adjustments to maximumPoolSize have no useful effect.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>This code constructs a File object using a hard coded to an absolute pathname
+(e.g., <code>new File("/home/dannyc/workspace/j2ee/src/share/com/sun/enterprise/deployment");</code>
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code invokes hashCode on an array. Calling hashCode on
+an array returns the same value as System.identityHashCode, and ingores
+the contents and length of the array. If you need a hashCode that
+depends on the contents of an array <code>a</code>,
+use <code>java.util.Arrays.hashCode(a)</code>.
+
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code invokes toString on an (anonymous) array. Calling toString on an array generates a fairly useless result
+such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable
+String that gives the contents of the array. See Programming Puzzlers, chapter 3, puzzle 12.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code invokes toString on an array, which will generate a fairly useless result
+such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable
+String that gives the contents of the array. See Programming Puzzlers, chapter 3, puzzle 12.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The Double.longBitsToDouble method is invoked, but a 32 bit int value is passed
+ as an argument. This almostly certainly is not intended and is unlikely
+ to give the intended result.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code seems to be passing a non-serializable object to the ObjectOutput.writeObject method.
+If the object is, indeed, non-serializable, an error will result.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This code creates a java.util.Random object, uses it to generate one random number, and then discards
+the Random object. This produces mediocre quality random numbers and is inefficient.
+If possible, rewrite the code so that the Random object is created once and saved, and each time a new random number
+is required invoke a method on the existing Random object to obtain it.
+</p>
+
+<p>If it is important that the generated Random numbers not be guessable, you <em>must</em> not create a new Random for each random
+number; the values are too easily guessable. You should strongly consider using a java.security.SecureRandom instead
+(and avoid allocating a new SecureRandom for each random number needed).
+</p>
\ No newline at end of file
--- /dev/null
+<p>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html#ScheduledThreadPoolExecutor(int)">Javadoc</a>)
+A ScheduledThreadPoolExecutor with zero core threads will never execute anything; changes to the max pool size are ignored.
+</p>
\ No newline at end of file
--- /dev/null
+<p> A Thread object is passed as a parameter to a method where
+a Runnable is expected. This is rather unusual, and may indicate a logic error
+or cause unexpected behavior.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>All targets of this method invocation throw an UnsupportedOperationException.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code invokes substring(0) on a String, which returns the original value.
+</p>
\ No newline at end of file
--- /dev/null
+<p> If you want to remove all elements from a collection <code>c</code>, use <code>c.clear</code>,
+not <code>c.removeAll(c)</code>.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This call doesn't make sense. For any collection <code>c</code>, calling <code>c.containsAll(c)</code> should
+always be true, and <code>c.retainAll(c)</code> should have no effect.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> Creating new instances of <code>java.lang.Boolean</code> wastes
+ memory, since <code>Boolean</code> objects are immutable and there are
+ only two useful values of this type. Use the <code>Boolean.valueOf()</code>
+ method (or Java 1.5 autoboxing) to create <code>Boolean</code> objects instead.</p>
\ No newline at end of file
--- /dev/null
+<p>A boxed primitive is allocated just to call toString(). It is more effective to just use the static
+ form of toString which takes the primitive value. So,</p>
+ <table>
+ <tr><th>Replace...</th><th>With this...</th></tr>
+ <tr><td>new Integer(1).toString()</td><td>Integer.toString(1)</td></tr>
+ <tr><td>new Long(1).toString()</td><td>Long.toString(1)</td></tr>
+ <tr><td>new Float(1.0).toString()</td><td>Float.toString(1.0)</td></tr>
+ <tr><td>new Double(1.0).toString()</td><td>Double.toString(1.0)</td></tr>
+ <tr><td>new Byte(1).toString()</td><td>Byte.toString(1)</td></tr>
+ <tr><td>new Short(1).toString()</td><td>Short.toString(1)</td></tr>
+ <tr><td>new Boolean(true).toString()</td><td>Boolean.toString(true)</td></tr>
+ </table>
\ No newline at end of file
--- /dev/null
+<p> A String is being converted to upper or lowercase, using the platform's default encoding. This may
+ result in improper conversions when used with international characters. Use the </p>
+ <table><tr><td>String.toUpperCase( Locale l )</td></tr><tr><td>String.toLowerCase( Locale l )</td></tr></table>
+ <p>versions instead.</p>
\ No newline at end of file
--- /dev/null
+<p>Found a call to a method which will perform a byte to String (or String to byte) conversion,
+and will assume that the default platform encoding is suitable. This will cause the application
+behaviour to vary between platforms. Use an alternative API and specify a charset name or
+Charset object explicitly.</p>
\ No newline at end of file
--- /dev/null
+<p> Invoking System.exit shuts down the entire Java virtual machine. This
+ should only been done when it is appropriate. Such calls make it
+ hard or impossible for your code to be invoked by other code.
+ Consider throwing a RuntimeException instead.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ Using <code>new Double(double)</code> is guaranteed to always result in a new object whereas
+ <code>Double.valueOf(double)</code> allows caching of values to be done by the compiler, class library, or JVM.
+ Using of cached values avoids object allocation and the code will be faster.
+ </p>
+ <p>
+ Unless the class must be compatible with JVMs predating Java 1.5,
+ use either autoboxing or the <code>valueOf()</code> method when creating instances of <code>Double</code> and <code>Float</code>.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> Code explicitly invokes garbage collection.
+ Except for specific use in benchmarking, this is very dubious.</p>
+ <p>In the past, situations where people have explicitly invoked
+ the garbage collector in routines such as close or finalize methods
+ has led to huge performance black holes. Garbage collection
+ can be expensive. Any situation that forces hundreds or thousands
+ of garbage collections will bring the machine to a crawl.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method calls <code>wait()</code> on a
+ <code>java.util.concurrent.locks.Condition</code> object.
+ Waiting for a <code>Condition</code> should be done using one of the <code>await()</code>
+ methods defined by the <code>Condition</code> interface.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>This method allocates an object just to call getClass() on it, in order to
+ retrieve the Class object for it. It is simpler to just access the .class property of the class.</p>
\ No newline at end of file
--- /dev/null
+<p>If <code>r</code> is a <code>java.util.Random</code>, you can generate a random number from <code>0</code> to <code>n-1</code>
+using <code>r.nextInt(n)</code>, rather than using <code>(int)(r.nextDouble() * n)</code>.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ Using <code>new Integer(int)</code> is guaranteed to always result in a new object whereas
+ <code>Integer.valueOf(int)</code> allows caching of values to be done by the compiler, class library, or JVM.
+ Using of cached values avoids object allocation and the code will be faster.
+ </p>
+ <p>
+ Values between -128 and 127 are guaranteed to have corresponding cached instances
+ and using <code>valueOf</code> is approximately 3.5 times faster than using constructor.
+ For values outside the constant range the performance of both styles is the same.
+ </p>
+ <p>
+ Unless the class must be compatible with JVMs predating Java 1.5,
+ use either autoboxing or the <code>valueOf()</code> method when creating instances of
+ <code>Long</code>, <code>Integer</code>, <code>Short</code>, <code>Character</code>, and <code>Byte</code>.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> <em>Never call System.runFinalizersOnExit
+or Runtime.runFinalizersOnExit for any reason: they are among the most
+dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>
\ No newline at end of file
--- /dev/null
+<p> Using the <code>java.lang.String(String)</code> constructor wastes memory
+ because the object so constructed will be functionally indistinguishable
+ from the <code>String</code> passed as a parameter. Just use the
+ argument <code>String</code> directly.</p>
\ No newline at end of file
--- /dev/null
+<p> Calling <code>String.toString()</code> is just a redundant operation.
+ Just use the String.</p>
\ No newline at end of file
--- /dev/null
+<p> Creating a new <code>java.lang.String</code> object using the
+ no-argument constructor wastes memory because the object so created will
+ be functionally indistinguishable from the empty string constant
+ <code>""</code>. Java guarantees that identical string constants
+ will be represented by the same <code>String</code> object. Therefore,
+ you should just use the empty string constant directly.</p>
\ No newline at end of file
--- /dev/null
+<p>This method creates a thread without specifying a run method either by deriving from the Thread class, or
+ by passing a Runnable object. This thread, then, does nothing but waste time.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This code creates a classloader, which requires a security manager.
+ If this code will be granted security permissions, but might be invoked by code that does not
+ have security permissions, then the classloader creation needs to occur inside a doPrivileged block.</p>
\ No newline at end of file
--- /dev/null
+<p> This code invokes a method that requires a security permission check.
+ If this code will be granted security permissions, but might be invoked by code that does not
+ have security permissions, then the invocation needs to occur inside a doPrivileged block.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This method invokes the .equals(Object o) to compare an array and a reference that doesn't seem
+to be an array. If things being compared are of different types, they are guaranteed to be unequal
+and the comparison is almost certainly an error. Even if they are both arrays, the equals method
+on arrays only determines of the two arrays are the same object.
+To compare the
+contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This method invokes the .equals(Object o) method on an array. Since arrays do not override the equals
+method of Object, calling equals on an array is the same as comparing their addresses. To compare the
+contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
+</p>
\ No newline at end of file
--- /dev/null
+This method invokes the .equals(Object o) to compare two arrays, but the arrays of of incompatible types (e.g., String[] and StringBuffer[], or String[] and int[]). They will never be equal. In addition, when equals(...) is used to compare arrays it only checks to see if they are the same array, and ignores the contents of the arrays.
\ No newline at end of file
--- /dev/null
+<p> This method calls equals(Object), passing a null value as
+the argument. According to the contract of the equals() method,
+this call should always return <code>false</code>.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This method calls equals(Object) on two references, one of which is a class
+and the other an interface, where neither the class nor any of its
+non-abstract subclasses implement the interface.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method calls equals(Object) on two references of unrelated
+interface types, where neither is a subtype of the other,
+and there are no known non-abstract classes which implement both interfaces.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method calls equals(Object) on two references of different
+class types with no common subclasses.
+Therefore, the objects being compared
+are unlikely to be members of the same class at runtime
+(unless some application classes were not analyzed, or dynamic class
+loading can occur at runtime).
+According to the contract of equals(),
+objects of different
+classes should always compare as unequal; therefore, according to the
+contract defined by java.lang.Object.equals(Object),
+the result of this comparison will always be false at runtime.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method uses using pointer equality to compare two references that seem to be of
+different types. The result of this comparison will always be false at runtime.
+</p>
\ No newline at end of file
--- /dev/null
+<p> Returning a reference to a mutable object value stored in one of the object's fields
+ exposes the internal representation of the object.
+ If instances
+ are accessed by untrusted code, and unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Returning a new copy of the object is better approach in many situations.</p>
\ No newline at end of file
--- /dev/null
+<p> This code stores a reference to an externally mutable object into the
+ internal representation of the object.
+ If instances
+ are accessed by untrusted code, and unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Storing a copy of the object is better approach in many situations.</p>
\ No newline at end of file
--- /dev/null
+<p> This code stores a reference to an externally mutable object into a static
+ field.
+ If unchecked changes to
+ the mutable object would compromise security or other
+ important properties, you will need to do something different.
+ Storing a copy of the object is better approach in many situations.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a covariant version of <code>equals()</code>.
+ To correctly override the <code>equals()</code> method in
+ <code>java.lang.Object</code>, the parameter of <code>equals()</code>
+ must have type <code>java.lang.Object</code>.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines an equals method that always returns false. This means that an object is not equal to itself, and it is impossible to create useful Maps or Sets of this class. More fundamentally, it means
+that equals is not reflexive, one of the requirements of the equals method.</p>
+<p>The likely intended semantics are object identity: that an object is equal to itself. This is the behavior inherited from class <code>Object</code>. If you need to override an equals inherited from a different
+superclass, you can use use:
+<pre>
+public boolean equals(Object o) { return this == o; }
+</pre>
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines an equals method that always returns true. This is imaginative, but not very smart.
+Plus, it means that the equals method is not symmetric.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This equals method is checking to see if the argument is some incompatible type
+(i.e., a class that is neither a supertype nor subtype of the class that defines
+the equals method). For example, the Foo class might have an equals method
+that looks like:
+
+<p><code><pre>
+public boolean equals(Object o) {
+ if (o instanceof Foo)
+ return name.equals(((Foo)o).name);
+ else if (o instanceof String)
+ return name.equals(o);
+ else return false;
+</pre></code></p>
+
+<p>This is considered bad practice, as it makes it very hard to implement an equals method that
+is symmetric and transitive. Without those properties, very unexpected behavoirs are possible.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a <code>compareTo(...)</code> method but inherits its
+ <code>equals()</code> method from <code>java.lang.Object</code>.
+ Generally, the value of compareTo should return zero if and only if
+ equals returns true. If this is violated, weird and unpredictable
+ failures will occur in classes such as PriorityQueue.
+ In Java 5 the PriorityQueue.remove method uses the compareTo method,
+ while in Java 6 it uses the equals method.
+
+<p>From the JavaDoc for the compareTo method in the Comparable interface:
+<blockquote>
+It is strongly recommended, but not strictly required that <code>(x.compareTo(y)==0) == (x.equals(y))</code>.
+Generally speaking, any class that implements the Comparable interface and violates this condition
+should clearly indicate this fact. The recommended language
+is "Note: this class has a natural ordering that is inconsistent with equals."
+</blockquote>
\ No newline at end of file
--- /dev/null
+<p> This method checks to see if two objects are the same class by checking to see if the names
+of their classes are equal. You can have different classes with the same name if they are loaded by
+different class loaders. Just check to see if the class objects are the same.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class extends a class that defines an equals method and adds fields, but doesn't
+define an equals method itself. Thus, equality on instances of this class will
+ignore the identity of the subclass and the added fields. Be sure this is what is intended,
+and that you don't need to override the equals method. Even if you don't need to override
+the equals method, consider overriding it anyway to document the fact
+that the equals method for the subclass just return the result of
+invoking super.equals(o).
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This class defines an enumeration, and equality on enumerations are defined
+using object identity. Defining a covariant equals method for an enumeration
+value is exceptionally bad practice, since it would likely result
+in having two different enumeration values that compare as equals using
+the covariant enum method, and as not equal when compared normally.
+Don't do it.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class has an equals method that will be broken if it is inherited by subclasses.
+It compares a class literal with the class of the argument (e.g., in class <code>Foo</code>
+it might check if <code>Foo.class == o.getClass()</code>).
+It is better to check if <code>this.getClass() == o.getClass()</code>.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines an <code>equals()</code>
+ method, that doesn't override the normal <code>equals(Object)</code> method
+ defined in the base <code>java.lang.Object</code> class. Instead, it
+ inherits an <code>equals(Object)</code> method from a superclass.
+ The class should probably define a <code>boolean equals(Object)</code> method.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This class defines an <code>equals()</code>
+ method, that doesn't override the normal <code>equals(Object)</code> method
+ defined in the base <code>java.lang.Object</code> class.
+ The class should probably define a <code>boolean equals(Object)</code> method.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This class defines an equals method that overrides an equals method in a superclass. Both equals methods
+methods use <code>instanceof</code> in the determination of whether two objects are equal. This is fraught with peril,
+since it is important that the equals method is symmetrical (in other words, <code>a.equals(b) == b.equals(a)</code>).
+If B is a subtype of A, and A's equals method checks that the argument is an instanceof A, and B's equals method
+checks that the argument is an instanceof B, it is quite likely that the equivalence relation defined by these
+methods is not symmetric.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a covariant version of <code>equals()</code>.
+ To correctly override the <code>equals()</code> method in
+ <code>java.lang.Object</code>, the parameter of <code>equals()</code>
+ must have type <code>java.lang.Object</code>.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a covariant version of the <code>equals()</code>
+ method, but inherits the normal <code>equals(Object)</code> method
+ defined in the base <code>java.lang.Object</code> class.
+ The class should probably define a <code>boolean equals(Object)</code> method.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This class doesn't do any of the patterns we recognize for checking that the type of the argument
+is compatible with the type of the <code>this</code> object. There might not be anything wrong with
+this code, but it is worth reviewing.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code compares a <code>java.lang.String</code> parameter for reference
+equality using the == or != operators. Requiring callers to
+pass only String constants or interned strings to a method is unnecessarily
+fragile, and rarely leads to measurable performance gains. Consider
+using the <code>equals(Object)</code> method instead.</p>
\ No newline at end of file
--- /dev/null
+<p>This code compares <code>java.lang.String</code> objects for reference
+equality using the == or != operators.
+Unless both strings are either constants in a source file, or have been
+interned using the <code>String.intern()</code> method, the same string
+value may be represented by two different String objects. Consider
+using the <code>equals(Object)</code> method instead.</p>
\ No newline at end of file
--- /dev/null
+<p> The code contains an empty synchronized block:</p>
+<pre>
+synchronized() {}
+</pre>
+<p>Empty synchronized blocks are far more subtle and hard to use correctly
+than most people recognize, and empty synchronized blocks
+are almost never a better solution
+than less contrived solutions.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ FindBugs didn't generate generated a warning that, according to a @ExpectedWarning annotated,
+ is expected or desired
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ FindBugs generated a warning that, according to a @NoWarning annotated,
+ is unexpected or undesired
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This operation compares two floating point values for equality.
+ Because floating point calculations may involve rounding,
+ calculated float and double values may not be accurate.
+ For values that must be precise, such as monetary values,
+ consider using a fixed-precision type such as BigDecimal.
+ For values that need not be precise, consider comparing for equality
+ within some range, for example:
+ <code>if ( Math.abs(x - y) < .0000001 )</code>.
+ See the Java Language Specification, section 4.2.4.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This code checks to see if a floating point value is equal to the special
+ Not A Number value (e.g., <code>if (x == Double.NaN)</code>). However,
+ because of the special semantics of <code>NaN</code>, no value
+ is equal to <code>Nan</code>, including <code>NaN</code>. Thus,
+ <code>x == Double.NaN</code> always evaluates to false.
+
+ To check to see if a value contained in <code>x</code>
+ is the special Not A Number value, use
+ <code>Double.isNaN(x)</code> (or <code>Float.isNaN(x)</code> if
+ <code>x</code> is floating point precision).
+ </p>
\ No newline at end of file
--- /dev/null
+<p> Empty <code>finalize()</code> methods are useless, so they should
+ be deleted.</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains an explicit invocation of the <code>finalize()</code>
+ method on an object. Because finalizer methods are supposed to be
+ executed once, and only by the VM, this is a bad idea.</p>
+<p>If a connected set of objects beings finalizable, then the VM will invoke the
+finalize method on all the finalizable object, possibly at the same time in different threads.
+Thus, it is a particularly bad idea, in the finalize method for a class X, invoke finalize
+on objects referenced by X, because they may already be getting finalized in a separate thread.
\ No newline at end of file
--- /dev/null
+<p> This finalizer nulls out fields. This is usually an error, as it does not aid garbage collection,
+ and the object is going to be garbage collected anyway.
\ No newline at end of file
--- /dev/null
+<p> This finalizer does nothing except null out fields. This is completely pointless, and requires that
+the object be garbage collected, finalized, and then garbage collected again. You should just remove the finalize
+method.
\ No newline at end of file
--- /dev/null
+<p> This <code>finalize()</code> method does not make a call to its
+ superclass's <code>finalize()</code> method. So, any finalizer
+ actions defined for the superclass will not be performed.
+ Add a call to <code>super.finalize()</code>.</p>
\ No newline at end of file
--- /dev/null
+<p> This empty <code>finalize()</code> method explicitly negates the
+ effect of any finalizer defined by its superclass. Any finalizer
+ actions defined for the superclass will not be performed.
+ Unless this is intended, delete this method.</p>
\ No newline at end of file
--- /dev/null
+<p> A class's <code>finalize()</code> method should have protected access,
+ not public.</p>
\ No newline at end of file
--- /dev/null
+<p> The only thing this <code>finalize()</code> method does is call
+ the superclass's <code>finalize()</code> method, making it
+ redundant. Delete it.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ The method performs math operations using floating point precision.
+ Floating point precision is very imprecise. For example,
+ 16777216.0f + 1.0f = 16777216.0f. Consider using double math instead.</p>
\ No newline at end of file
--- /dev/null
+<p> This call to a generic collection method passes an argument
+ while compile type Object where a specific type from
+ the generic type parameters is expected.
+ Thus, neither the standard Java type system nor static analysis
+ can provide useful information on whether the
+ object being passed as a parameter is of an appropriate type.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This call to a generic collection method contains an argument
+ with an incompatible class from that of the collection's parameter
+ (i.e., the type of the argument is neither a supertype nor a subtype
+ of the corresponding generic type argument).
+ Therefore, it is unlikely that the collection contains any objects
+ that are equal to the method argument used here.
+ Most likely, the wrong value is being passed to the method.</p>
+ <p>In general, instances of two unrelated classes are not equal.
+ For example, if the <code>Foo</code> and <code>Bar</code> classes
+ are not related by subtyping, then an instance of <code>Foo</code>
+ should not be equal to an instance of <code>Bar</code>.
+ Among other issues, doing so will likely result in an equals method
+ that is not symmetrical. For example, if you define the <code>Foo</code> class
+ so that a <code>Foo</code> can be equal to a <code>String</code>,
+ your equals method isn't symmetrical since a <code>String</code> can only be equal
+ to a <code>String</code>.
+ </p>
+ <p>In rare cases, people do define nonsymmetrical equals methods and still manage to make
+ their code work. Although none of the APIs document or guarantee it, it is typically
+ the case that if you check if a <code>Collection<String></code> contains
+ a <code>Foo</code>, the equals method of argument (e.g., the equals method of the
+ <code>Foo</code> class) used to perform the equality checks.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This class overrides <code>equals(Object)</code>, but does not
+ override <code>hashCode()</code>. Therefore, the class may violate the
+ invariant that equal objects must have equal hashcodes.</p>
\ No newline at end of file
--- /dev/null
+<p> This class overrides <code>equals(Object)</code>, but does not
+ override <code>hashCode()</code>, and inherits the implementation of
+ <code>hashCode()</code> from <code>java.lang.Object</code> (which returns
+ the identity hash code, an arbitrary value assigned to the object
+ by the VM). Therefore, the class is very likely to violate the
+ invariant that equal objects must have equal hashcodes.</p>
+
+<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
+the recommended <code>hashCode</code> implementation to use is:</p>
+<pre>public int hashCode() {
+ assert false : "hashCode not designed";
+ return 42; // any arbitrary constant will do
+ }</pre>
\ No newline at end of file
--- /dev/null
+<p> This class defines a <code>hashCode()</code> method but not an
+ <code>equals()</code> method. Therefore, the class may
+ violate the invariant that equal objects must have equal hashcodes.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a <code>hashCode()</code> method but inherits its
+ <code>equals()</code> method from <code>java.lang.Object</code>
+ (which defines equality by comparing object references). Although
+ this will probably satisfy the contract that equal objects must have
+ equal hashcodes, it is probably not what was intended by overriding
+ the <code>hashCode()</code> method. (Overriding <code>hashCode()</code>
+ implies that the object's identity is based on criteria more complicated
+ than simple reference equality.)</p>
+<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
+the recommended <code>hashCode</code> implementation to use is:</p>
+<p><pre>public int hashCode() {
+ assert false : "hashCode not designed";
+ return 42; // any arbitrary constant will do
+ }</pre></p>
\ No newline at end of file
--- /dev/null
+<p> This class inherits <code>equals(Object)</code> from an abstract
+ superclass, and <code>hashCode()</code> from
+<code>java.lang.Object</code> (which returns
+ the identity hash code, an arbitrary value assigned to the object
+ by the VM). Therefore, the class is very likely to violate the
+ invariant that equal objects must have equal hashcodes.</p>
+
+ <p>If you don't want to define a hashCode method, and/or don't
+ believe the object will ever be put into a HashMap/Hashtable,
+ define the <code>hashCode()</code> method
+ to throw <code>UnsupportedOperationException</code>.</p>
\ No newline at end of file
--- /dev/null
+<p> A method, field or class declares a generic signature where a non-hashable class
+is used in context where a hashable class is required.
+A class that declares an equals method but inherits a hashCode() method
+from Object is unhashable, since it doesn't fulfill the requirement that
+equal objects have equal hashCodes.
+</p>
\ No newline at end of file
--- /dev/null
+<p> A class defines an equals(Object) method but not a hashCode() method,
+and thus doesn't fulfill the requirement that equal objects have equal hashCodes.
+An instance of this class is used in a hash data structure, making the need to
+fix this problem of highest importance.
\ No newline at end of file
--- /dev/null
+<p>This code constructs an HTTP Cookie using an untrusted HTTP parameter. If this cookie is added to an HTTP response, it will allow a HTTP response splitting
+vulnerability. See <a href="http://en.wikipedia.org/wiki/HTTP_response_splitting">http://en.wikipedia.org/wiki/HTTP_response_splitting</a>
+for more information.</p>
+<p>FindBugs looks only for the most blatant, obvious cases of HTTP response splitting.
+If FindBugs found <em>any</em>, you <em>almost certainly</em> have more
+vulnerabilities that FindBugs doesn't report. If you are concerned about HTTP response splitting, you should seriously
+consider using a commercial static analysis or pen-testing tool.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code directly writes an HTTP parameter to an HTTP header, which allows for a HTTP response splitting
+vulnerability. See <a href="http://en.wikipedia.org/wiki/HTTP_response_splitting">http://en.wikipedia.org/wiki/HTTP_response_splitting</a>
+for more information.</p>
+<p>FindBugs looks only for the most blatant, obvious cases of HTTP response splitting.
+If FindBugs found <em>any</em>, you <em>almost certainly</em> have more
+vulnerabilities that FindBugs doesn't report. If you are concerned about HTTP response splitting, you should seriously
+consider using a commercial static analysis or pen-testing tool.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ A large String constant is duplicated across multiple class files.
+ This is likely because a final field is initialized to a String constant, and the Java language
+ mandates that all references to a final field from other classes be inlined into
+that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6447475">JDK bug 6447475</a>
+ for a description of an occurrence of this bug in the JDK and how resolving it reduced
+ the size of the JDK by 1 megabyte.
+</p>
\ No newline at end of file
--- /dev/null
+<p> An inner class is invoking a method that could be resolved to either a inherited method or a method defined in an outer class. By the Java semantics,
+it will be resolved to invoke the inherited method, but this may not be want
+you intend. If you really intend to invoke the inherited method,
+invoke it by invoking the method on super (e.g., invoke super.foo(17)), and
+thus it will be clear to other readers of your code and to FindBugs
+that you want to invoke the inherited method, not the method in the outer class.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code performs an integer shift by a constant amount outside
+the range 0..31.
+The effect of this is to use the lower 5 bits of the integer
+value to decide how much to shift by. This probably isn't want was expected,
+and it at least confusing.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code casts the result of an integer division operation to double or
+float.
+Doing division on integers truncates the result
+to the integer value closest to zero. The fact that the result
+was cast to double suggests that this precision should have been retained.
+What was probably meant was to cast one or both of the operands to
+double <em>before</em> performing the division. Here is an example:
+</p>
+<blockquote>
+<pre>
+int x = 2;
+int y = 5;
+// Wrong: yields result 0.0
+double value1 = x / y;
+
+// Right: yields result 0.4
+double value2 = x / (double) y;
+</pre>
+</blockquote>
\ No newline at end of file
--- /dev/null
+<p>
+This code performs integer multiply and then converts the result to a long,
+as in:
+<code>
+<pre>
+ long convertDaysToMilliseconds(int days) { return 1000*3600*24*days; }
+</pre></code>
+If the multiplication is done using long arithmetic, you can avoid
+the possibility that the result will overflow. For example, you
+could fix the above code to:
+<code>
+<pre>
+ long convertDaysToMilliseconds(int days) { return 1000L*3600*24*days; }
+</pre></code>
+or
+<code>
+<pre>
+ static final long MILLISECONDS_PER_DAY = 24L*3600*1000;
+ long convertDaysToMilliseconds(int days) { return days * MILLISECONDS_PER_DAY; }
+</pre></code>
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code converts a 32-bit int value to a 64-bit long value, and then passes that value for a
+method parameter that requires an absolute time value. An absolute time value is the number of
+milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.
+For example, the following method, intended to convert seconds since the epoc into a Date, is badly broken:
+<pre>
+Date getDate(int seconds) { return new Date(seconds * 1000); }
+</pre>
+</p>
+<p>The multiplication is done using 32-bit arithmetic, and then converted to a 64-bit value. When a 32-bit
+value is converted to 64-bits and used to express an absolute time value, only dates in December 1969 and
+January 1970 can be represented.</p>
+<p>Correct implementations for the above method are:
+<pre>
+// Fails for dates after 2037
+Date getDate(int seconds) { return new Date(seconds * 1000L); }
+
+// better, works for all dates
+Date getDate(long seconds) { return new Date(seconds * 1000); }
+</pre>
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code converts an int value to a double precision
+floating point number and then
+passing the result to the Math.ceil() function, which rounds a double to
+the next higher integer value. This operation should always be a no-op,
+since the converting an integer to a double should give a number with no fractional part.
+It is likely that the operation that generated the value to be passed
+to Math.ceil was intended to be performed using double precision
+floating point arithmetic.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code converts an int value to a float precision
+floating point number and then
+passing the result to the Math.round() function, which returns the int/long closest
+to the argument. This operation should always be a no-op,
+since the converting an integer to a float should give a number with no fractional part.
+It is likely that the operation that generated the value to be passed
+to Math.round was intended to be performed using
+floating point arithmetic.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code performs an unsigned right shift, whose result is then
+cast to a short or byte, which discards the upper bits of the result.
+Since the upper bits are discarded, there may be no difference between
+a signed and unsigned right shift (depending upon the size of the shift).
+</p>
\ No newline at end of file
--- /dev/null
+<p> A circularity was detected in the static initializers of the two
+ classes referenced by the bug instance. Many kinds of unexpected
+ behavior may arise from such circularity.</p>
\ No newline at end of file
--- /dev/null
+<p> During the initialization of a class, the class makes an active use of a subclass.
+That subclass will not yet be initialized at the time of this use.
+For example, in the following code, <code>foo</code> will be null.</p>
+
+<pre>
+public class CircularClassInitialization {
+ static class InnerClassSingleton extends CircularClassInitialization {
+ static InnerClassSingleton singleton = new InnerClassSingleton();
+ }
+
+ static CircularClassInitialization foo = InnerClassSingleton.singleton;
+}
+</pre>
\ No newline at end of file
--- /dev/null
+<p> A JUnit assertion is performed in a run method. Failed JUnit assertions
+just result in exceptions being thrown.
+Thus, if this exception occurs in a thread other than the thread that invokes
+the test method, the exception will terminate the thread but not result
+in the test failing.
+</p>
\ No newline at end of file
--- /dev/null
+<p> Class is a JUnit TestCase and defines a suite() method.
+However, the suite method needs to be declared as either
+<pre>public static junit.framework.Test suite()</pre>
+or
+<pre>public static junit.framework.TestSuite suite()</pre>
+</p>
\ No newline at end of file
--- /dev/null
+<p> Class is a JUnit TestCase but has not implemented any test methods</p>
\ No newline at end of file
--- /dev/null
+<p> Class is a JUnit TestCase and implements the setUp method. The setUp method should call
+super.setUp(), but doesn't.</p>
\ No newline at end of file
--- /dev/null
+<p> Class is a JUnit TestCase and implements the suite() method.
+ The suite method should be declared as being static, but isn't.</p>
\ No newline at end of file
--- /dev/null
+<p> Class is a JUnit TestCase and implements the tearDown method. The tearDown method should call
+super.tearDown(), but doesn't.</p>
\ No newline at end of file
--- /dev/null
+<p>A collection is added to itself. As a result, computing the hashCode of this
+set will throw a StackOverflowException.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This loop doesn't seem to have a way to terminate (other than by perhaps
+throwing an exception).</p>
\ No newline at end of file
--- /dev/null
+<p>This method unconditionally invokes itself. This would seem to indicate
+an infinite recursive loop that will result in a stack overflow.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method of an inner class reads from or writes to a private member variable of the owning class,
+ or calls a private method of the owning class. The compiler must generate a special method to access this
+ private member, causing this to be less efficient. Relaxing the protection of the member variable or method
+ will allow the compiler to treat this as a normal access.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>IllegalMonitorStateException is generally only
+ thrown in case of a design flaw in your code (calling wait or
+ notify on an object you do not hold a lock on).</p>
\ No newline at end of file
--- /dev/null
+<p>The code computes the average of two integers using either division or signed right shift,
+and then uses the result as the index of an array.
+If the values being averaged are very large, this can overflow (resulting in the computation
+of a negative average). Assuming that the result is intended to be nonnegative, you
+can use an unsigned right shift instead. In other words, rather that using <code>(low+high)/2</code>,
+use <code>(low+high) >>> 1</code>
+</p>
+<p>This bug exists in many earlier implementations of binary search and merge sort.
+Martin Buchholz <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6412541">found and fixed it</a>
+in the JDK libraries, and Joshua Bloch
+<a href="http://googleresearch.blogspot.com/2006/06/extra-extra-read-all-about-it-nearly.html">widely
+publicized the bug pattern</a>.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code uses x % 2 == 1 to check to see if a value is odd, but this won't work
+for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check
+for oddness, consider using x & 1 == 1, or x % 2 != 0.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code multiplies the result of an integer remaining by an integer constant.
+Be sure you don't have your operator precedence confused. For example
+i % 60 * 1000 is (i % 60) * 1000, not i % (60 * 1000).
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code compares an int value with a long constant that is outside the range of values that can
+ be represented as an int value. This comparison is vacuous and possibily to be incorrect.</p>
\ No newline at end of file
--- /dev/null
+<p> This code compares a value that is guaranteed to be non-negative with a negative constant.
+</p>
\ No newline at end of file
--- /dev/null
+<p> Signed bytes can only have a value in the range -128 to 127. Comparing
+a signed byte with a value outside that range is vacuous and likely to be incorrect.
+To convert a signed byte <code>b</code> to an unsigned value in the range 0..255,
+use <code>0xff & b</code>
+</p>
\ No newline at end of file
--- /dev/null
+<p> Any expression (exp % 1) is guaranteed to always return zero.
+Did you mean (exp & 1) or (exp % 2) instead?
+</p>
\ No newline at end of file
--- /dev/null
+<p> This is an integer bit operation (and, or, or exclusive or) that doesn't do any useful work
+(e.g., <code>v & 0xffffffff</code>).
+
+</p>
\ No newline at end of file
--- /dev/null
+<p> There is an integer comparison that always returns
+the same value (e.g., x <= Integer.MAX_VALUE).
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This code opens a file in append mode and then wraps the result in an object output stream.
+ This won't allow you to append to an existing object output stream stored in a file. If you want to be
+ able to append to an object output stream, you need to keep the object output stream open.
+ </p>
+ <p>The only situation in which opening a file in append mode and the writing an object output stream
+ could work is if on reading the file you plan to open it in random access mode and seek to the byte offset
+ where the append started.
+ </p>
+
+ <p>
+ TODO: example.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+The initial value of this parameter is ignored, and the parameter
+is overwritten here. This often indicates a mistaken belief that
+the write to the parameter will be conveyed back to
+the caller.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The fields of this class appear to be accessed inconsistently with respect
+ to synchronization. This bug report indicates that the bug pattern detector
+ judged that
+ </p>
+ <ol>
+ <li> The class contains a mix of locked and unlocked accesses,</li>
+ <li> At least one locked access was performed by one of the class's own methods, and</li>
+ <li> The number of unsynchronized field accesses (reads and writes) was no more than
+ one third of all accesses, with writes being weighed twice as high as reads</li>
+ </ol>
+
+ <p> A typical bug matching this bug pattern is forgetting to synchronize
+ one of the methods in a class that is intended to be thread-safe.</p>
+
+ <p> You can select the nodes labeled "Unsynchronized access" to show the
+ code locations where the detector believed that a field was accessed
+ without synchronization.</p>
+
+ <p> Note that there are various sources of inaccuracy in this detector;
+ for example, the detector cannot statically detect all situations in which
+ a lock is held. Also, even when the detector is accurate in
+ distinguishing locked vs. unlocked accesses, the code in question may still
+ be correct.</p>
\ No newline at end of file
--- /dev/null
+<p> This class allocates an object that is based on a class that only supplies static methods. This object
+does not need to be created, just access the static methods directly using the class name as a qualifier.</p>
\ No newline at end of file
--- /dev/null
+<p> This field is annotated with net.jcip.annotations.GuardedBy,
+but can be accessed in a way that seems to violate the annotation.</p>
\ No newline at end of file
--- /dev/null
+<p> The fields of this class appear to be accessed inconsistently with respect
+ to synchronization. This bug report indicates that the bug pattern detector
+ judged that
+ </p>
+ <ol>
+ <li> The class contains a mix of locked and unlocked accesses,</li>
+ <li> At least one locked access was performed by one of the class's own methods, and</li>
+ <li> The number of unsynchronized field accesses (reads and writes) was no more than
+ one third of all accesses, with writes being weighed twice as high as reads</li>
+ </ol>
+
+ <p> A typical bug matching this bug pattern is forgetting to synchronize
+ one of the methods in a class that is intended to be thread-safe.</p>
+
+ <p> Note that there are various sources of inaccuracy in this detector;
+ for example, the detector cannot statically detect all situations in which
+ a lock is held. Also, even when the detector is accurate in
+ distinguishing locked vs. unlocked accesses, the code in question may still
+ be correct.</p>
\ No newline at end of file
--- /dev/null
+<p> This method uses the toArray() method of a collection derived class, and passes
+in a zero-length prototype array argument. It is more efficient to use
+<code>myCollection.toArray(new Foo[myCollection.size()])</code>
+If the array passed in is big enough to store all of the
+elements of the collection, then it is populated and returned
+directly. This avoids the need to create a second array
+(by reflection) to return as the result.</p>
\ No newline at end of file
--- /dev/null
+<p> This class implements the <code>java.util.Iterator</code> interface.
+ However, its <code>next()</code> method is not capable of throwing
+ <code>java.util.NoSuchElementException</code>. The <code>next()</code>
+ method should be changed so it throws <code>NoSuchElementException</code>
+ if is called when there are no more elements to return.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code seems to be storing a non-serializable object into an HttpSession.
+If this session is passivated or migrated, an error will result.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The class is annotated with net.jcip.annotations.Immutable, and the rules for that annotation require
+that all fields are final.
+ .</p>
\ No newline at end of file
--- /dev/null
+<p> This method performs synchronization on an implementation of
+<code>java.util.concurrent.locks.Lock</code>. You should use
+the <code>lock()</code> and <code>unlock()</code> methods instead.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This method calls <code>wait()</code>, <code>notify()</code> or <code>notifyAll()</code> on an object that also
+provides an <code>await()</code>, <code>signal()</code>, <code>signalAll()</code> method (such as util.concurrent
+Condition objects). This probably isn't what you want, and even if you do want it, you should consider changing your
+design, as other developers will find it exceptionally confusing.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ OpenJDK introduces a potential incompatibility.
+ In particular, the java.util.logging.Logger behavior has
+ changed. Instead of using strong references, it now uses weak references
+ internally. That's a reasonable change, but unfortunately some code relies on
+ the old behavior - when changing logger configuration, it simply drops the
+ logger reference. That means that the garbage collector is free to reclaim
+ that memory, which means that the logger configuration is lost. For example,
+ consider:
+ </p>
+ <p><pre>public static void initLogging() throws Exception {
+ Logger logger = Logger.getLogger("edu.umd.cs");
+ logger.addHandler(new FileHandler()); // call to change logger configuration
+ logger.setUseParentHandlers(false); // another call to change logger configuration
+ }</pre></p>
+ <p>The logger reference is lost at the end of the method (it doesn't
+ escape the method), so if you have a garbage collection cycle just
+ after the call to initLogging, the logger configuration is lost
+ (because Logger only keeps weak references).</p>
+ <p><pre>public static void main(String[] args) throws Exception {
+ initLogging(); // adds a file handler to the logger
+ System.gc(); // logger configuration lost
+ Logger.getLogger("edu.umd.cs").info("Some message"); // this isn't logged to the file as expected
+ }</pre></p>
+ <p><em>Ulf Ochsenfahrt and Eric Fellheimer</em>
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This method contains an unsynchronized lazy initialization of a non-volatile static field.
+Because the compiler or processor may reorder instructions,
+threads are not guaranteed to see a completely initialized object,
+<em>if the method can be called by multiple threads</em>.
+You can make the field volatile to correct the problem.
+For more information, see the
+<a href="http://www.cs.umd.edu/~pugh/java/memoryModel/">Java Memory Model web site</a>.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains an unsynchronized lazy initialization of a static field.
+After the field is set, the object stored into that location is further accessed.
+The setting of the field is visible to other threads as soon as it is set. If the
+futher accesses in the method that set the field serve to initialize the object, then
+you have a <em>very serious</em> multithreading bug, unless something else prevents
+any other thread from accessing the stored object until it is fully initialized.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a field with the same name as a visible
+instance field in a superclass. This is confusing, and
+may indicate an error if methods update or access one of
+the fields when they wanted the other.</p>
\ No newline at end of file
--- /dev/null
+<p> This method defines a local variable with the same name as a field
+in this class or a superclass. This may cause the method to
+read an uninitialized value from the field, leave the field uninitialized,
+or both.</p>
\ No newline at end of file
--- /dev/null
+<p> This method synchronizes on a field in what appears to be an attempt
+to guard against simultaneous updates to that field. But guarding a field
+gets a lock on the referenced object, not on the field. This may not
+provide the mutual exclusion you need, and other threads might
+be obtaining locks on the referenced objects (for other purposes). An example
+of this pattern would be:
+
+<p><pre>
+private Long myNtfSeqNbrCounter = new Long(0);
+private Long getNotificationSequenceNumber() {
+ Long result = null;
+ synchronized(myNtfSeqNbrCounter) {
+ result = new Long(myNtfSeqNbrCounter.longValue() + 1);
+ myNtfSeqNbrCounter = new Long(result.longValue());
+ }
+ return result;
+ }
+</pre>
+
+
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method synchronizes on an object
+ referenced from a mutable field.
+ This is unlikely to have useful semantics, since different
+threads may be synchronizing on different objects.</p>
\ No newline at end of file
--- /dev/null
+<p>A web server generally only creates one instance of servlet or jsp class (i.e., treats
+the class as a Singleton),
+and will
+have multiple threads invoke methods on that instance to service multiple
+simultaneous requests.
+Thus, having a mutable instance field generally creates race conditions.
\ No newline at end of file
--- /dev/null
+<p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ Unfortunately, the way the field is used doesn't allow
+ any easy fix to this problem.</p>
\ No newline at end of file
--- /dev/null
+<p> A public static method returns a reference to
+ an array that is part of the static state of the class.
+ Any code that calls this method can freely modify
+ the underlying array.
+ One fix is to return a copy of the array.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ The field could be made package protected and/or made final
+ to avoid
+ this vulnerability.</p>
\ No newline at end of file
--- /dev/null
+<p> A final static field references an array
+ and can be accessed by malicious code or
+ by accident from another package.
+ This code can freely modify the contents of the array.</p>
\ No newline at end of file
--- /dev/null
+<p>A final static field references a Hashtable
+ and can be accessed by malicious code or
+ by accident from another package.
+ This code can freely modify the contents of the Hashtable.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ A final static field that is
+defined in an interface references a mutable
+ object such as an array or hashtable.
+ This mutable object could
+ be changed by malicious code or
+ by accident from another package.
+ To solve this, the field needs to be moved to a class
+ and made package protected
+ to avoid
+ this vulnerability.</p>
\ No newline at end of file
--- /dev/null
+<p> A mutable static field could be changed by malicious code or
+ by accident.
+ The field could be made package protected to avoid
+ this vulnerability.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ A mutable static field could be changed by malicious code or
+ by accident from another package.
+ The field could be made final to avoid
+ this vulnerability.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This static field public but not final, and
+could be changed by malicious code or
+by accident from another package.
+The field could be made final to avoid
+this vulnerability. However, the static initializer contains more than one write
+to the field, so doing so will require some refactoring.
+</p>
--- /dev/null
+<p>
+ This class extends from a Servlet class, and uses an instance member variable. Since only
+ one instance of a Servlet class is created by the J2EE framework, and used in a
+ multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
+ only using method local variables.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This class extends from a Struts Action class, and uses an instance member variable. Since only
+ one instance of a struts Action class is created by the Struts framework, and used in a
+ multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
+ only using method local variables. Only instance fields that are written outside of a monitor
+ are reported.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This method calls Object.notify() or Object.notifyAll() without obviously holding a lock
+on the object. Calling notify() or notifyAll() without a lock held will result in
+an <code>IllegalMonitorStateException</code> being thrown.</p>
\ No newline at end of file
--- /dev/null
+<p> This method calls Object.wait() without obviously holding a lock
+on the object. Calling wait() without a lock held will result in
+an <code>IllegalMonitorStateException</code> being thrown.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This class defines a method <code>equal(Object)</code>.
+ This method does not override the <code>equals(Object)</code> method
+ in <code>java.lang.Object</code>, which is probably what was intended.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ Class names should be nouns, in mixed case with the first letter of each internal word capitalized.
+ Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations
+ (unless the abbreviation is much more widely used than the long form, such as URL or HTML).
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This class is not derived from another exception, but ends with 'Exception'. This will
+be confusing to users of this class.</p>
\ No newline at end of file
--- /dev/null
+<p> The referenced methods have names that differ only by capitalization.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ Names of fields that are not final should be in mixed case
+ with a lowercase first letter and the first letters of subsequent words capitalized.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>The identifier is a word that is reserved as a keyword in later versions of Java, and your code will need to be changed
+in order to compile it in later versions of Java.</p>
\ No newline at end of file
--- /dev/null
+<p>This identifier is used as a keyword in later versions of Java. This code, and
+any code that references this API,
+will need to be changed in order to compile it in later versions of Java.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This class defines a method called <code>hashcode()</code>.
+ This method does not override the <code>hashCode()</code>
+ method in <code>java.lang.Object</code>, which is probably what was intended.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This class defines a method called <code>tostring()</code>.
+ This method does not override the <code>toString()</code>
+ method in <code>java.lang.Object</code>, which is probably what was intended.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This regular method has the same name as the class it is defined in. It is likely that this was intended to be a constructor.
+ If it was intended to be a constructor, remove the declaration of a void return value.
+ If you had accidently defined this method, realized the mistake, defined a proper constructor
+ but can't get rid of this method due to backwards compatibility, deprecate the method.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ Methods should be verbs, in mixed case with the first letter lowercase,
+ with the first letter of each internal word capitalized.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This class/interface has a simple name that is identical to that of an implemented/extended interface, except
+that the interface is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>).
+This can be exceptionally confusing, create lots of situations in which you have to look at import statements
+to resolve references and creates many
+opportunities to accidently define methods that do not override methods in their superclasses.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class has a simple name that is identical to that of its superclass, except
+that its superclass is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>).
+This can be exceptionally confusing, create lots of situations in which you have to look at import statements
+to resolve references and creates many
+opportunities to accidently define methods that do not override methods in their superclasses.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The referenced methods have names that differ only by capitalization.
+This is very confusing because if the capitalization were
+identical then one of the methods would override the other.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The referenced methods have names that differ only by capitalization.
+This is very confusing because if the capitalization were
+identical then one of the methods would override the other. From the existence of other methods, it
+seems that the existence of both of these methods is intentional, but is sure is confusing.
+You should try hard to eliminate one of them, unless you are forced to have both due to frozen APIs.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match
+the type of the corresponding parameter in the superclass. For example, if you have:</p>
+
+<blockquote>
+<pre>
+import alpha.Foo;
+public class A {
+ public int f(Foo x) { return 17; }
+}
+----
+import beta.Foo;
+public class B extends A {
+ public int f(Foo x) { return 42; }
+}
+</pre>
+</blockquote>
+
+<p>The <code>f(Foo)</code> method defined in class <code>B</code> doesn't
+override the
+<code>f(Foo)</code> method defined in class <code>A</code>, because the argument
+types are <code>Foo</code>'s from different packages.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match
+the type of the corresponding parameter in the superclass. For example, if you have:</p>
+
+<blockquote>
+<pre>
+import alpha.Foo;
+public class A {
+ public int f(Foo x) { return 17; }
+}
+----
+import beta.Foo;
+public class B extends A {
+ public int f(Foo x) { return 42; }
+ public int f(alpha.Foo x) { return 27; }
+}
+</pre>
+</blockquote>
+
+<p>The <code>f(Foo)</code> method defined in class <code>B</code> doesn't
+override the
+<code>f(Foo)</code> method defined in class <code>A</code>, because the argument
+types are <code>Foo</code>'s from different packages.
+</p>
+
+<p>In this case, the subclass does define a method with a signature identical to the method in the superclass,
+so this is presumably understood. However, such methods are exceptionally confusing. You should strongly consider
+removing or deprecating the method with the similar but not identical signature.
+</p>
\ No newline at end of file
--- /dev/null
+<p> A call to <code>notify()</code> or <code>notifyAll()</code>
+ was made without any (apparent) accompanying
+ modification to mutable object state. In general, calling a notify
+ method on a monitor is done because some condition another thread is
+ waiting for has become true. However, for the condition to be meaningful,
+ it must involve a heap object that is visible to both threads.</p>
+
+ <p> This bug does not necessarily indicate an error, since the change to
+ mutable object state may have taken place in a method which then called
+ the method containing the notification.</p>
\ No newline at end of file
--- /dev/null
+<p> This method calls <code>notify()</code> rather than <code>notifyAll()</code>.
+ Java monitors are often used for multiple conditions. Calling <code>notify()</code>
+ only wakes up one thread, meaning that the thread woken up might not be the
+ one waiting for the condition that the caller just satisfied.</p>
\ No newline at end of file
--- /dev/null
+<p> A null pointer is dereferenced here. This will lead to a
+<code>NullPointerException</code> when the code is executed.</p>
\ No newline at end of file
--- /dev/null
+<p> A pointer which is null on an exception path is dereferenced here.
+This will lead to a <code>NullPointerException</code> when the code is executed.
+Note that because FindBugs currently does not prune infeasible exception paths,
+this may be a false warning.</p>
+
+<p> Also note that FindBugs considers the default case of a switch statement to
+be an exception path, since the default case is often infeasible.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ A parameter to this method has been identified as a value that should
+ always be checked to see whether or not it is null, but it is being dereferenced
+ without a preceding null check.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ A method that returns either Boolean.TRUE, Boolean.FALSE or null is an accident waiting to happen.
+ This method can be invoked as though it returned a value of type boolean, and
+ the compiler will insert automatic unboxing of the Boolean value. If a null value is returned,
+ this will result in a NullPointerException.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This clone method seems to return null in some circumstances, but clone is never
+ allowed to return a null value. If you are convinced this path is unreachable, throw an AssertionError
+ instead.
+ </p>
\ No newline at end of file
--- /dev/null
+close() is being invoked on a value that is always null. If this statement is executed, a null pointer exception will occur. But the big risk here you never close something that should be closed.
\ No newline at end of file
--- /dev/null
+<p> The result of invoking readLine() is dereferenced without checking to see if the result is null. If there are no more lines of text
+to read, readLine() will return null and dereferencing that will generate a null pointer exception.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This implementation of equals(Object) violates the contract defined
+ by java.lang.Object.equals() because it does not check for null
+ being passed as the argument. All equals() methods should return
+ false if passed a null value.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ There is a statement or branch that if executed guarantees that
+ a value is null at this point, and that
+ value that is guaranteed to be dereferenced
+ (except on forward paths involving runtime exceptions).
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ There is a statement or branch on an exception path
+ that if executed guarantees that
+ a value is null at this point, and that
+ value that is guaranteed to be dereferenced
+ (except on forward paths involving runtime exceptions).
+ </p>
\ No newline at end of file
--- /dev/null
+<p> The result of invoking readLine() is immediately dereferenced. If there are no more lines of text
+to read, readLine() will return null and dereferencing that will generate a null pointer exception.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The variable referenced at this point is known to be null due to an earlier
+ check against null. Although this is valid, it might be a mistake (perhaps you
+intended to refer to a different variable, or perhaps the earlier check to see if the
+variable is null should have been a check to see if it was nonnull).
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The field is marked as nonnull, but isn't written to by the constructor.
+The field might be initialized elsewhere during constructor, or might always
+be initialized before use.
+</p>
--- /dev/null
+<p>
+ This method passes a null value as the parameter of a method which
+ must be nonnull. Either this parameter has been explicitly marked
+ as @Nonnull, or analysis has determined that this parameter is
+ always dereferenced.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method may return a null value, but the method (or a superclass method
+ which it overrides) is declared to return @NonNull.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+This instanceof test will always return false, since the value being checked is guaranteed to be null.
+Although this is safe, make sure it isn't
+an indication of some misunderstanding or some other logic error.
+</p>
\ No newline at end of file
--- /dev/null
+<p> There is a branch of statement that, <em>if executed,</em> guarantees that
+a null value will be dereferenced, which
+would generate a <code>NullPointerException</code> when the code is executed.
+Of course, the problem might be that the branch or statement is infeasible and that
+the null pointer exception can't ever be executed; deciding that is beyond the ability of FindBugs.
+</p>
\ No newline at end of file
--- /dev/null
+<p> A reference value which is null on some exception control path is
+dereferenced here. This may lead to a <code>NullPointerException</code>
+when the code is executed.
+Note that because FindBugs currently does not prune infeasible exception paths,
+this may be a false warning.</p>
+
+<p> Also note that FindBugs considers the default case of a switch statement to
+be an exception path, since the default case is often infeasible.</p>
\ No newline at end of file
--- /dev/null
+<p> The return value from a method is dereferenced without a null check,
+and the return value of that method is one that should generally be checked
+for null. This may lead to a <code>NullPointerException</code> when the code is executed.
+</p>
\ No newline at end of file
--- /dev/null
+<p> There is a branch of statement that, <em>if executed,</em> guarantees that
+a null value will be dereferenced, which
+would generate a <code>NullPointerException</code> when the code is executed.
+Of course, the problem might be that the branch or statement is infeasible and that
+the null pointer exception can't ever be executed; deciding that is beyond the ability of FindBugs.
+Due to the fact that this value had been previously tested for nullness, this is a definite possibility.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method call passes a null value for a nonnull method parameter.
+ Either the parameter is annotated as a parameter that should
+ always be nonnull, or analysis has shown that it will always be
+ dereferenced.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ A possibly-null value is passed at a call site where all known
+ target methods require the parameter to be nonnull.
+ Either the parameter is annotated as a parameter that should
+ always be nonnull, or analysis has shown that it will always be
+ dereferenced.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ A possibly-null value is passed to a nonnull method parameter.
+ Either the parameter is annotated as a parameter that should
+ always be nonnull, or analysis has shown that it will always be
+ dereferenced.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This parameter is always used in a way that requires it to be nonnull,
+but the parameter is explicitly annotated as being Nullable. Either the use
+of the parameter or the annotation is wrong.
+</p>
\ No newline at end of file
--- /dev/null
+<p> A value that could be null is stored into a field that has been annotated as NonNull. </p>
\ No newline at end of file
--- /dev/null
+<p>Since the field is synchronized on, it seems not likely to be null.
+If it is null and then synchronized on a NullPointerException will be
+thrown and the check would be pointless. Better to synchronize on
+another field.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This toString method seems to return null in some circumstances. A liberal reading of the
+ spec could be interpreted as allowing this, but it is probably a bad idea and could cause
+ other code to break. Return the empty string or some other appropriate string rather than null.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>The program is dereferencing a field that does not seem to ever have a non-null value written to it. Dereferencing this value will generate a null pointer exception.</p>
\ No newline at end of file
--- /dev/null
+<p>The program is dereferencing a public or protected field that does not seem to ever have a non-null
+ value written to it. Unless the field is initialized via some mechanism not seen by the analysis,
+ dereferencing this value will generate a null pointer exception.</p>
\ No newline at end of file
--- /dev/null
+<p> This code seems to be using non-short-circuit logic (e.g., &
+or |)
+rather than short-circuit logic (&& or ||). In addition,
+it seem possible that, depending on the value of the left hand side, you might not
+want to evaluate the right hand side (because it would have side effects, could cause an exception
+or could be expensive.</p>
+<p>
+Non-short-circuit logic causes both sides of the expression
+to be evaluated even when the result can be inferred from
+knowing the left-hand side. This can be less efficient and
+can result in errors if the left-hand side guards cases
+when evaluating the right-hand side can generate an error.
+</p>
+
+<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
+Language Specification</a> for details
+
+</p>
\ No newline at end of file
--- /dev/null
+<p> This code seems to be using non-short-circuit logic (e.g., &
+or |)
+rather than short-circuit logic (&& or ||).
+Non-short-circuit logic causes both sides of the expression
+to be evaluated even when the result can be inferred from
+knowing the left-hand side. This can be less efficient and
+can result in errors if the left-hand side guards cases
+when evaluating the right-hand side can generate an error.
+
+<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
+Language Specification</a> for details
+
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method may fail to clean up (close, dispose of) a stream,
+ database object, or other
+ resource requiring an explicit cleanup operation.
+ </p>
+ <p>
+ In general, if a method opens a stream or other resource,
+ the method should use a try/finally block to ensure that
+ the stream or resource is cleaned up before the method
+ returns.
+ </p>
+ <p>
+ This bug pattern is essentially the same as the
+ OS_OPEN_STREAM and ODR_OPEN_DATABASE_RESOURCE
+ bug patterns, but is based on a different
+ (and hopefully better) static analysis technique.
+ We are interested is getting feedback about the
+ usefulness of this bug pattern.
+ To send feedback, either:
+ </p>
+ <ul>
+ <li>send email to findbugs@cs.umd.edu</li>
+ <li>file a bug report: <a href="http://findbugs.sourceforge.net/reportingBugs.html">http://findbugs.sourceforge.net/reportingBugs.html</a></li>
+ </ul>
+ <p>
+ In particular,
+ the false-positive suppression heuristics for this
+ bug pattern have not been extensively tuned, so
+ reports about false positives are helpful to us.
+ </p>
+ <p>
+ See Weimer and Necula, <i>Finding and Preventing Run-Time Error Handling Mistakes</i>, for
+ a description of the analysis technique.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>This method may fail to clean up (close, dispose of) a stream, database object, or other resource requiring an
+explicit cleanup operation.<br/>In general, if a method opens a stream or other resource, the method should use a try/finally block to ensure
+that the stream or resource is cleaned up before the method returns.<p/>
+<p>This bug pattern is essentially the same as the OS_OPEN_STREAM and ODR_OPEN_DATABASE_RESOURCE bug patterns, but is based on a different
+(and hopefully better) static analysis technique. See Weimer and Necula, Finding and Preventing Run-Time Error Handling Mistakes, for a
+description of the analysis technique. .</p>
\ No newline at end of file
--- /dev/null
+<p> The method creates a database resource (such as a database connection
+or row set), does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+the object on all paths out of the method. Failure to
+close database resources on all paths out of a method may
+result in poor performance, and could cause the application to
+have problems communicating with the database.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The method creates a database resource (such as a database connection
+or row set), does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+the object on all exception paths out of the method. Failure to
+close database resources on all paths out of a method may
+result in poor performance, and could cause the application to
+have problems communicating with the database.</p>
\ No newline at end of file
--- /dev/null
+<p> The method creates an IO stream object, does not assign it to any
+fields, pass it to other methods that might close it,
+or return it, and does not appear to close
+the stream on all paths out of the method. This may result in
+a file descriptor leak. It is generally a good
+idea to use a <code>finally</code> block to ensure that streams are
+closed.</p>
\ No newline at end of file
--- /dev/null
+<p> The method creates an IO stream object, does not assign it to any
+fields, pass it to other methods, or return it, and does not appear to close
+it on all possible exception paths out of the method.
+This may result in a file descriptor leak. It is generally a good
+idea to use a <code>finally</code> block to ensure that streams are
+closed.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This class uses synchronization along with wait(), notify() or notifyAll() on itself (the this
+ reference). Client classes that use this class, may, in addition, use an instance of this class
+ as a synchronizing object. Because two classes are using the same object for synchronization,
+ Multithread correctness is suspect. You should not synchronize nor call semaphore methods on
+ a public reference. Consider using a internal private member variable to control synchronization.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+The software uses an HTTP request parameter to construct a pathname that should be within a restricted directory,
+but it does not properly neutralize absolute path sequences such as "/abs/path" that can resolve to a location that is outside of that directory.
+
+See <a href="http://cwe.mitre.org/data/definitions/36.html">http://cwe.mitre.org/data/definitions/36.html</a> for more information.
+</p>
+
+<p>
+FindBugs looks only for the most blatant, obvious cases of absolute path traversal.
+If FindBugs found <em>any</em>, you <em>almost certainly</em> have more
+vulnerabilities that FindBugs doesn't report. If you are concerned about absolute path traversal, you should seriously
+consider using a commercial static analysis or pen-testing tool.
+</p>
--- /dev/null
+<p>
+The software uses an HTTP request parameter to construct a pathname that should be within a restricted directory,
+but it does not properly neutralize sequences such as ".." that can resolve to a location that is outside of that directory.
+
+See <a href="http://cwe.mitre.org/data/definitions/23.html">http://cwe.mitre.org/data/definitions/23.html</a> for more information.</p>
+
+<p>
+FindBugs looks only for the most blatant, obvious cases of relative path traversal.
+If FindBugs found <em>any</em>, you <em>almost certainly</em> have more
+vulnerabilities that FindBugs doesn't report. If you are concerned about relative path traversal, you should seriously
+consider using a commercial static analysis or pen-testing tool.
+</p>
--- /dev/null
+<p> It is often a better design to
+return a length zero array rather than a null reference to indicate that there
+are no results (i.e., an empty list of results).
+This way, no explicit check for null is needed by clients of the method.</p>
+
+<p>On the other hand, using null to indicate
+"there is no answer to this question" is probably appropriate.
+For example, <code>File.listFiles()</code> returns an empty list
+if given a directory containing no files, and returns null if the file
+is not a directory.</p>
\ No newline at end of file
--- /dev/null
+<p>The entrySet() method is allowed to return a view of the underlying Map in which an <code>Iterator</code>
+and <code>Map.Entry</code>. This clever idea was used in several Map implementations, but introduces the possibility of
+ nasty coding mistakes. If a map m returns such an iterator for an entrySet, then <code>c.addAll(m.entrySet())</code> will
+ go badly wrong. All of the Map implementations in OpenJDK 1.7 have been rewritten to avoid this, you should to.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method assigns a literal boolean value (true or false) to a boolean variable inside
+ an if or while expression. Most probably this was supposed to be a boolean comparison using
+ ==, not an assignment using =.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>Are you sure this for loop is incrementing the correct variable?
+ It appears that another variable is being initialized and checked
+ by the for loop.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a reference known to be non-null with another reference
+known to be null.</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a redundant comparison of two references known to
+both be definitely null.</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a redundant check of a known non-null value against
+the constant null.</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a redundant check of a known null value against
+the constant null.</p>
\ No newline at end of file
--- /dev/null
+<p> A value is checked here to see whether it is null, but this value can't
+be null because it was previously dereferenced and if it were null a null pointer
+exception would have occurred at the earlier dereference.
+Essentially, this code and the previous dereference
+disagree as to whether this value is allowed to be null. Either the check is redundant
+or the previous dereference is erroneous.</p>
\ No newline at end of file
--- /dev/null
+<p> This method compares two reference values using the == or != operator,
+where the correct way to compare instances of this type is generally
+with the equals() method. Examples of classes which should generally
+not be compared by reference are java.lang.Integer, java.lang.Float, etc.</p>
\ No newline at end of file
--- /dev/null
+This method compares a reference value to a constant using the == or != operator, where the correct way to compare instances of this type is generally with the equals() method. It is possible to create distinct instances that are equal but do not compare as == since they are different objects. Examples of classes which should generally not be compared by reference are java.lang.Integer, java.lang.Float, etc.
\ No newline at end of file
--- /dev/null
+This method compares two Boolean values using the == or != operator. Normally, there are only two Boolean values (Boolean.TRUE and Boolean.FALSE), but it is possible to create other Boolean objects using the new Boolean(b) constructor. It is best to avoid such objects, but if they do exist, then checking Boolean objects for equality using == or != will give results than are different than you would get using .equals(...)
\ No newline at end of file
--- /dev/null
+<p>
+ This method uses a try-catch block that catches Exception objects, but Exception is not
+ thrown within the try block, and RuntimeException is not explicitly caught. It is a common bug pattern to
+ say try { ... } catch (Exception e) { something } as a shorthand for catching a number of types of exception
+ each of whose catch blocks is identical, but this construct also accidentally catches RuntimeException as well,
+ masking potential bugs.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+The code here uses a regular expression that is invalid according to the syntax
+for regular expressions. This statement will throw a PatternSyntaxException when
+executed.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The code here uses <code>File.separator</code>
+where a regular expression is required. This will fail on Windows
+platforms, where the <code>File.separator</code> is a backslash, which is interpreted in a
+regular expression as an escape character. Amoung other options, you can just use
+<code>File.separatorChar=='\\' & "\\\\" : File.separator</code> instead of
+<code>File.separator</code>
+
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+A String function is being invoked and "." is being passed
+to a parameter that takes a regular expression as an argument. Is this what you intended?
+For example
+s.replaceAll(".", "/") will return a String in which <em>every</em>
+character has been replaced by a / character.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This class declares that it implements an interface that is also implemented by a superclass.
+ This is redundant because once a superclass implements an interface, all subclasses by default also
+ implement this interface. It may point out that the inheritance hierarchy has changed since
+ this class was created, and consideration should be given to the ownership of
+ the interface's implementation.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This method ignores the return value of one of the variants of
+ <code>java.io.InputStream.read()</code> which can return multiple bytes.
+ If the return value is not checked, the caller will not be able to correctly
+ handle the case where fewer bytes were read than the caller requested.
+ This is a particularly insidious kind of bug, because in many programs,
+ reads from input streams usually do read the full amount of data requested,
+ causing the program to fail only sporadically.</p>
\ No newline at end of file
--- /dev/null
+<p> This serializable class defines a <code>readObject()</code> which is
+ synchronized. By definition, an object created by deserialization
+ is only reachable by one thread, and thus there is no need for
+ <code>readObject()</code> to be synchronized. If the <code>readObject()</code>
+ method itself is causing the object to become visible to another thread,
+ that is an example of very dubious coding style.</p>
\ No newline at end of file
--- /dev/null
+<p> This method explicitly invokes <code>run()</code> on an object.
+ In general, classes implement the <code>Runnable</code> interface because
+ they are going to have their <code>run()</code> method invoked in a new thread,
+ in which case <code>Thread.start()</code> is the right method to call.</p>
\ No newline at end of file
--- /dev/null
+<p>A random value from 0 to 1 is being coerced to the integer value 0. You probably
+want to multiple the random value by something else before coercing it to an integer, or use the <code>Random.nextInt(n)</code> method.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This code generates a hashcode and then computes
+the absolute value of that hashcode. If the hashcode
+is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
+<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
+</p>
\ No newline at end of file
--- /dev/null
+<p> This code generates a random signed integer and then computes
+the absolute value of that random integer. If the number returned by the random number
+generator is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
+<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code invoked a compareTo or compare method, and checks to see if the return value is a specific
+value, such as 1 or -1. When invoking these methods, you should only check the sign of the result, not
+for any specific non-zero value. While many or most compareTo and compare methods only return -1, 0 or 1,
+some of them will return other values.</p>
\ No newline at end of file
--- /dev/null
+<p> The method invokes String.indexOf and checks to see if the result is positive or non-positive.
+ It is much more typical to check to see if the result is negative or non-negative. It is
+ positive only if the substring checked for occurs at some place other than at the beginning of
+ the String.</p>
\ No newline at end of file
--- /dev/null
+<p> The value returned by readLine is discarded after checking to see if the return
+value is non-null. In almost all situations, if the result is non-null, you will want
+to use that non-null value. Calling readLine again will give you a different line.</p>
\ No newline at end of file
--- /dev/null
+<p> This code creates an exception (or error) object, but doesn't do anything with it. For example,
+something like </p>
+<blockquote>
+<pre>
+if (x < 0)
+ new IllegalArgumentException("x must be nonnegative");
+</pre>
+</blockquote>
+<p>It was probably the intent of the programmer to throw the created exception:</p>
+<blockquote>
+<pre>
+if (x < 0)
+ throw new IllegalArgumentException("x must be nonnegative");
+</pre>
+</blockquote>
\ No newline at end of file
--- /dev/null
+<p>This code negatives the return value of a compareTo or compare method. This is a questionable or bad
+programming practice, since if the return value is Integer.MIN_VALUE, negating the return value won't
+negate the sign of the result. You can achieve the same intended result by reversing the order of the
+operands rather than by negating the results.</p>
\ No newline at end of file
--- /dev/null
+<p> This code computes a hashCode, and then computes
+the remainder of that value modulo another value. Since the hashCode
+can be negative, the result of the remainder operation
+can also be negative. </p>
+<p> Assuming you want to ensure that the result of your computation is nonnegative,
+you may need to change your code.
+If you know the divisor is a power of 2,
+you can use a bitwise and operator instead (i.e., instead of
+using <code>x.hashCode()%n</code>, use <code>x.hashCode()&(n-1)</code>.
+This is probably faster than computing the remainder as well.
+If you don't know that the divisor is a power of 2, take the absolute
+value of the result of the remainder operation (i.e., use
+<code>Math.abs(x.hashCode()%n)</code>
+</p>
\ No newline at end of file
--- /dev/null
+<p> This code generates a random signed integer and then computes
+the remainder of that value modulo another value. Since the random
+number can be negative, the result of the remainder operation
+can also be negative. Be sure this is intended, and strongly
+consider using the Random.nextInt(int) method instead.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The return value of this method should be checked. One common
+cause of this warning is to invoke a method on an immutable object,
+thinking that it updates the object. For example, in the following code
+fragment,</p>
+<blockquote>
+<pre>
+String dateString = getHeaderField(name);
+dateString.trim();
+</pre>
+</blockquote>
+<p>the programmer seems to be thinking that the trim() method will update
+the String referenced by dateString. But since Strings are immutable, the trim()
+function returns a new String value, which is being ignored here. The code
+should be corrected to: </p>
+<blockquote>
+<pre>
+String dateString = getHeaderField(name);
+dateString = dateString.trim();
+</pre>
+</blockquote>
\ No newline at end of file
--- /dev/null
+<p> The return value of this method should be checked. One common
+cause of this warning is to invoke a method on an immutable object,
+thinking that it updates the object. For example, in the following code
+fragment,</p>
+<blockquote>
+<pre>
+String dateString = getHeaderField(name);
+dateString.trim();
+</pre>
+</blockquote>
+<p>the programmer seems to be thinking that the trim() method will update
+the String referenced by dateString. But since Strings are immutable, the trim()
+function returns a new String value, which is being ignored here. The code
+should be corrected to: </p>
+<blockquote>
+<pre>
+String dateString = getHeaderField(name);
+dateString = dateString.trim();
+</pre>
+</blockquote>
\ No newline at end of file
--- /dev/null
+<p> This method returns a value that is not checked. The return value should be checked
+since it can indicate an unusual or unexpected function execution. For
+example, the <code>File.delete()</code> method returns false
+if the file could not be successfully deleted (rather than
+throwing an Exception).
+If you don't check the result, you won't notice if the method invocation
+signals unexpected behavior by returning an atypical return value.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code calls a method and ignores the return value. The return value is the same type as the type the
+method is invoked on, and from our analysis it looks like the return value might be important (e.g., like
+ignoring the return value of <code>String.toLowerCase()</code>).
+</p>
+<p>We are guessing that ignoring the return value might be a bad idea just from a simple analysis of the
+body of the method. You can use a <code>@CheckReturnValue</code> annotation to instruct FindBugs as to whether
+ignoring the return value of this method is important or acceptable.<p>
+<p>Please investigate this closely to decide whether it is OK to ignore the return value. </p>
\ No newline at end of file
--- /dev/null
+The putIfAbsent method is typically used to ensure that a single value is associated with a given key (the first value for which put if absent succeeds). If you ignore the return value and retain a reference to the value passed in, you run the risk of retaining a value that is not the one that is associated with the key in the map. If it matters which one you use and you use the one that isn't stored in the map, your program will behave incorrectly.
\ No newline at end of file
--- /dev/null
+<p>The code contains a conditional test is performed twice, one right after the other
+(e.g., <code>x == 0 || x == 0</code>). Perhaps the second occurrence is intended to be something else
+(e.g., <code>x == 0 || y == 0</code>).
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a double assignment of a field; e.g.
+</p>
+<pre>
+ int x,y;
+ public void foo() {
+ x = x = 17;
+ }
+</pre>
+<p>Assigning to a field twice is useless, and may indicate a logic error or typo.</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a self assignment of a field; e.g.
+</p>
+<pre>
+ int x;
+ public void foo() {
+ x = x;
+ }
+</pre>
+<p>Such assignments are useless, and may indicate a logic error or typo.</p>
\ No newline at end of file
--- /dev/null
+<p> This method compares a field with itself, and may indicate a typo or
+a logic error. Make sure that you are comparing the right things.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method performs a nonsensical computation of a field with another
+reference to the same field (e.g., x&x or x-x). Because of the nature
+of the computation, this operation doesn't seem to make sense,
+and may indicate a typo or
+a logic error. Double check the computation.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a double assignment of a local variable; e.g.
+</p>
+<pre>
+ public void foo() {
+ int x,y;
+ x = x = 17;
+ }
+</pre>
+<p>Assigning the same value to a variable twice is useless, and may indicate a logic error or typo.</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a self assignment of a local variable; e.g.</p>
+<pre>
+ public void foo() {
+ int x = 3;
+ x = x;
+ }
+</pre>
+<p>
+Such assignments are useless, and may indicate a logic error or typo.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This method contains a self assignment of a local variable, and there is a field with an identical name.
+Assignment appears to have been ; e.g.
+<pre>
+ int foo;
+ public void setFoo(int foo) {
+ foo = foo;
+ }
+</pre>
+The assignment is useless. Did you mean to assign to the field instead?</p>
\ No newline at end of file
--- /dev/null
+<p> This method compares a local variable with itself, and may indicate a typo or
+a logic error. Make sure that you are comparing the right things.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method performs a nonsensical computation of a local variable with another
+reference to the same variable (e.g., x&x or x-x). Because of the nature
+of the computation, this operation doesn't seem to make sense,
+and may indicate a typo or
+a logic error. Double check the computation.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The method seems to be building a String using concatenation in a loop.
+In each iteration, the String is converted to a StringBuffer/StringBuilder,
+ appended to, and converted back to a String.
+ This can lead to a cost quadratic in the number of iterations,
+ as the growing string is recopied in each iteration. </p>
+
+<p>Better performance can be obtained by using
+a StringBuffer (or StringBuilder in Java 1.5) explicitly.</p>
+
+<p> For example:</p>
+<pre>
+ // This is bad
+ String s = "";
+ for (int i = 0; i < field.length; ++i) {
+ s = s + field[i];
+ }
+
+ // This is better
+ StringBuffer buf = new StringBuffer();
+ for (int i = 0; i < field.length; ++i) {
+ buf.append(field[i]);
+ }
+ String s = buf.toString();
+</pre>
\ No newline at end of file
--- /dev/null
+<p> The constructor starts a thread. This is likely to be wrong if
+ the class is ever extended/subclassed, since the thread will be started
+ before the subclass constructor is started.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This Serializable class defines a non-primitive instance field which is neither transient,
+ Serializable, or <code>java.lang.Object</code>, and does not appear to implement the <code>Externalizable</code>
+ interface or the <code>readObject()</code> and <code>writeObject()</code> methods.
+ Objects of this class will not be deserialized correctly if a non-Serializable object is stored in this field.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This Serializable class is an inner class of a non-serializable class.
+Thus, attempts to serialize it will also attempt to associate instance of the outer
+class with which it is associated, leading to a runtime error.
+</p>
+<p>If possible, making the inner class a static inner class should solve the
+problem. Making the outer class serializable might also work, but that would
+mean serializing an instance of the inner class would always also serialize the instance
+of the outer class, which it often not what you really want.
\ No newline at end of file
--- /dev/null
+<p> A non-serializable value is stored into a non-transient field
+of a serializable class.</p>
\ No newline at end of file
--- /dev/null
+<p> This class implements the <code>Comparator</code> interface. You
+should consider whether or not it should also implement the <code>Serializable</code>
+interface. If a comparator is used to construct an ordered collection
+such as a <code>TreeMap</code>, then the <code>TreeMap</code>
+will be serializable only if the comparator is also serializable.
+As most comparators have little or no state, making them serializable
+is generally easy and good defensive programming.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This Serializable class is an inner class. Any attempt to serialize
+it will also serialize the associated outer instance. The outer instance is serializable,
+so this won't fail, but it might serialize a lot more data than intended.
+If possible, making the inner class a static inner class (also known as a nested class) should solve the
+problem.
\ No newline at end of file
--- /dev/null
+<p> This class implements the <code>Serializable</code> interface, and defines a method
+ for custom serialization/deserialization. But since that method isn't declared private,
+ it will be silently ignored by the serialization/deserialization API.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a <code>serialVersionUID</code> field that is not final.
+ The field should be made final
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a <code>serialVersionUID</code> field that is not long.
+ The field should be made long
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a <code>serialVersionUID</code> field that is not static.
+ The field should be made static
+ if it is intended to specify
+ the version UID for purposes of serialization.</p>
\ No newline at end of file
--- /dev/null
+<p> This class implements the <code>Serializable</code> interface, but does
+ not define a <code>serialVersionUID</code> field.
+ A change as simple as adding a reference to a .class object
+ will add synthetic fields to the class,
+ which will unfortunately change the implicit
+ serialVersionUID (e.g., adding a reference to <code>String.class</code>
+ will generate a static field <code>class$java$lang$String</code>).
+ Also, different source code to bytecode compilers may use different
+ naming conventions for synthetic variables generated for
+ references to class objects or inner classes.
+ To ensure interoperability of Serializable across versions,
+ consider adding an explicit serialVersionUID.</p>
\ No newline at end of file
--- /dev/null
+<p> This class implements the <code>Serializable</code> interface
+ and its superclass does not. When such an object is deserialized,
+ the fields of the superclass need to be initialized by
+ invoking the void constructor of the superclass.
+ Since the superclass does not have one,
+ serialization and deserialization will fail at runtime.</p>
\ No newline at end of file
--- /dev/null
+<p> This class implements the <code>Externalizable</code> interface, but does
+ not define a void constructor. When Externalizable objects are deserialized,
+ they first need to be constructed by invoking the void
+ constructor. Since this class does not have one,
+ serialization and deserialization will fail at runtime.</p>
\ No newline at end of file
--- /dev/null
+<p> This class defines a private readResolve method. Since it is private, it won't be inherited by subclasses.
+This might be intentional and OK, but should be reviewed to ensure it is what is intended.
+</p>
\ No newline at end of file
--- /dev/null
+<p> In order for the readResolve method to be recognized by the serialization
+mechanism, it must not be declared as a static method.
+</p>
\ No newline at end of file
--- /dev/null
+<p> In order for the readResolve method to be recognized by the serialization
+mechanism, it must be declared to have a return type of Object.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class contains a field that is updated at multiple places in the class, thus it seems to be part of the state of the class. However, since the field is marked as transient and not set in readObject or readResolve, it will contain the default value in any
+deserialized instance of the class.
+</p>
\ No newline at end of file
--- /dev/null
+<p> The field is marked as transient, but the class isn't Serializable, so marking it as transient
+has absolutely no effect.
+This may be leftover marking from a previous version of the code in which the class was transient, or
+it may indicate a misunderstanding of how serialization works.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ A value stored in the previous switch case is overwritten here due
+ to a switch fall through. It is likely that you forgot to put a
+ break or return at the end of the previous case.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ A value stored in the previous switch case is ignored here due to a switch fall through to a place where an exception is thrown.
+ It is likely that you forgot to put a break or return at the end of the previous case.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method contains a switch statement where one case branch will fall
+ through to the next case. Usually you need to end this case with a break or return.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method contains a switch statement where default case is missing.
+ Usually you need to provide a default case.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This class is an inner class, but does not use its embedded reference
+ to the object which created it. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made static.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This class is an inner class, but does not use its embedded reference
+ to the object which created it. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made into a <em>static</em> inner class. Since anonymous inner
+classes cannot be marked as static, doing this will require refactoring
+the inner class so that it is a named inner class.</p>
\ No newline at end of file
--- /dev/null
+<p> This class is an inner class, but does not use its embedded reference
+ to the object which created it except during construction of the
+inner object. This reference makes the instances
+ of the class larger, and may keep the reference to the creator object
+ alive longer than necessary. If possible, the class should be
+ made into a <em>static</em> inner class. Since the reference to the
+ outer object is required during construction of the inner instance,
+ the inner class will need to be refactored so as to
+ pass a reference to the outer instance to the constructor
+ for the inner class.</p>
\ No newline at end of file
--- /dev/null
+This class is an inner class, but should probably be a static inner class. As it is, there is a serious danger of a deadly embrace between the inner class and the thread local in the outer class. Because the inner class isn't static, it retains a reference to the outer class. If the thread local contains a reference to an instance of the inner class, the inner and outer instance will both be reachable and not eligible for garbage collection.
\ No newline at end of file
--- /dev/null
+<p> Type check performed using the instanceof operator where it can be statically determined whether the object
+is of the type requested. </p>
\ No newline at end of file
--- /dev/null
+<p> The class's static initializer creates an instance of the class
+before all of the static final fields are assigned.</p>
\ No newline at end of file
--- /dev/null
+<p>This class is bigger than can be effectively handled, and was not fully analyzed for errors.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method spins in a loop which reads a field. The compiler
+ may legally hoist the read out of the loop, turning the code into an
+ infinite loop. The class should be changed so it uses proper
+ synchronization (including wait and notify calls).</p>
\ No newline at end of file
--- /dev/null
+<p> A call to a setXXX method of a prepared statement was made where the
+parameter index is 0. As parameter indexes start at index 1, this is always a mistake.</p>
\ No newline at end of file
--- /dev/null
+<p> A call to getXXX or updateXXX methods of a result set was made where the
+field index is 0. As ResultSet fields start at index 1, this is always a mistake.</p>
\ No newline at end of file
--- /dev/null
+<p>The method invokes the execute method on an SQL statement with a String that seems
+to be dynamically generated. Consider using
+a prepared statement instead. It is more efficient and less vulnerable to
+SQL injection attacks.
+</p>
\ No newline at end of file
--- /dev/null
+<p>The code creates an SQL prepared statement from a nonconstant String.
+If unchecked, tainted data from a user is used in building this String, SQL injection could
+be used to make the prepared statement do something unexpected and undesirable.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method ignores the return value of
+ <code>java.io.InputStream.skip()</code> which can skip multiple bytes.
+ If the return value is not checked, the caller will not be able to correctly
+ handle the case where fewer bytes were skipped than the caller requested.
+ This is a particularly insidious kind of bug, because in many programs,
+ skips from input streams usually do skip the full amount of data requested,
+ causing the program to fail only sporadically. With Buffered streams, however,
+ skip() will only skip data in the buffer, and will routinely fail to skip the
+ requested number of bytes.</p>
\ No newline at end of file
--- /dev/null
+<p> This class contains an instance final field that
+ is initialized to a compile-time static value.
+ Consider making the field static.</p>
\ No newline at end of file
--- /dev/null
+<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
+The detector has found a call to an instance of Calendar that has been obtained via a static
+field. This looks suspicous.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
\ No newline at end of file
--- /dev/null
+<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
+The detector has found a call to an instance of DateFormat that has been obtained via a static
+field. This looks suspicous.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
\ No newline at end of file
--- /dev/null
+<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
+Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
+application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see
+random ArrayIndexOutOfBoundsExceptions or IndexOutOfBoundsExceptions in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate().</p>
+<p>You may also experience serialization problems.</p>
+<p>Using an instance field is recommended.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
\ No newline at end of file
--- /dev/null
+<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
+Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
+application.</p>
+<p>You may also experience serialization problems.</p>
+<p>Using an instance field is recommended.</p>
+<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
+and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This method invokes the Thread.currentThread() call, just to call the interrupted() method. As interrupted() is a
+static method, is more simple and clear to use Thread.interrupted().
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+This method invokes the Thread.interrupted() method on a Thread object that appears to be a Thread object that is
+not the current thread. As the interrupted() method is static, the interrupted method will be called on a different
+object than the one the author intended.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This instance method writes to a static field. This is tricky to get
+correct if multiple instances are being manipulated,
+and generally bad practice.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method calls Thread.sleep() with a lock held. This may result
+ in very poor performance and scalability, or a deadlock, since other threads may
+ be waiting to acquire the lock. It is a much better idea to call
+ wait() on the lock, which releases the lock and allows other threads
+ to run.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>(<a href="http://java.sun.com/developer/JDCTechTips/2003/tt1208.html#1">From JDC Tech Tip</a>): The Swing methods
+show(), setVisible(), and pack() will create the associated peer for the frame.
+With the creation of the peer, the system creates the event dispatch thread.
+This makes things problematic because the event dispatch thread could be notifying
+listeners while pack and validate are still processing. This situation could result in
+two threads going through the Swing component-based GUI -- it's a serious flaw that
+could result in deadlocks or other related threading issues. A pack call causes
+components to be realized. As they are being realized (that is, not necessarily
+visible), they could trigger listener notification on the event dispatch thread.</p>
\ No newline at end of file
--- /dev/null
+<p> Waiting on a monitor while two locks are held may cause
+ deadlock.
+
+ Performing a wait only releases the lock on the object
+ being waited on, not any other locks.
+
+This not necessarily a bug, but is worth examining
+ closely.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ A value specified as carrying a type qualifier annotation is
+ consumed in a location or locations requiring that the value not
+ carry that annotation.
+ </p>
+
+ <p>
+ More precisely, a value annotated with a type qualifier specifying when=ALWAYS
+ is guaranteed to reach a use or uses where the same type qualifier specifies when=NEVER.
+ </p>
+
+ <p>
+ For example, say that @NonNegative is a nickname for
+ the type qualifier annotation @Negative(when=When.NEVER).
+ The following code will generate this warning because
+ the return statement requires a @NonNegative value,
+ but receives one that is marked as @Negative.
+ </p>
+ <blockquote>
+<pre>
+public @NonNegative Integer example(@Negative Integer value) {
+ return value;
+}
+</pre>
+ </blockquote>
\ No newline at end of file
--- /dev/null
+<p>
+A value specified as carrying a type qualifier annotation is
+compared with a value that doesn't ever carry that qualifier.
+</p>
+
+<p>
+More precisely, a value annotated with a type qualifier specifying when=ALWAYS
+is compared with a value that where the same type qualifier specifies when=NEVER.
+</p>
+
+<p>
+For example, say that @NonNegative is a nickname for
+the type qualifier annotation @Negative(when=When.NEVER).
+The following code will generate this warning because
+the return statement requires a @NonNegative value,
+but receives one that is marked as @Negative.
+</p>
+<pre>
+public boolean example(@Negative Integer value1, @NonNegative Integer value2) {
+ return value1.equals(value2);
+}
+</pre>
--- /dev/null
+<p>
+ A value is used in a way that requires it to be always be a value denoted by a type qualifier, but
+ there is an explicit annotation stating that it is not known where the value is required to have that type qualifier.
+ Either the usage or the annotation is incorrect.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ A value is used in a way that requires it to be never be a value denoted by a type qualifier, but
+ there is an explicit annotation stating that it is not known where the value is prohibited from having that type qualifier.
+ Either the usage or the annotation is incorrect.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ A value that is annotated as possibility not being an instance of
+ the values denoted by the type qualifier, and the value is guaranteed to be used
+ in a way that requires values denoted by that type qualifier.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ A value that is annotated as possibility being an instance of
+ the values denoted by the type qualifier, and the value is guaranteed to be used
+ in a way that prohibits values denoted by that type qualifier.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ A value specified as not carrying a type qualifier annotation is guaranteed
+ to be consumed in a location or locations requiring that the value does
+ carry that annotation.
+ </p>
+
+ <p>
+ More precisely, a value annotated with a type qualifier specifying when=NEVER
+ is guaranteed to reach a use or uses where the same type qualifier specifies when=ALWAYS.
+ </p>
+
+ <p>
+ TODO: example
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a useless control flow statement, where
+control flow continues onto the same place regardless of whether or not
+the branch is taken. For example,
+this is caused by having an empty statement
+block for an <code>if</code> statement:</p>
+<pre>
+ if (argv.length == 0) {
+ // TODO: handle this case
+ }
+</pre>
\ No newline at end of file
--- /dev/null
+<p> This method contains a useless control flow statement in which control
+flow follows to the same or following line regardless of whether or not
+the branch is taken.
+Often, this is caused by inadvertently using an empty statement as the
+body of an <code>if</code> statement, e.g.:</p>
+<pre>
+ if (argv.length == 1);
+ System.out.println("Hello, " + argv[0]);
+</pre>
\ No newline at end of file
--- /dev/null
+<p> This class contains similarly-named get and set
+ methods where the set method is synchronized and the get method is not.
+ This may result in incorrect behavior at runtime, as callers of the get
+ method will not necessarily see a consistent state for the object.
+ The get method should be made synchronized.</p>
\ No newline at end of file
--- /dev/null
+<p>Calling <code>this.getClass().getResource(...)</code> could give
+results other than expected if this class is extended by a class in
+another package.</p>
\ No newline at end of file
--- /dev/null
+<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
+but does not release it on all paths out of the method. In general, the correct idiom
+for using a JSR-166 lock is:
+</p>
+<pre>
+ Lock l = ...;
+ l.lock();
+ try {
+ // do something
+ } finally {
+ l.unlock();
+ }
+</pre>
\ No newline at end of file
--- /dev/null
+<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
+but does not release it on all exception paths out of the method. In general, the correct idiom
+for using a JSR-166 lock is:
+</p>
+<pre>
+ Lock l = ...;
+ l.lock();
+ try {
+ // do something
+ } finally {
+ l.unlock();
+ }
+</pre>
\ No newline at end of file
--- /dev/null
+<p> This anonymous class defined a method that is not directly invoked and does not override
+a method in a superclass. Since methods in other classes cannot directly invoke methods
+declared in an anonymous class, it seems that this method is uncallable. The method
+might simply be dead code, but it is also possible that the method is intended to
+override a method declared in a superclass, and due to an typo or other error the method does not,
+in fact, override the method it is intended to.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This method uses a static method from java.lang.Math on a constant value. This method's
+result in this case, can be determined statically, and is faster and sometimes more accurate to
+just use the constant. Methods detected are:
+</p>
+<table>
+<tr>
+ <th>Method</th> <th>Parameter</th>
+</tr>
+<tr>
+ <td>abs</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>acos</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>asin</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>atan</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>atan2</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>cbrt</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>ceil</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>cos</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>cosh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>exp</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>expm1</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>floor</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>log</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>log10</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>rint</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>round</td> <td>-any-</td>
+</tr>
+<tr>
+ <td>sin</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>sinh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>sqrt</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>tan</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>tanh</td> <td>0.0</td>
+</tr>
+<tr>
+ <td>toDegrees</td> <td>0.0 or 1.0</td>
+</tr>
+<tr>
+ <td>toRadians</td> <td>0.0</td>
+</tr>
+</table>
\ No newline at end of file
--- /dev/null
+<p>
+ This method invokes the .equals(Object o) method on a final class that doesn't override the equals method
+ in the Object class, effectively making the equals method test for sameness, like ==. It is good to use
+ the .equals method, but you should consider adding an .equals method in this class.
+ </p>
+ <p>[Bill Pugh]: Sorry, but I strongly disagree that this should be a warning, and I think your code
+ is just fine. Users of your code shouldn't care how you've implemented equals(), and they should never
+ depend on == to compare instances, since that bypasses the libraries ability to control how objects
+ are compared.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This private method is never called. Although it is
+possible that the method will be invoked through reflection,
+it is more likely that the method is never used, and should be
+removed.
+</p>
\ No newline at end of file
--- /dev/null
+<p> This field is never read. Consider removing it from the class.</p>
\ No newline at end of file
--- /dev/null
+<p>This field is never read. The field is public or protected, so perhaps it is intended to be
+used with classes not seen as part of the analysis. If not, consider removing it from the class.</p>
\ No newline at end of file
--- /dev/null
+<p> This constructor reads a field which has not yet been assigned a value.
+ This is often caused when the programmer mistakenly uses the field instead
+ of one of the constructor's parameters.</p>
\ No newline at end of file
--- /dev/null
+<p>This method is invoked in the constructor of of the superclass. At this point, the fields of the class have not yet initialized. To make this more concrete, consider the following classes:</p>
+<pre>
+ abstract class A {
+ int hashCode;
+ abstract Object getValue();
+ A() {
+ hashCode = getValue().hashCode();
+ }
+ }
+ class B extends A {
+ Object value;
+ B(Object v) {
+ this.value = v;
+ }
+ Object getValue() {
+ return value;
+ }
+ }
+</pre>
+<p>When a B is constructed, the constructor for the A class is invoked before the constructor for B sets value. Thus, when the constructor for A invokes getValue, an uninitialized value is read for value.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This abstract method is already defined in an interface that is implemented by this abstract
+ class. This method can be removed, as it provides no additional value.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+ This derived method merely calls the same superclass method passing in the exact parameters
+ received. This method can be removed, as it provides no additional value.
+ </p>
\ No newline at end of file
--- /dev/null
+<p> This field is never used. Consider removing it from the class.</p>
\ No newline at end of file
--- /dev/null
+<p>This field is never used. The field is public or protected, so perhaps it is intended to be used
+with classes not seen as part of the analysis. If not, consider removing it from the class.</p>
\ No newline at end of file
--- /dev/null
+<p>This field is never initialized within any constructor, and is therefore could be null after the object is constructed. This could be a either an error or a questionable design, since it means a null pointer exception will be generated if that field is dereferenced before being initialized.</p>
\ No newline at end of file
--- /dev/null
+<p> All writes to this field are of the constant value null, and thus
+all reads of the field will return null.
+Check for errors, or remove it if it is useless.</p>
\ No newline at end of file
--- /dev/null
+<p>This field is never written. All reads of it will return the default value. Check for errors (should it have been initialized?), or remove it if it is useless.</p>
\ No newline at end of file
--- /dev/null
+<p>No writes were seen to this public/protected field. All reads of it will return the default value.
+Check for errors (should it have been initialized?), or remove it if it is useless.</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a call to <code>java.lang.Object.wait()</code> which
+ is not guarded by conditional control flow. The code should
+ verify that condition it intends to wait for is not already satisfied
+ before calling wait; any previous notifications will be ignored.
+ </p>
\ No newline at end of file
--- /dev/null
+<p>
+A format-string method with a variable number of arguments is called,
+but the number of arguments passed does not match with the number of
+% placeholders in the format string. This is probably not what the
+author intended.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The format string placeholder is incompatible with the corresponding
+argument. For example,
+<code>
+ System.out.println("%d\n", "hello");
+</code>
+<p>The %d placeholder requires a numeric argument, but a string value is
+passed instead.
+A runtime exception will occur when
+this statement is executed.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+One of the arguments is uncompatible with the corresponding format string specifier.
+As a result, this will generate a runtime exception when executed.
+For example, <code>String.format("%d", "1")</code> will generate an exception, since
+the String "1" is incompatible with the format specifier %d.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+One of the arguments being formatted with a format string is an array. This will be formatted
+using a fairly useless format, such as [I@304282, which doesn't actually show the contents
+of the array.
+Consider wrapping the array using <code>Arrays.asList(...)</code> before handling it off to a formatted.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+An argument not of type Boolean is being formatted with a %b format specifier. This won't throw an
+exception; instead, it will print true for any nonnull value, and false for null.
+This feature of format strings is strange, and may not be what you intended.
+</p>
\ No newline at end of file
--- /dev/null
+A method is called that expects a Java printf format string and a list of arguments. However, the format string doesn't contain any format specifiers (e.g., %s) but does contain message format elements (e.g., {0}). It is likely that the code is supplying a MessageFormat string when a printf-style format string is required. At runtime, all of the arguments will be ignored and the format string will be returned exactly as provided without any formatting.
\ No newline at end of file
--- /dev/null
+<p>
+A format-string method with a variable number of arguments is called,
+but more arguments are passed than are actually used by the format string.
+This won't cause a runtime exception, but the code may be silently omitting
+information that was intended to be included in the formatted string.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The format string is syntactically invalid,
+and a runtime exception will occur when
+this statement is executed.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+Not enough arguments are passed to satisfy a placeholder in the format string.
+A runtime exception will occur when
+this statement is executed.
+</p>
\ No newline at end of file
--- /dev/null
+<p>
+The format string specifies a relative index to request that the argument for the previous format specifier
+be reused. However, there is no previous argument.
+For example,
+</p>
+<p><code>formatter.format("%<s %s", "a", "b")</code>
+</p>
+<p>would throw a MissingFormatArgumentException when executed.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This format string include a newline character (\n). In format strings, it is generally preferable
+better to use %n, which will produce the platform-specific line separator.</p>
\ No newline at end of file
--- /dev/null
+<p>
+This code passes a primitive array to a function that takes a variable number of object arguments.
+This creates an array of length one to hold the primitive array and passes it to the function.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code increments a volatile field. Increments of volatile fields aren't atomic. If more
+than one thread is incrementing the field at the same time, increments could be lost. </p>
\ No newline at end of file
--- /dev/null
+<p>This declares a volatile reference to an array, which might not be what
+you want. With a volatile reference to an array, reads and writes of
+the reference to the array are treated as volatile, but the array elements
+are non-volatile. To get volatile array elements, you will need to use
+one of the atomic array classes in java.util.concurrent (provided
+in Java 5.0).</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a call to <code>java.util.concurrent.await()</code>
+ (or variants)
+ which is not in a loop. If the object is used for multiple conditions,
+ the condition the caller intended to wait for might not be the one
+ that actually occurred.</p>
\ No newline at end of file
--- /dev/null
+<p> This method contains a call to <code>java.lang.Object.wait()</code>
+ which is not in a loop. If the monitor is used for multiple conditions,
+ the condition the caller intended to wait for might not be the one
+ that actually occurred.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This instance method synchronizes on <code>this.getClass()</code>. If this class is subclassed,
+ subclasses will synchronize on the class object for the subclass, which isn't likely what was intended.
+ For example, consider this code from java.awt.Label:
+ <pre>
+ private static final String base = "label";
+ private static int nameCounter = 0;
+ String constructComponentName() {
+ synchronized (getClass()) {
+ return base + nameCounter++;
+ }
+ }
+ </pre></p>
+ <p>Subclasses of <code>Label</code> won't synchronize on the same subclass, giving rise to a datarace.
+ Instead, this code should be synchronizing on <code>Label.class</code>
+ <pre>
+ private static final String base = "label";
+ private static int nameCounter = 0;
+ String constructComponentName() {
+ synchronized (Label.class) {
+ return base + nameCounter++;
+ }
+ }
+ </pre></p>
+ <p>Bug pattern contributed by Jason Mehrens</p>
\ No newline at end of file
--- /dev/null
+<p> This method accesses the value of a Map entry, using a key that was retrieved from
+a keySet iterator. It is more efficient to use an iterator on the entrySet of the map, to avoid the
+Map.get(key) lookup.</p>
\ No newline at end of file
--- /dev/null
+<p> This class has a <code>writeObject()</code> method which is synchronized;
+ however, no other method of the class is synchronized.</p>
\ No newline at end of file
--- /dev/null
+<p>
+ This method allocates a specific implementation of an xml interface. It is preferable to use
+ the supplied factory classes to create these objects so that the implementation can be
+ changed at runtime. See
+ </p>
+ <ul>
+ <li>javax.xml.parsers.DocumentBuilderFactory</li>
+ <li>javax.xml.parsers.SAXParserFactory</li>
+ <li>javax.xml.transform.TransformerFactory</li>
+ <li>org.w3c.dom.Document.create<i>XXXX</i></li>
+ </ul>
+ <p>for details.</p>
\ No newline at end of file
--- /dev/null
+<p>This code directly writes an HTTP parameter to JSP output, which allows for a cross site scripting
+vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a>
+for more information.</p>
+<p>FindBugs looks only for the most blatant, obvious cases of cross site scripting.
+If FindBugs found <em>any</em>, you <em>almost certainly</em> have more cross site scripting
+vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously
+consider using a commercial static analysis or pen-testing tool.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code directly writes an HTTP parameter to a Server error page (using HttpServletResponse.sendError). Echoing this untrusted input allows
+for a reflected cross site scripting
+vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a>
+for more information.</p>
+<p>FindBugs looks only for the most blatant, obvious cases of cross site scripting.
+If FindBugs found <em>any</em>, you <em>almost certainly</em> have more cross site scripting
+vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously
+consider using a commercial static analysis or pen-testing tool.
+</p>
\ No newline at end of file
--- /dev/null
+<p>This code directly writes an HTTP parameter to Servlet output, which allows for a reflected cross site scripting
+vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a>
+for more information.</p>
+<p>FindBugs looks only for the most blatant, obvious cases of cross site scripting.
+If FindBugs found <em>any</em>, you <em>almost certainly</em> have more cross site scripting
+vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously
+consider using a commercial static analysis or pen-testing tool.
+</p>
\ No newline at end of file
+++ /dev/null
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck.name=Missing Override
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck.param.javaFiveCompatibility=When this property is true this check will only check classes, interfaces, etc. that do not contain the extends or implements keyword or are not anonymous classes. This means it only checks methods overridden from java.lang.Object Java 5 Compatibility mode severely limits this check. It is recommended to only use it on Java 5 source.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.name=Equals Avoid Null
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullCheck.param.ignoreEqualsIgnoreCase=whether to ignore String.equalsIgnoreCase() invocations. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck.name=Javadoc Package
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck.param.allowLegacy=If set then allow the use of a package.html file.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.name=Declaration Order
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck.name=Anon Inner Length
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.AnonInnerLengthCheck.param.max=maximum allowable number of lines. Default is 20.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.name=Executable Statement Count
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.param.max=the maximum threshold allowed. Default is 30.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ExecutableStatementCountCheck.param.tokens=members to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck.name=Whitespace After
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAfterCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.name=Illegal Token Text
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.param.message=Message which is used to notify about violations; if empty then the default message is used.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.param.tokens=tokens to check. Default value is empty.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.param.format=illegal pattern
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.param.ignoreCase=Controls whether to ignore case when matching. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck.name=Class Fan Out Complexity
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.ClassFanOutComplexityCheck.param.max=the maximum threshold allowed. Default is 20.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.MissingDeprecatedCheck.name=Missing Deprecated
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck.name=Outer Type Number
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.OuterTypeNumberCheck.param.max=maximum allowable number of outer types. Default is 1.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.DesignForExtensionCheck.name=Design For Extension
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck.name=Illegal Throws
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck.param.illegalClassNames=throw class names to reject
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalThrowsCheck.param.ignoredMethodNames=names of methods to ignore. Default is "finalize".
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.name=Avoid Star Import
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.param.excludes=packages where star imports are allowed. Note that this property is not recursive, subpackages of excluded packages are not automatically excluded.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.param.allowClassImports=whether to allow starred class imports like <code>import java.util.*;</code>. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.param.allowStaticMemberImports=whether to allow starred static member imports like <code>import static org.junit.Assert.*;</code>. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck.name=Illegal Catch
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck.param.illegalClassNames=exception class names to reject
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck.name=Typecast Paren Pad
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck.param.option=policy on how to pad parentheses
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck.name=Avoid Static Import
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck.param.excludes=Allows for certain classes via a star notation to be excluded such as java.lang.Math.* or specific static members to be excluded like java.lang.System.out for a variable or java.lang.Math.random for a method. If you exclude a starred import on a class this automatically excludes each member individually. For example: Excluding java.lang.Math.*. will allow the import of each static member in the Math class individually like java.lang.Math.PI.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.name=Return Count
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.param.format=method names to ingone
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ReturnCountCheck.param.max=maximum allowed number of return statments
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck.name=Multiple String Literals
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck.param.ignoreStringsRegexp=regexp pattern for ignored strings (with quotation marks)
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck.param.ignoreOccurrenceContext=Token type names where duplicate strings are ignored even if they don't match ignoredStringsRegexp. This allows you to exclude syntactical contexts like Annotations or static initializers from the check.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleStringLiteralsCheck.param.allowedDuplicates=The maximum number of occurences to allow without generating a warning. Default is 1.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.name=Require This
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.param.checkFields=whether we should check fields usage or not. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RequireThisCheck.param.checkMethods=whether we should check methods usage or not. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.name=Right Curly
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.param.tokens=blocks to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck.param.option=policy on placement of a right curly brace ('}')
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.UnnecessaryParenthesesCheck.name=Unnecessary Parentheses
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck.name=Illegal Token
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenCheck.param.tokens=tokens to check. Default value is LITERAL_SWITCH, POST_INC, POST_DEC.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck.name=Parameter Number
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck.param.tokens=declarations to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck.param.max=maximum allowable number of parameters. Default is 7.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck.name=No Whitespace Before
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck.param.allowLineBreaks=whether whitespace is allowed if the token is at a linebreak. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MissingSwitchDefaultCheck.name=Missing Switch Default
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.name=Regexp
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.duplicateLimit=Controls whether to check for duplicates of a required pattern, any negative value means no checking for duplicates, any positive value is used as the maximum number of allowed duplicates, if the limit is exceeded errors will be logged. Default is -1.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.message=message which is used to notify about violations, if empty then default(hard-coded) message is used.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.format=pattern
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.ignoreComments=Controls whether to ignore matches found within comments. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.illegalPattern=Controls whether the pattern is required or illegal. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.RegexpCheck.param.errorLimit=Controls the maximum number of errors before the check will abort. Default is 100.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.name=Javadoc Method
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.tokens=definitions to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingReturnTag=whether to ignore errors when a method returns non-void type does have a return tag in the javadoc. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingThrowsTags=whether to ignore errors when a method declares that it throws exceptions but does have matching throws tags in the javadoc. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowThrowsTagsForSubclasses=whether to allow documented exceptions that are subclass of one of declared exception. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingJavadoc=whether to ignore errors when a method javadoc is missed. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingParamTags=whether to ignore errors when a method has parameters but does not have matching param tags in the javadoc. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.scope=visibility scope where Javadoc comments are checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowMissingPropertyJavadoc=Whether to allow missing Javadoc on accessor methods for properties (setters and getters). The setter and getter methods must match exactly the structures below. <code> public void setNumber(final int number) { mNumber = number; } public int getNumber() { return mNumber; } public boolean isSomething() { return false; } </code>. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.allowUndeclaredRTE=whether to allow documented exceptions that are not declared if they are a subclass of java.lang.RuntimeException. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.param.suppressLoadErrors=When set to false all problems with loading classes would be reported as violations. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.name=Regexp Singleline Java
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.ignoreCase=Controls whether to ignore case when searching. Default value is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.ignoreComments=Controls whether to ignore text in comments when searching. Default value is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.maximum=The maximum number of matches required in each file. Default value is 0.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.format=illegal pattern. Default value is ^$ (empty).
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.minimum=The minimum number of matches required in each file. Default value is 0.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineJavaCheck.param.message=message which is used to notify about violations, if empty then default(hard-coded) message is used. Default value is "" (empty).
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ParameterAssignmentCheck.name=Parameter Assignment
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.name=Javadoc Variable
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.param.scope=visibility scope where Javadoc comments are checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck.name=Illegal Instantiation
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck.param.classes=classes that should not be instantiated
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck.name=Method Length
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck.param.countEmpty=whether to count empty lines and single line comments of the form //. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck.param.max=maximum allowable number of lines. Default is 150.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodLengthCheck.param.tokens=blocks to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.HideUtilityClassConstructorCheck.name=Hide Utility Class Constructor
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ModifiedControlVariableCheck.name=Modified Control Variable
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.name=Magic Number
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.param.ignoreNumbers=non-magic numbers. Default is -1,0,1,2.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.param.ignoreHashCodeMethod=ignore magic numbers in hashCode methods. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MagicNumberCheck.param.ignoreAnnotation=ignore magic numbers in annotation declarations. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck.name=Header
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck.param.header=the required header specified inline. Individual header lines must be separated by the string "\n" (even on platforms with a different line separator)
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck.param.ignoreLines=comma-separated list of line numbers to ignore
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.AvoidInlineConditionalsCheck.name=Avoid Inline Conditionals
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck.name=Nested Try Depth
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedTryDepthCheck.param.max=allowed nesting depth. Default is 1.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck.name=Trailing Comment
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck.param.legalComment=pattern for text of trailing comment which is allowed. (this patter will not be applied to multiline comments and text of comment will be trimmed before matching)
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TrailingCommentCheck.param.format=pattern for string allowed before comment.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ParameterNameCheck.name=Parameter Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck.name=Redundant Modifier
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck.name=Empty For Initializer Pad
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForInitializerPadCheck.param.option=policy on how to pad an empty for iterator
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.name=Javadoc Style
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.checkHtml=Whether to check for incomplete html tags. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.scope=visibility scope where Javadoc comments are checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.checkEmptyJavadoc=Whether to check if the Javadoc is missing a describing text. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.tokens=definitions to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.param.checkFirstSentence=Whether to check the first sentence for proper end of sentence. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.name=Line Length
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.param.ignorePattern=pattern for lines to ignore
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.param.tabWidth=number of expanded spaces for a tab character. Default is 8.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.LineLengthCheck.param.max=maximum allowable line length. Default is 80.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.name=Regexp Multiline
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.minimum=The minimum number of matches required in each file. Default value is 0.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.message=message which is used to notify about violations, if empty then default(hard-coded) message is used. Default value is "" (empty).
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.ignoreCase=Controls whether to ignore case when searching. Default value is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.format=illegal pattern. Default value is ^$ (empty).
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck.param.maximum=The maximum number of matches required in each file. Default value is 0.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck.name=File Tab Character
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.FileTabCharacterCheck.param.eachLine=whether to report on each line containing a tab, or just the first instance. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.name=Unused Imports
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.UnusedImportsCheck.param.processJavadoc=whether to process Javadoc. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanExpressionCheck.name=Simplify Boolean Expression
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck.name=Uncommented Main
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck.param.excludedClasses=pattern for qualified names of classes which are allowed to have a main method.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck.name=Local Variable Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck.param.tokens=Controls whether the check applies to variable declarations or catch clause parameters
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck.name=Interface Is Type
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.InterfaceIsTypeCheck.param.allowMarkerInterfaces=Controls whether marker interfaces like Serializable are allowed. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.name=NPath Complexity
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.NPathComplexityCheck.param.max=the maximum threshold allowed. Default is 200.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.SimplifyBooleanReturnCheck.name=Simplify Boolean Return
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DoubleCheckedLockingCheck.name=Double Checked Locking
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck.name=Cyclomatic Complexity
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.CyclomaticComplexityCheck.param.max=the maximum threshold allowed. Default is 10.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.name=Annotation Use Style
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.param.closingParens=Defines the policy for ending parenthesis. Default is never.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.param.elementStyle=Defines the annotation element styles. Default value is compact_no_array.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationUseStyleCheck.param.trailingArrayComma=Defines the policy for trailing comma in arrays. Default is never.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck.name=Paren Pad
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck.param.option=policy on how to pad parentheses
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck.name=Method Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck.param.allowClassName=Controls whether to allow a method name to have the same name as the residing class name. This is not to be confused with a constructor. An easy mistake is to place a return type on a constructor declaration which turns it into a method.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.modifier.ModifierOrderCheck.name=Modifier Order
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ExplicitInitializationCheck.name=Explicit Initialization
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.name=Static Variable Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.param.applyToProtected=Controls whether to apply the check to protected member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.param.applyToPrivate=Controls whether to apply the check to private member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.param.applyToPackage=Controls whether to apply the check to package-private member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.StaticVariableNameCheck.param.applyToPublic=Controls whether to apply the check to public member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck.name=Empty Statement
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.name=Illegal Type
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.ignoredMethodNames=methods that should not be checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.illegalClassNames=classes that should not be used as types in variable declarations, return values or parameters.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.legalAbstractClassNames=abstract classes that may be used as types.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.format=pattern for illegal class name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalTypeCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck.name=Method Param Pad
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck.param.option=policy on how to pad method parameter. Default is nospace.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.MethodParamPadCheck.param.allowLineBreaks=whether a line break between the identifier and left parenthesis is allowed. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.name=Javadoc Type
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.authorFormat=pattern for @author tag
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.tokens=definitions to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.scope=visibility scope where Javadoc comments are checked
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.allowMissingParamTags=whether to ignore errors when a class has type parameters but does not have matching param tags in the javadoc. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.allowUnknownTags=whether to ignore errors when a Javadoc tag is not recognised. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck.param.versionFormat=pattern for @version tag
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck.name=Final Parameters
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck.param.tokens=blocks to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck.name=Empty For Iterator Pad
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.EmptyForIteratorPadCheck.param.option=policy on how to pad an empty for iterator
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck.name=Illegal Import
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck.param.illegalPkgs=packages to reject
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck.name=Comment pattern matcher
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck.param.format=Regular expression pattern to check. Default is TODO:
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MultipleVariableDeclarationsCheck.name=Multiple Variable Declarations
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck.name=Write Tag
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck.param.tagSeverity=Severity level when tag is found and printed. Default is info.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck.param.tagFormat=Format of tag
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck.param.tag=Name of tag
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck.name=Operator Wrap
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck.param.option=policy on how to wrap lines. 'nl' : the operator must be on a new line, 'eol' : the operator must be at the end of the line. Default is 'nl'.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.OperatorWrapCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck.name=Regexp Header
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck.param.header=The required header specified inline. Individual header lines must be separated by the string "\n" (even on platforms with a different line separator), and regular expressions must not span multiple lines.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.header.RegexpHeaderCheck.param.multiLines=Line numbers to repeat (zero or more times)
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DefaultComesLastCheck.name=Default Comes Last
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck.name=No Whitespace After
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck.param.allowLineBreaks=whether whitespace is allowed if the token is at a linebreak. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceAfterCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck.name=Throws Count
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.ThrowsCountCheck.param.max=maximum allowed number of throws statments
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck.name=Mutable Exception
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.MutableExceptionCheck.param.format=pattern for name of exception class.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck.name=Equals Hash Code
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.SuperFinalizeCheck.name=Super Finalize
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.name=Final Local Variable
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FinalLocalVariableCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck.name=Suppress Warnings
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck.param.format=The warnings property is a regex pattern. Any warning being suppressed matching this pattern will be flagged. Default is ^$|^\s+$
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.SuppressWarningsCheck.param.tokens=Tokens to check : CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF ENUM_CONSTANT_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, CTOR_DEF. Default value is LASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, ENUM_CONSTANT_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, CTOR_DEF.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.CovariantEqualsCheck.name=Covariant Equals
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck.name=Empty Block
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck.param.tokens=blocks to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck.param.option=policy on block contents
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.name=Boolean Expression Complexity
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.param.tokens=tokens to check. Default is LAND,BAND,LOR,BOR,BXOR.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.BooleanExpressionComplexityCheck.param.max=the maximum allowed number of boolean operations in one expression. Default is 3.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.RedundantImportCheck.name=Redundant import
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck.name=Package Annotation
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck.name=Array Type Style
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck.param.javaStyle=Controls whether to enforce Java style (true) or C style (false). Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.name=Indentation
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.param.tabWidth=number of expanded spaces for a tab character
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.param.caseIndent=how much to indent a case label
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.param.braceAdjustment=how far brace should be indented when on next line
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck.param.basicOffset=how many spaces to use for new indentation level
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck.name=Final Class
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck.name=Avoid Nested Blocks
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.AvoidNestedBlocksCheck.param.allowInSwitchCase=Allow nested blocks in case statements. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck.name=Need Braces
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck.param.tokens=blocks to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck.name=Abstract Class Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck.param.ignoreModifier=Controls whether to ignore checking for the abstract modifier on classes that match the name. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck.param.ignoreName=Controls whether to ignore checking the name. Realistically only useful if using the check to identify that match name and do not have the abstract modifier name. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.MissingCtorCheck.name=Missing Constructor
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck.name=Package Declaration
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.PackageDeclarationCheck.param.ignoreDirectoryName=whether to ignore checking that the package declaration matches the source directory name. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.name=JavaNCSS
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.param.classMaximum=the maximum allowed number of non commenting lines in a class. Default is 1500.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.param.methodMaximum=the maximum allowed number of non commenting lines in a method. Default is 50.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.JavaNCSSCheck.param.fileMaximum=the maximum allowed number of non commenting lines in a file including all top level and nested classes. Default is 2000.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.name=Hidden Field
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.ignoreSetter=Controls whether to ignore the parameter of a property setter method, where the property setter method for field 'xyz' has name 'setXyz', one parameter named 'xyz', and return type void. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.ignoreConstructorParameter=Controls whether to ignore constructor parameters. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.ignoreAbstractMethods=Controls whether to ignore parameters of abstract methods. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.ignoreFormat=pattern for names to ignore
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.HiddenFieldCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.name=Regexp Singleline
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.format=illegal pattern. Default value is ^$ (empty).
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.ignoreCase=Controls whether to ignore case when searching. Default value is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.message=message which is used to notify about violations, if empty then default(hard-coded) message is used. Default value is "" (empty).
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.maximum=The maximum number of matches required in each file. Default value is 0.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.regexp.RegexpSinglelineCheck.param.minimum=The minimum number of matches required in each file. Default value is 0.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck.name=File Length
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.FileLengthCheck.param.max=maximum allowable number of lines. Default is 2000.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck.name=Newline At End Of File
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck.param.fileExtensions=file type extension of the files to check.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck.param.lineSeparator=type of line separator. One of 'system' (system default), 'crlf' (Windows-style), 'cr' (Mac-style) and 'lf' (Unix-style).
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.name=Visibility Modifier
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.param.protectedAllowed=whether protected members are allowed. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.param.publicMemberPattern=pattern for public members that should be ignored. Default is ^serialVersionUID$.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.VisibilityModifierCheck.param.packageAllowed=whether package visible members are allowed. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.StringLiteralEqualityCheck.name=String Literal Equality
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck.name=Class Data Abstraction Coupling
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.metrics.ClassDataAbstractionCouplingCheck.param.max=the maximum threshold allowed. Default is 7.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck.name=Fall Through
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck.param.checkLastCaseGroup=Whether we need to check last case group or not. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.FallThroughCheck.param.reliefPattern=Regulare expression to match the relief comment that supresses the warning about a fall through.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck.name=Inner Assignment
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.InnerAssignmentCheck.param.tokens=assignments to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck.name=Strict Duplicate Code
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck.param.charset=name of the file charset
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.duplicates.StrictDuplicateCodeCheck.param.min=how many lines must be equal to be considered a duplicate. Default is 12.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.name=Import Order
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.separated=whether imports groups should be separated by, at least, one blank line. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.caseSensitive=whether string comparision should be case sensitive or not. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.groups=list of imports groups (every group identified either by a common prefix string, or by a regular expression enclosed in forward slashes (e.g. /regexp/)
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.option=policy on the relative order between regular imports and static imports. Values are top, above, inflow, under, bottom. See examples: http://checkstyle.sourceforge.net/property_types.html#importOrder
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck.param.ordered=whether imports within group should be sorted. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.name=Whitespace Around
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.param.tokens=tokens to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.param.allowEmptyConstructors=allow empty constructor bodies. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.WhitespaceAroundCheck.param.allowEmptyMethods=allow empty method bodies. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NoFinalizerCheck.name=No Finalizer
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.UpperEllCheck.name=Upper Ell
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck.name=Nested If Depth
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck.param.max=allowed nesting depth. Default is 1.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck.name=Package name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.name=Type Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.tokens=Control whether the check applies to classes or interfaces
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.applyToPackage=Controls whether to apply the check to package-private member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.applyToProtected=Controls whether to apply the check to protected member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.applyToPublic=Controls whether to apply the check to public member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.TypeNameCheck.param.applyToPrivate=Controls whether to apply the check to private member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.name=Constant Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.param.applyToProtected=Controls whether to apply the check to protected member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.param.applyToPackage=Controls whether to apply the check to package-private member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.param.applyToPublic=Controls whether to apply the check to public member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck.param.applyToPrivate=Controls whether to apply the check to private member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.SuperCloneCheck.name=Super Clone
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.name=Left Curly
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.param.maxLineLength=maximum number of characters in a line. Default is 80.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.param.tokens=blocks to check
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck.param.option=policy on placement of a left curly brace ('{'). eol : the brace must always be on the end of the line, nl : he brace must always be on a new line, nlow : ff the brace will fit on the first line of the statement, taking into account maximum line length, then apply eol rule. Otherwise apply the nl rule. nlow is a mnemonic for 'new line on wrap'.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.LocalFinalVariableNameCheck.name=Local Final Variable Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.name=Member name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.param.applyToPackage=Controls whether to apply the check to package-private member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.param.applyToPublic=Controls whether to apply the check to public member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.param.applyToPrivate=Controls whether to apply the check to private member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck.param.applyToProtected=Controls whether to apply the check to protected member
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck.name=Redundant Throws
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck.param.allowSubclasses=whether subclass of another declared exception is allowed in throws clause. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck.param.allowUnchecked=whether unchecked exceptions in throws are allowed or not. Default is false.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.RedundantThrowsCheck.param.suppressLoadErrors=When set to false all problems with loading classes would be reported as violations. Default is true.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck.name=Array Trailing Comma
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitespaceCheck.name=Generic Whitespace
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck.name=No Clone
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck.name=Inner Type Last
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck.name=Outer Type Filename
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck.name=Nested For Depth
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck.param.max=allowed nesting depth.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.name=Method Count
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxTotal=maximum allowable number of methods at all scope levels.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxPrivate=maximum allowable number of private methods.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxPackage=maximum allowable number of package methods.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxProtected=maximum allowable number of protected methods.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.param.maxPublic=maximum allowable number of public methods.
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.OneStatementPerLineCheck.name=One Statement Per Line
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck.name=Class Type Parameter Name
-rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.MethodTypeParameterNameCheck.name=Method Type Parameter Name
+++ /dev/null
-Checks the style of array type definitions. Some like Java-style: public static void main(String[] args) and some like C-style: public static void main(String args[])
\ No newline at end of file
+++ /dev/null
-Check that method/constructor/catch/foreach parameters are final.
\ No newline at end of file
+++ /dev/null
-Checks that there is a newline at the end of each file. Any source files and text files in general should end with a newline character, especially when using SCM systems such as CVS. CVS will even print a warning when it encounters a file that doesn't end with a newline.
\ No newline at end of file
+++ /dev/null
-Checks that the outer type name and the file name match. For example, the class Foo must be in a file named Foo.java.
+++ /dev/null
-A check that makes sure that a specified pattern exists (or not) in the file.
\ No newline at end of file
+++ /dev/null
-This rule allows to find any kind of pattern inside comments like TODO, NOPMD, ..., except NOSONAR
\ No newline at end of file
+++ /dev/null
-<p>
- The check to ensure that requires that comments be the only thing on a line. For the case of // comments that means that the only thing that should precede it is whitespace. It
- doesn't check comments if they do not end line, i.e. it accept the following: Thread.sleep( 10 <some comment here> ); Format property is intended to deal with the "} //
- while" example.
-</p>
-<p>
- Rationale: Steve McConnel in "Code Complete" suggests that endline comments are a bad practice. An end line comment would be one that is on the same line as actual code. For
- example:
-</p>
-<pre>
- <code>
- a = b + c; // Some insightful comment
- d = e / f; // Another comment for this line
- </code>
-</pre>
-
-<p>
- Quoting "Code Complete" for the justfication:
-</p>
-<ul>
- <li>"The comments have to be aligned so that they do not interfere with the visual structure of the code. If you don't align them neatly, they'll make your listing look like it's
- been through a washing machine."
- </li>
- <li>"Endline comments tend to be hard to format...It takes time to align them. Such time is not spent learning more about the code; it's dedicated solely to the tedious task of
- pressing the spacebar or tab key."
- </li>
- <li>"Endline comments are also hard to maintain. If the code on any line containing an endline comment grows, it bumps the comment farther out, and all the other endline comments
- will have to bumped out to match. Styles that are hard to maintain aren't maintained...."
- </li>
- <li>"Endline comments also tend to be cryptic. The right side of the line doesn't offer much room and the desire to keep the comment on one line means the comment must be short.
- Work
- then goes into making the line as short as possible instead of as clear as possible. The comment usually ends up as cryptic as possible...."
- </li>
- <li>"A systemic problem with endline comments is that it's hard to write a meaningful comment for one line of code. Most endline comments just repeat the line of code, which
- hurts
- more than it helps."
- </li>
-</ul>
-<p>
- His comments on being hard to maintain when the size of the line changes are even more important in the age of automated refactorings.
-</p>
\ No newline at end of file
+++ /dev/null
-Detects uncommented main methods.
\ No newline at end of file
+++ /dev/null
-Checks that long constants are defined with an upper ell. That is ' L' and not 'l'.
- This is in accordance to the Java Language Specification, <a href="http://java.sun.com/docs/books/jls/second_edition/html/lexical.doc.html#48282">Section 3.10.1</a>.
\ No newline at end of file
+++ /dev/null
-Controls the style with the usage of annotations.
\ No newline at end of file
+++ /dev/null
-Verifies that both the java.lang.Deprecated annotation is present and the @deprecated Javadoc tag is present when either is present.
\ No newline at end of file
+++ /dev/null
-Verifies that the java.lang.Override annotation is present when the {@inheritDoc} javadoc tag is present.
\ No newline at end of file
+++ /dev/null
-<p>This check makes sure that all package annotations are in the package-info.java file.</p>
-<p>According to the Java JLS 3rd ed.</p>
-<p>The JLS does not enforce the placement of package annotations. This placement may vary based on implementation. The JLS does highly recommend that all package annotations are placed in the package-info.java file. See <a href="http://java.sun.com/docs/books/jls/third_edition/html/j3TOC.html">Java Language specification, sections 7.4.1.1</a>.</p>
\ No newline at end of file
+++ /dev/null
-<p> This check allows you to specify what warnings that SuppressWarnings is not allowed to suppress. You can also specify a list of TokenTypes that the configured warning(s) cannot be suppressed on.</p>
-<p>Limitations: This check does not consider conditionals inside the SuppressWarnings annotation.
-For example: @SupressWarnings((false) ? (true) ? "unchecked" : "foo" : "unused") According to the above example, the "unused" warning is being suppressed not the "unchecked" or "foo" warnings. All of these warnings will be considered and matched against regardless of what the conditional evaluates to.</p>
\ No newline at end of file
+++ /dev/null
-Finds nested blocks.
\ No newline at end of file
+++ /dev/null
-Checks for empty blocks.
\ No newline at end of file
+++ /dev/null
-Checks for the placement of left curly braces for code blocks. The policy to verify is specified using property option. Policies <code>eol</code> and <code>nlow</code> take into account property maxLineLength.
\ No newline at end of file
+++ /dev/null
-Checks for braces around code blocks.
\ No newline at end of file
+++ /dev/null
-Checks the placement of right curly braces.
\ No newline at end of file
+++ /dev/null
-Checks if array initialization contains optional trailing comma.
\ No newline at end of file
+++ /dev/null
-Detects inline conditionals.
\ No newline at end of file
+++ /dev/null
-Checks that if a class defines a covariant method equals, then it defines method equals(java.lang.Object).
\ No newline at end of file
+++ /dev/null
-Checks that the parts of a class or interface declaration appear in the order suggested by the Code Convention for the Java Programming Language : <ul><li>Class (static) variables. First the public class variables, then the protected, then package level (no access modifier), and then the private.</li><li>Instance variables. First the public class variables, then the protected, then package level (no access modifier), and then the private.</li><li>Constructors</li><li>Methods</li></ul>
\ No newline at end of file
+++ /dev/null
-Check that the default is after all the cases in a switch statement.
\ No newline at end of file
+++ /dev/null
-Detect the double-checked locking idiom, a technique that tries to avoid synchronization overhead but is incorrect because of subtle artifacts of the java memory model.
\ No newline at end of file
+++ /dev/null
-Detects empty statements (standalone ';').
\ No newline at end of file
+++ /dev/null
-<p>Checks that any combination of String literals with optional assignment is on the left side of an equals() comparison.</p>
-<p>Rationale: Calling the equals() method on String literals will avoid a potential NullPointerException. Also, it is pretty common to see null check right before equals comparisons which is not necessary in the below example.</p>
-<p>For example:
-<pre>
- String nullString = null;
- nullString.equals("My_Sweet_String");
-</pre>
-</p>
-
-<p>
-should be refactored to:
-<pre>
- String nullString = null;
- "My_Sweet_String".equals(nullString);
-</pre>
-</p>
-<p>Limitations: If the equals method is overridden or a covariant equals method is defined and the implementation is incorrect (where s.equals(t) does not return the same result as t.equals(s)) then rearranging the called on object and parameter may have unexpected results.</p>
-<p>Java's Autoboxing feature has an affect on how this check is implemented. Pre Java 5 all IDENT + IDENT object concatenations would not cause a NullPointerException even if null. Those situations could have been included in this check. They would simply act as if they surrounded by String.valueof() which would concatenate the String null.</p>
-<p>The following example will cause a NullPointerException as a result of what autoboxing does.</p>
-<pre>
- Integer i = null, j = null;
- String number = "5"
- number.equals(i + j);
-</pre>
-<p>Since, it is difficult to determine what kind of Object is being concatenated all ident concatenation is considered unsafe.</p>
\ No newline at end of file
+++ /dev/null
-Checks that classes that override equals() also override hashCode().
\ No newline at end of file
+++ /dev/null
-Checks if any class or object member explicitly initialized to default for its type value (null for object references, zero for numeric types and char and false for boolean.
\ No newline at end of file
+++ /dev/null
-Checks for fall through in switch statements Finds locations where a case contains Java code - but lacks a break, return, throw or continue statement.
\ No newline at end of file
+++ /dev/null
-Ensures that local variables that never get their values changed, must be declared final.
\ No newline at end of file
+++ /dev/null
-Checks that a local variable or a parameter does not shadow a field that is defined in the same class.
\ No newline at end of file
+++ /dev/null
-Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException is almost never acceptable.
\ No newline at end of file
+++ /dev/null
-Checks for illegal instantiations where a factory method is preferred. Depending on the project, for some classes it might be preferable to create instances through factory methods rather than calling the constructor. A simple example is the <code>java.lang.Boolean</code> class. In order to save memory and CPU cycles, it is preferable to use the predefined constants TRUE and FALSE. Constructor invocations should be replaced by calls to <code>Boolean.valueOf()</code>. Some extremely performance sensitive projects may require the use of factory methods for other classes as well, to enforce the usage of number caches or object pools.
\ No newline at end of file
+++ /dev/null
-Throwing java.lang.Error or java.lang.RuntimeException is almost never acceptable.
\ No newline at end of file
+++ /dev/null
-Checks for illegal tokens. Certain language features often lead to hard to maintain code or are non-obvious to novice developers. Other features may be discouraged in certain frameworks, such as not having native methods in EJB components.
\ No newline at end of file
+++ /dev/null
-Checks for illegal token text.
\ No newline at end of file
+++ /dev/null
-Checks that particular class are never used as types in variable declarations, return values or parameters.
\ No newline at end of file
+++ /dev/null
-Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2);.
\ No newline at end of file
+++ /dev/null
-Checks for magic numbers.
\ No newline at end of file
+++ /dev/null
-Checks that classes (except abstract one) define a constructor and don't rely on the default one.
\ No newline at end of file
+++ /dev/null
-Checks that switch statement has default clause.
\ No newline at end of file
+++ /dev/null
-Check for ensuring that for loop control variables are not modified inside the for block.
\ No newline at end of file
+++ /dev/null
-Checks for multiple occurrences of the same string literal within a single file. Code duplication makes maintenance more difficult, so it can be better to replace the multiple occurrences with a constant.
\ No newline at end of file
+++ /dev/null
-Checks that each variable declaration is in its own statement and on its own line.
\ No newline at end of file
+++ /dev/null
-Restricts nested for blocks to a specified depth.
+++ /dev/null
-Restricts nested if-else blocks to a specified depth (default = 1).
\ No newline at end of file
+++ /dev/null
-Restricts nested try-catch-finally blocks to a specified depth (default = 1).
\ No newline at end of file
+++ /dev/null
-<p> Checks that the clone method is not overridden from the Object class.</p>
-
-<p>Rationale: The clone method relies on strange/hard to follow rules that do not work it all situations. Consequently, it is difficult to override correctly. Below are some of the rules/reasons why the clone method should be avoided.
-<ul>
- <li>Classes supporting the clone method should implement the Cloneable interface but the Cloneable interface does not include the clone method. As a result, it doesn't enforce the method override.</li>
- <li>The Cloneable interface forces the Object's clone method to work correctly. Without implementing it, the Object's clone method will throw a CloneNotSupportedException.</li>
- <li>Non-final classes must return the object returned from a call to super.clone().</li>
- <li>Final classes can use a constructor to create a clone which is different from non-final classes.</li>
- <li>If a super class implements the clone method incorrectly all subclasses calling super.clone() are doomed to failure.</li>
- <li>If a class has references to mutable objects then those object references must be replaced with copies in the clone method after calling super.clone().</li>
- <li>The clone method does not work correctly with final mutable object references because final references cannot be reassigned.</li>
- <li>If a super class overrides the clone method then all subclasses must provide a correct clone implementation.</li>
-</ul></p>
-<p>Two alternatives to the clone method, in some cases, is a copy constructor or a static factory method to return copies of an object. Both of these approaches are simpler and do not conflict with final fields. The do not force the calling client to handle a CloneNotSuportException. They also are typed therefore no casting is necessary. Finally, they are more flexible since they can take interface types rather than concrete classes.</p>
-
-<p>Sometimes a copy constructor or static factory is not an acceptable alternative to the clone method. The example below highlights the limitation of a copy constructor (or static factory). Assume Square is a subclass for Shape.</p>
-<p>
-<pre>
- Shape s1 = new Square();
- System.out.println(s1 instanceof Square); //true
-</pre></p>
-<p>...assume at this point the code knows nothing of s1 being a Square that's the beauty of polymorphism but the code wants to copy the Square which is declared as a Shape, its super type...</p>
-<p>
-<pre>
- Shape s2 = new Shape(s1); //using the copy constructor
- System.out.println(s2 instanceof Square); //false
-</pre></p>
-
-<p>The working solution (without knowing about all subclasses and doing many casts) is to do the following (assuming correct clone implementation).<br/>
-<pre>
- Shape s2 = s1.clone();
- System.out.println(s2 instanceof Square); //true
-</pre></p>
-
-<p>Just keep in mind if this type of polymorphic cloning is required then a properly implemented clone method may be the best choice.</p>
-
-<p>Much of this information was taken from Effective Java: Programming Language Guide First Edition by Joshua Bloch pages 45-52. Give Bloch credit for writing an excellent book.</p>
-
-<p>This check is almost exactly the same as the "No Finalizer Check".</p>
\ No newline at end of file
+++ /dev/null
-<p>Verifies there are no finalize() methods defined in a class.</p>
\ No newline at end of file
+++ /dev/null
-Checks there is only one statement per line. The following line will be flagged as an error: <code>x = 1; y = 2; // Two statments on a single line.</code>
+++ /dev/null
-Ensures there is a package declaration.
\ No newline at end of file
+++ /dev/null
-Disallow assignment of parameters.
\ No newline at end of file
+++ /dev/null
-Checks for redundant exceptions declared in throws clause such as duplicates, unchecked exceptions or subclasses of another declared exception.
\ No newline at end of file
+++ /dev/null
-Checks that code doesn't rely on the this default.
\ No newline at end of file
+++ /dev/null
-Restricts return statements to a specified count (default = 2).
\ No newline at end of file
+++ /dev/null
-Checks for overly complicated boolean expressions.
\ No newline at end of file
+++ /dev/null
-Checks for overly complicated boolean return statements.
\ No newline at end of file
+++ /dev/null
-Checks that string literals are not used with == or !=.
\ No newline at end of file
+++ /dev/null
-Checks that an overriding clone() method invokes super.clone().
\ No newline at end of file
+++ /dev/null
-Checks that an overriding finalize() method invokes super.finalize().
\ No newline at end of file
+++ /dev/null
-Checks if unnecessary parentheses are used in a statement or expression.
\ No newline at end of file
+++ /dev/null
-Checks that classes are designed for inheritance.
\ No newline at end of file
+++ /dev/null
-Checks that class which has only private constructors is declared as final.
\ No newline at end of file
+++ /dev/null
-Make sure that utility classes (classes that contain only static methods) do not have a public constructor.
\ No newline at end of file
+++ /dev/null
-Check nested (internal) classes/interfaces are declared at the bottom of the class after all method and field declarations.
+++ /dev/null
-Implements Bloch, Effective Java, Item 17 - Use Interfaces only to define types. According to Bloch, an interface should describe a type. It is therefore inappropriate to define an interface that does not contain any methods but only constants. The Standard class javax.swing.SwingConstants is an example of a class that would be flagged by this check. The check can be configured to also disallow marker interfaces like java.io.Serializable, that do not contain methods or constants at all.
\ No newline at end of file
+++ /dev/null
-Ensures that exceptions (defined as any class name conforming to some regular expression) are immutable.
\ No newline at end of file
+++ /dev/null
-Restricts throws statements to a specified count (default = 1).
\ No newline at end of file
+++ /dev/null
-Checks visibility of class members. Only static final members may be public; other class members must be private unless property protectedAllowed or packageAllowed is set.
\ No newline at end of file
+++ /dev/null
-Performs a line-by-line comparison of all code lines and reports duplicate code if a sequence of lines differs only in indentation.
\ No newline at end of file
+++ /dev/null
-<p>Checks that a source file begins with a specified header. Property headerFile specifies a file that contains the required header. Alternatively, the header specification can be set directly in the header property without the need for an external file.</p>
-<p>Property ignoreLines specifies the line numbers to ignore when matching lines in a header file. This property is very useful for supporting headers that contain copyright dates. For example, consider the following header:</p>
-<pre>
- line 1: ////////////////////////////////////////////////////////////////////
- line 2: // checkstyle:
- line 3: // Checks Java source code for adherence to a set of rules.
- line 4: // Copyright (C) 2002 Oliver Burn
- line 5: ////////////////////////////////////////////////////////////////////
-</pre>
-<p>Since the year information will change over time, you can tell Checkstyle to ignore line 4 by setting property ignoreLines to 4.</p>
\ No newline at end of file
+++ /dev/null
-<p>Checks the header of a source file against a header that contains a regular expression for each line of the source header.</p>
- <p>Rationale: In some projects checking against a fixed header is not sufficient, e.g. the header might require a copyright line where the year information is not static. For example, consider the following header:</p>
-<pre>
- line 1: ^/{71}$
- line 2: ^// checkstyle:$
- line 3: ^// Checks Java source code for adherence to a set of rules\.$
- line 4: ^// Copyright \(C\) \d\d\d\d Oliver Burn$
- line 5: ^// Last modification by \$Author.*\$$
- line 6: ^/{71}$
- line 7:
- line 8: ^package
- line 9:
- line 10: ^import
- line 11:
- line 12: ^/\*\*
- line 13: ^ \*([^/]|$)
- line 14: ^ \*/
-</pre>
-<p>Lines 1 and 6 demonstrate a more compact notation for 71 '/' characters. Line 4 enforces that the copyright notice includes a four digit year. Line 5 is an example how to enforce revision control keywords in a file header. Lines 12-14 is a template for javadoc (line 13 is so complicated to remove conflict with and of javadoc comment).</p>
-<p>Different programming languages have different comment syntax rules, but all of them start a comment with a non-word character. Hence you can often use the non-word character class to abstract away the concrete comment syntax and allow checking the header for different languages with a single header definition. For example, consider the following header specification (note that this is not the full Apache license header):</p>
-<pre>
- line 1: ^#!
- line 2: ^<\?xml.*>$
- line 3: ^\W*$
- line 4: ^\W*Copyright 2006 The Apache Software Foundation or its licensors, as applicable\.$
- line 5: ^\W*Licensed under the Apache License, Version 2\.0 \(the "License"\);$
- line 6: ^\W*$
-</pre>
-<p>Lines 1 and 2 leave room for technical header lines, e.g. the "#!/bin/sh" line in Unix shell scripts, or the xml file header of XML files. Set the multiline property to "1, 2" so these lines can be ignored for file types where they do no apply. Lines 3 through 6 define the actual header content. Note how lines 2, 4 and 5 use escapes for characters that have special regexp semantics.</p>
-<p>Note: ignoreLines property has been removed from this check to simplify it. To make some line optional use "^.*$" regexp for this line. </p>
\ No newline at end of file
+++ /dev/null
-Check that finds import statements that use the * notation.
\ No newline at end of file
+++ /dev/null
-<p> Checks that there are no static import statements. Rationale: Importing static members can lead to naming conflicts between class' members. It may lead to poor code readability since it may no longer be clear what class a member resides in (without looking at the import statement).</p>
\ No newline at end of file
+++ /dev/null
-Checks for imports from a set of illegal packages, like sun.*
\ No newline at end of file
+++ /dev/null
-Checks the ordering/grouping of imports. Features are:<ul>
- <li>groups imports: ensures that groups of imports come in a specific order (e.g., java. comes first, javax. comes second, then everything else)</li>
- <li>adds a separation between groups : ensures that a blank line sit between each group</li>
- <li>sorts imports inside each group: ensures that imports within each group are in lexicographic order</li>
- <li>sorts according to case: ensures that the comparison between imports is case sensitive</li>
- <li>groups static imports: ensures the relative order between regular imports and static imports</li>
- </ul>
\ No newline at end of file
+++ /dev/null
-Checks for redundant import statements. An import statement is considered redundant if:
-<ul>
- <li>It is a duplicate of another import. This is, when a class is imported more than once.</li>
- <li>The class imported is from the java.lang package, e.g. importing java.lang.String.</li>
- <li>The class imported is from the same package.</li></ul>
\ No newline at end of file
+++ /dev/null
-Checks for unused import statements.
\ No newline at end of file
+++ /dev/null
-Checks correct indentation of Java Code.
\ No newline at end of file
+++ /dev/null
-Checks the Javadoc of a method or constructor. By default, does not check for unused throws.
- To allow documented java.lang.RuntimeExceptions that are not declared, set property allowUndeclaredRTE to true.
- The scope to verify is specified using the Scope class and defaults to Scope.PRIVATE.
- To verify another scope, set property scope to a different scope.
-
- <br><br>Error messages about parameters and type parameters for which no param tags are present can be suppressed by defining property allowMissingParamTags.
- Error messages about exceptions which are declared to be thrown, but for which no throws tag is present can be suppressed by defining property allowMissingThrowsTags.
- Error messages about methods which return non-void but for which no return tag is present can be suppressed by defining property allowMissingReturnTag.
-
- <br><br>Javadoc is not required on a method that is tagged with the @Override annotation.
- However under Java 5 it is not possible to mark a method required for an interface (this was corrected under Java 6).
- Hence Checkstyle supports using the convention of using a single {@inheritDoc} tag instead of all the other tags.
-
- <br><br>Note that only inheritable items will allow the {@inheritDoc} tag to be used in place of comments.
- Static methods at all visibilities, private non-static methods and constructors are not inheritable.
\ No newline at end of file
+++ /dev/null
-<p>Checks that each Java package has a Javadoc file used for commenting. By default it only allows a package-info.java file, but can be configured to allow a package.html file. An error will be reported if both files exist as this is not allowed by the Javadoc tool.</p>
\ No newline at end of file
+++ /dev/null
-Validates Javadoc comments to help ensure they are well formed. The following checks are performed:
- <ul>
- <li>Ensures the first sentence ends with proper punctuation (That is a period, question mark, or exclamation mark, by default).
- Javadoc automatically places the first sentence in the method summary table and index. With out proper punctuation the Javadoc may be malformed.
- All items eligible for the {@inheritDoc} tag are exempt from this requirement.</li>
- <li>Check text for Javadoc statements that do not have any description.
- This includes both completely empty Javadoc, and Javadoc with only tags such as @param and @return.</li>
- <li>Check text for incomplete HTML tags. Verifies that HTML tags have corresponding end tags and issues an "Unclosed HTML tag found:" error if not.
- An "Extra HTML tag found:" error is issued if an end tag is found without a previous open tag.</li>
- <li>Check that a package Javadoc comment is well-formed (as described above) and NOT missing from any package-info.java files.</li>
- <li>Check for allowed HTML tags. The list of allowed HTML tags is "a", "abbr", "acronym", "address", "area", "b",
- "bdo", "big", "blockquote", "br", "caption", "cite", "code", "colgroup", "del", "div", "dfn", "dl", "em", "fieldset",
- "h1" to "h6", "hr", "i", "img", "ins", "kbd", "li", "ol", "p", "pre", "q", "samp", "small", "span", "strong",
- "sub", "sup", "table", "tbody", "td", "tfoot", "th", "thread", "tr", "tt", "ul"</li>
- </ul>
\ No newline at end of file
+++ /dev/null
-Checks Javadoc comments for class and interface definitions. By default, does not check for author or version tags.
- The scope to verify is specified using the Scope class and defaults to Scope.PRIVATE. To verify another scope, set property scope to one of the Scope constants.
- To define the format for an author tag or a version tag, set property authorFormat or versionFormat respectively to a regular expression.
- <br><br>Error messages about type parameters for which no param tags are present can be suppressed by defining property allowMissingParamTags.
\ No newline at end of file
+++ /dev/null
-Checks that a variable has Javadoc comment.
\ No newline at end of file
+++ /dev/null
-Outputs a JavaDoc tag as information. Can be used e.g. with the stylesheets that sort the report by author name. To define the format for a tag, set property tagFormat to a regular expression. This check uses two different severity levels. The normal one is used for reporting when the tag is missing. The additional one (tagSeverity) is used for the level of reporting when the tag exists.
\ No newline at end of file
+++ /dev/null
-Restricts nested boolean operators (&&, || and ^) to a specified depth (default = 3).
\ No newline at end of file
+++ /dev/null
-This metric measures the number of instantiations of other classes within the given class.
\ No newline at end of file
+++ /dev/null
-The number of other classes a given class relies on.
\ No newline at end of file
+++ /dev/null
-Checks cyclomatic complexity of methods against a specified limit. The complexity is measured by the number of if, while, do, for, ?:, catch, switch, case statements, and operators && and || (plus one) in the body of a constructor, method, static initializer, or instance initializer. It is a measure of the minimum number of possible paths through the source and therefore the number of required tests. Generally 1-4 is considered good, 5-7 ok, 8-10 consider re-factoring, and 11+ re-factor now !
\ No newline at end of file
+++ /dev/null
-Determines complexity of methods, classes and files by counting the Non Commenting Source Statements (NCSS). This check adheres to the specification for the JavaNCSS-Tool written by Chr. Clemens Lee.
-Rougly said the NCSS metric is calculated by counting the source lines which are not comments, (nearly) equivalent to counting the semicolons and opening curly braces.
-The NCSS for a class is summarized from the NCSS of all its methods, the NCSS of its nested classes and the number of member variable declarations.
-The NCSS for a file is summarized from the ncss of all its top level classes, the number of imports and the package declaration.
-<br>
-Rationale: Too large methods and classes are hard to read and costly to maintain. A large NCSS number often means that a method or class has too many responsabilities and/or functionalities which should be decomposed into smaller units.
\ No newline at end of file
+++ /dev/null
-Checks the npath complexity of a method against a specified limit (default = 200). The NPATH metric computes the number of possible execution paths through a function. It takes into account the nesting of conditional statements and multi-part boolean expressions (e.g., A && B, C || D, etc.).
\ No newline at end of file
+++ /dev/null
-Checks that the order of modifiers conforms to the suggestions in the Java Language specification, sections 8.1.1, 8.3.1 and 8.4.3. The correct order is : public, protected, private, abstract, static, final, transient, volatile, synchronized, native, strictfp.
\ No newline at end of file
+++ /dev/null
-Checks for redundant modifiers in interface and annotation definitions.
\ No newline at end of file
+++ /dev/null
-Checks that abstract class names conform to the specified format
\ No newline at end of file
+++ /dev/null
-Checks that class parameter names conform to the specified format
-
-<p>
-The following code snippet illustrates this rule for format "^[A-Z]$":
-</p>
-<pre>
-class Something<type> { // Non-compliant
-}
-
-class Something<T> { // Compliant
-}
-</pre>
+++ /dev/null
-Checks that constant names conform to the specified format
\ No newline at end of file
+++ /dev/null
-Checks that local final variable names, including catch parameters, conform to the specified format
\ No newline at end of file
+++ /dev/null
-Checks that local, non-final variable names conform to the specified format
\ No newline at end of file
+++ /dev/null
-Checks that name of non-static fields conform to the specified format
\ No newline at end of file
+++ /dev/null
-Checks that method names conform to the specified format
\ No newline at end of file
+++ /dev/null
-Checks that method type parameter names conform to the specified format
-
-<p>
-The following code snippet illustrates this rule for format "^[A-Z]$":
-</p>
-<pre>
-public <type> type method() { // Non-compliant
- return null;
-}
-
-public <T> T method() { // Compliant
-}
-</pre>
+++ /dev/null
-Checks that package names conform to the specified format. The default value of format
- has been chosen to match the requirements in the Java Language specification and the Sun coding conventions.
- However both underscores and uppercase letters are rather uncommon, so most configurations should probably
- assign value ^[a-z]+(\.[a-z][a-z0-9]*)*$ to format
\ No newline at end of file
+++ /dev/null
-Checks that parameter names conform to the specified format
\ No newline at end of file
+++ /dev/null
-Checks that static, non-final fields conform to the specified format
\ No newline at end of file
+++ /dev/null
-Checks that type names conform to the specified format
\ No newline at end of file
+++ /dev/null
-<p>A check for detecting that matches across multiple lines. Rationale: This check can be used to when the regular expression can be span multiple lines.</p>
\ No newline at end of file
+++ /dev/null
-<p> A check for detecting single lines that match a supplied regular expression. Works with any file type. Rationale: This check can be used to prototype checks and to find common bad practice such as calling ex.printStacktrace(), System.out.println(), System.exit(), etc.</p>
\ No newline at end of file
+++ /dev/null
-<p>This class is variation on RegexpSingleline for detecting single lines that match a supplied regular expression in Java files. It supports suppressing matches in Java comments.</p>
\ No newline at end of file
+++ /dev/null
-Checks for long anonymous inner classes.
\ No newline at end of file
+++ /dev/null
-Restricts the number of executable statements to a specified limit (default = 30).
\ No newline at end of file
+++ /dev/null
-<p>Checks for long source files.</p>
- <p>Rationale: If a source file becomes very long it is hard to understand. Therefore long classes should usually be refactored into several individual classes that focus on a specific task.</p>
\ No newline at end of file
+++ /dev/null
-Checks for long lines.
\ No newline at end of file
+++ /dev/null
-Checks the number of methods declared in each type. This includes the number of each scope (private, package, protected and public) as well as an overall total.
+++ /dev/null
-Checks for long methods.
\ No newline at end of file
+++ /dev/null
-<p> Checks for the number of types declared at the outer (or root) level in a file. Rationale: It is considered good practice to only define one outer type per file.</p>
\ No newline at end of file
+++ /dev/null
-Checks the number of parameters that a method or constructor has.
\ No newline at end of file
+++ /dev/null
-Checks the padding of an empty for initializer; that is whether a space is required at an empty for initializer, or such spaces are forbidden. Example : <code>for ( ; i < j; i++, j--)</code>
\ No newline at end of file
+++ /dev/null
-Checks the padding of an empty for iterator; that is whether a space is required at an empty for iterator, or such spaces are forbidden. Example : <code>for (Iterator foo = very.long.line.iterator(); foo.hasNext(); )</code>
\ No newline at end of file
+++ /dev/null
-<p>Checks that there are no tab characters ('\t') in the source code. Rationale:
-<ul>
- <li>Developers should not need to configure the tab width of their text editors in order to be able to read source code.</li>
- <li>From the Apache jakarta coding standards: In a distributed development environment, when the commit messages get sent to a mailing list, they are almost impossible to read if you use tabs.</li>
-</ul></p>
\ No newline at end of file
+++ /dev/null
-<p>Checks that the whitespace around the Generic tokens < and > is correct to the typical convention. The convention is not configurable.</p>
-<p>
-For example the following is legal:
-</p>
-<pre>
- List<Integer> x = new ArrayList<Integer>();
- List<List<Integer>> y = new ArrayList<List<Integer>>();
-</pre>
-<p>
-But the following example is not:
-</p>
-<pre>
- List < Integer > x = new ArrayList < Integer > ();
- List < List < Integer > > y = new ArrayList < List < Integer > > ();
-</pre>
\ No newline at end of file
+++ /dev/null
-Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation; and the left parenthesis of the parameter list.
\ No newline at end of file
+++ /dev/null
-Checks that there is no whitespace after a token.
\ No newline at end of file
+++ /dev/null
-Checks that there is no whitespace before a token.
\ No newline at end of file
+++ /dev/null
-Checks the policy on how to wrap lines on operators.
\ No newline at end of file
+++ /dev/null
-Checks the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden, with the exception that it does not check for padding of the right parenthesis at an empty for iterator.
\ No newline at end of file
+++ /dev/null
-Checks the padding of parentheses for typecasts.
\ No newline at end of file
+++ /dev/null
-Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator.
\ No newline at end of file
+++ /dev/null
-Checks that a token is surrounded by whitespace.
\ No newline at end of file
+++ /dev/null
-#------------------------------------------------------------------------------
-#
-# GENERIC WORDS, sorted alphabetically
-#
-#------------------------------------------------------------------------------
-
-action=Action
-active=Active
-add_verb=Add
-age=Age
-alerts=Alerts
-all=All
-and=And
-any=Any
-ascending=Ascending
-assignee=Assignee
-author=Author
-back=Back
-backup_verb=Backup
-blocker=Blocker
-bold=Bold
-build_date=Build date
-build_time=Build time
-calendar=Calendar
-cancel=Cancel
-category=Category
-changelog=Changelog
-change_verb=Change
-class=Class
-classes=Classes
-closed=Closed
-code=Code
-color=Color
-compare=Compare
-configure=Configure
-copy=Copy
-create=Create
-created=Created
-critical=Critical
-customize=Customize
-date=Date
-days=Days
-default=Default
-delete=Delete
-descending=Descending
-description=Description
-directories=Directories
-directory=Directory
-display=Display
-download_verb=Download
-edit=Edit
-events=Events
-false=False
-file=File
-files=Files
-filter_verb=Filter
-follow=Follow
-global=Global
-hide=Hide
-identifier_abbreviated=Id
-inactive=Inactive
-info=Info
-inheritance=Inheritance
-key=Key
-language=Language
-library=Library
-links=Links
-load_verb=Load
-login=Login
-major=Major
-max=Max
-me=Me
-min=Min
-minor=Minor
-more_actions=More actions
-name=Name
-none=None
-off=Off
-on=On
-open=Open
-open_verb=Open
-operations=Operations
-optional=Optional
-order=Order
-owner=Owner
-package=Package
-packages=Packages
-parameters=Parameters
-password=Password
-path=Path
-permalinks=Permalinks
-plugin=Plugin
-project=Project
-projects=Projects
-raw=Raw
-rename=Rename
-reset_verb=Reset
-result=Result
-results=Results
-x_results={0} results
-review=Review
-reviews=Reviews
-review_verb=Review
-rule=Rule
-rules=Rules
-save=Save
-search_verb=Search
-select_all=Select all
-select_verb=Select
-severity=Severity
-severity_abbreviated=Se.
-shared=Shared
-show_verb=Show
-size=Size
-status=Status
-status_abbreviated=St.
-sub_project=Sub-project
-sub_projects=Sub-projects
-sub_view=Sub-view
-sub_views=Sub-views
-table=Table
-template=Template
-title=Title
-to=To
-treemap=Treemap
-true=True
-unfollow=Unfollow
-unit_test=Unit test
-unit_tests=Unit tests
-unselect_all=Unselect all
-unselect_verb=Unselect
-updated=Updated
-update_verb=Update
-user=User
-value=Value
-variation=Variation
-version=Version
-view=View
-views=Views
-violations=Violations
-
-
-#------------------------------------------------------------------------------
-#
-# GENERIC EXPRESSIONS, sorted alphabetically
-#
-#------------------------------------------------------------------------------
-
-activate_all=Activate all
-add_a_column=Add a column
-added_over_x_days=Added over {0} days
-added_since=Added since {0}
-added_since_previous_analysis=Added since previous analysis
-added_since_previous_analysis_detailed=Added since previous analysis ({0})
-added_since_previous_version=Added since previous version
-added_since_previous_version_detailed=Added since previous version ({0})
-added_since_version=Added since version {0}
-alerts_feed=Alerts feed
-all_violations=All violations
-are_you_sure=Are you sure?
-assigned_to=Assigned to
-bulk_change=Bulk Change
-bulleted_point=Bulleted point
-coding_rules=Coding rules
-click_to_add_to_favourites=Click to add to favourites
-click_to_remove_from_favourites=Click to remove from favourites
-created_by=Created by
-deactivate_all=Deactivate all
-default_severity=Default severity
-default_sort_on=Default sort on
-delta_since_previous_analysis=Δ since previous analysis
-delta_since_previous_version=Δ since previous version
-delta_over_x_days=Δ over {0} days
-delta_since=Δ since {0}
-delta_since_version=Δ since version {0}
-disable_treemap=Disable treemap
-enable_treemap=Enable treemap
-equals=Equals
-false_positive=False-positive
-false_positives_only=False-positives only
-full_source=Full source
-greater_or_equals=Greater or equals
-greater_than=Greater than
-help_tips=Help tips
-less_or_equals=Less or equals
-less_than=Less than
-move_left=Move left
-move_right=Move right
-new_violations=New violations
-new_window=New window
-no_data=No data
-no_lines_match_your_filter_criteria=No lines match your filter criteria.
-no_results=No results
-over_x_days=over {0} days
-page_size=Page size
-paging_first=First
-paging_last=Last
-paging_next=Next
-paging_previous=Previous
-project_name=Project name
-remove_column=Remove this column
-results_not_display_due_to_security=Due to security settings, some results are not being displayed.
-save_and_close=Save & Close
-save_and_preview=Save & Preview
-select_a_metric=Select a metric
-set_as_default=Set as default
-shared_by=Shared by
-show_more=Show more
-since_x=since {0}
-since_previous_analysis=since previous analysis
-since_previous_analysis_detailed=since previous analysis ({0})
-since_version=since version {0}
-since_version_detailed=since version {0} ({1})
-since_previous_version=since previous version
-since_previous_version_detailed=since previous version ({0})
-time_changes=Time changes
-
-#------------------------------------------------------------------------------
-#
-# RESOURCE QUALIFIERS
-#
-#------------------------------------------------------------------------------
-
-qualifier.TRK=Project
-qualifier.BRC=Sub-project
-qualifier.DIR=Directory
-qualifier.PAC=Package
-qualifier.VW=View
-qualifier.SVW=Sub-view
-qualifier.FIL=File
-qualifier.CLA=File
-qualifier.UTS=Unit Test File
-
-qualifiers.TRK=Projects
-qualifiers.BRC=Sub-projects
-qualifiers.DIR=Directories
-qualifiers.PAC=Packages
-qualifiers.VW=Views
-qualifiers.SVW=Sub-views
-qualifiers.FIL=Files
-qualifiers.CLA=Files
-qualifiers.UTS=Unit Test Files
-
-
-#------------------------------------------------------------------------------
-#
-# PROJECT LINKS
-#
-#------------------------------------------------------------------------------
-
-project_links.homepage=Home
-project_links.ci=Continuous integration
-project_links.issue=Issues
-project_links.scm=Sources
-project_links.scm_ro=Read-only connection
-project_links.scm_dev=Developer connection
-
-
-#------------------------------------------------------------------------------
-#
-# EVENT CATEGORIES
-#
-#------------------------------------------------------------------------------
-
-event.category.Version=Version
-event.category.Alert=Alert
-event.category.Profile=Profile
-event.category.Other=Other
-
-
-#------------------------------------------------------------------------------
-#
-# LAYOUT
-#
-#------------------------------------------------------------------------------
-
-layout.home=Home
-layout.login=Log in
-layout.logout=Log out
-layout.configuration=Configuration
-layout.print=Print
-layout.permalink=Permalink
-layout.sonar.slogan=Embrace Quality
-layout.powered_by=Powered by
-layout.documentation=Documentation
-layout.ask_a_questions=Ask a question
-layout.plugins=Plugins
-layout.evaluation=Embedded database should be used for evaluation purpose only
-layout.ie6_warn=Your web browser is outdated. This website may not display correctly.
-
-sidebar.project_settings=Configuration
-sidebar.security=Security
-sidebar.system=System
-
-
-#------------------------------------------------------------------------------
-#
-# PAGE TITLES, sorted alphabetically
-#
-#------------------------------------------------------------------------------
-
-action_plans.page=Action Plans
-backup.page=Backup
-clouds.page=Clouds
-components.page=Components
-coverage.page=Coverage
-default_dashboards.page=Default Dashboards
-default_filters.page=My Filters
-dependencies.page=Dependencies
-duplications.page=Duplications
-email_configuration.page=Email Settings
-event_categories.page=Event Categories
-filters.page=Filters
-system_administrators.page=System Administrators
-manual_metrics.page=Manual Metrics
-manual_measures.page=Manual Measures
-manual_rules.page=Manual Rules
-my_profile.page=My Profile
-roles.page=Roles
-project_settings.page=Settings
-project_links.page=Links
-project_exclusions.page=Exclusions
-project_history.page=History
-quality_profiles.page=Quality Profiles
-reviews.page=Reviews
-settings.page=General Settings
-source.page=Source
-system_info.page=System Info
-timemachine.page=Time Machine
-user_groups.page=Groups
-users.page=Users
-violations.page=Violations
-violations_drilldown.page=Violations Drilldown
-update_center.page=Update Center
-lcom4_viewer.page=LCOM4
-resource_deletion.page={0} Deletion
-update_key.page=Update Key
-project_quality_profile.page=Quality Profile
-bulk_deletion.page=Bulk Deletion
-
-
-# GWT pages
-org.sonar.plugins.design.ui.page.DesignPage.page=Design
-org.sonar.plugins.design.ui.libraries.LibrariesPage.page=Libraries
-org.sonar.plugins.design.ui.dependencies.DependenciesTab.page=Dependencies
-
-
-#------------------------------------------------------------------------------
-#
-# SESSION
-#
-#------------------------------------------------------------------------------
-
-sessions.remember_me=Remember me on this computer
-sessions.log_in=Log in
-sessions.new_account=Not a member? <a href="{0}" tabindex="-1">Sign up</a> for an account.
-sessions.confirm_password=Confirm password
-sessions.sign_up=Sign up
-sessions.old_account=<a href="{0}" tabindex="-1">Log in</a> if you already have an account.
-session.flash_notice.authentication_failed=Authentication failed.
-session.flash_notice.logged_out=You have been logged out.
-
-
-#------------------------------------------------------------------------------
-#
-# FILTERS
-#
-#------------------------------------------------------------------------------
-
-filters.new=New filter
-filters.size=Size
-filters.color=Color
-filters.add_filter=Add filter
-filters.edit_filter=Edit filter
-filters.manage_filters=Manage filters
-filters.search_for=Display
-filters.advanced_search=Advanced search
-filters.default_period=Differential period
-filters.when_no_language_no_filter_apply=When no language is selected, no filter will apply
-filters.favourite_only=Favourites only
-filters.resource_key_like=Resource key like
-filters.use_star_to_match=Use the character * to match zero or more characters.
-filters.resource_name_like=Resource name like
-filters.do_you_want_to_delete=Do you want to delete this filter ?
-filters.during_last=During last
-filters.prior_to_last=Prior to last
-filters.search_by_name=Search by name
-filters.add_column=Add column
-filters.default_sorted_column=Default sorted column
-filters.treemap_not_supported_for_period_selection=Treemap does not support yet the selection of a period.
-filters.my_filters=My filters
-filters.no_filters=No filters
-filters.do_you_want_to_stop_following=Do you want to stop following this filter ?
-filters.criteria=Criteria
-filters.display_form.title=Display
-filters.display_form.as=Display as
-filters.display_form.table=Table
-filters.display_form.treemap=Treemap
-filters.build_date=Build date
-filters.col.date=Build date
-filters.col.language=Language
-filters.col.name=Name
-filters.col.links=Links
-filters.col.version=Version
-filters.col.key=Key
-filters.default=Default filters
-filters.default.description=These filters are displayed on the homepage.
-filters.shared=Shared filters
-filters.shared.description=These filters are shared by administrators and can be added to default filters.
-filters.directChildrenCriterion=Direct Children
-
-#------------------------------------------------------------------------------
-#
-# REVIEWS / PROJECT REVIEWS
-#
-#------------------------------------------------------------------------------
-
-reviews.review_number=Review #{0}
-reviews.flag_as_false_positive=False-positive
-reviews.unflag_as_false_positive=Not false-positive
-reviews.flag_as_false_positive_submit=False-positive
-reviews.unflag_as_false_positive_submit=Not false-positive
-reviews.do_you_want_to_delete_comment=Do you want to delete this comment?
-reviews.only_false_positives=Only false positives
-reviews.without_false_positives=Without false positives
-reviews.showing_false_positives_only=Showing false positives only
-reviews.reviews_filtered_by_date_x_to_y=Reviews filtered by date: {0} to {1}.
-reviews.why_false_positive=Why is it a false-positive ?
-reviews.why_not_false_positive=Why is it not a false-positive anymore ?
-reviews.user_does_not_exist=\ : user does not exist. \\nPlease select a valid user or leave the field blank.
-reviews.change_severity=Change severity
-reviews.comment=Comment
-reviews.comment_submit=Comment
-reviews.update_comment_submit=Update
-reviews.new_severity_label=New severity:
-reviews.change_severity_submit=Change severity
-reviews.assign=Assign
-reviews.assign_submit=Assign
-reviews.assign_to_me_submit=Assign to me
-reviews.resolved=Resolved
-reviews.resolved_submit=Resolved
-reviews.reopen=Reopen
-reviews.reopen_submit=Reopen
-reviews.edit=Edit
-reviews.delete=Delete
-reviews.status.REOPENED=Reopened
-reviews.status.RESOLVED=Resolved
-reviews.status.OPEN=Open
-reviews.status.CLOSED=Closed
-reviews.resolution.FALSE-POSITIVE=False-positive
-reviews.resolution.FIXED=Fixed
-reviews.link_to_action_plan=Plan
-reviews.action_plan_label=Action plan
-reviews.action_plan_submit=Link
-reviews.unlink_action_plan_submit=Unlink
-reviews.no_action_plan=None
-reviews.planned_for_x=Planned for {0}
-reviews.planned_for_label=Planned for
-reviews.an_action_plan_must_be_created_first=An action plan should be first created to plan the remediation effort of this violation.
-reviews.hide_this_message=Hide this message
-reviews.filtered_by=Filtered by
-reviews.remove_this_filter=Remove this filter
-reviews.filtered_by.statuses=Status
-reviews.filtered_by.resolutions=Resolution
-reviews.filtered_by.severities=Severity
-reviews.filtered_by.authors=Author
-reviews.filtered_by.assignees=Assignee
-reviews.filtered_by.action_plan_id=Action plan
-reviews.filtered_by.unplanned=Unplanned
-reviews.filtered_by.from=From date
-reviews.filtered_by.to=To date
-
-
-#------------------------------------------------------------------------------
-#
-# ACTION PLANS
-#
-#------------------------------------------------------------------------------
-
-action_plans.page_title=Manage Action Plans
-action_plans.add_action_plan=Add action plan
-action_plans.col.status=St.
-action_plans.col.name=Name
-action_plans.col.due_for=Due for
-action_plans.col.progress=Progress
-action_plans.col.description=Description
-action_plans.col.author=Author
-action_plans.col.closed_on=Closed on
-action_plans.col.operations=Operations
-action_plans.no_action_plan=No action plan
-action_plans.no_reviews_linked_to_action_plan=No reviews linked to this action plan yet.
-action_plans.confirm_delete=Delete this action plan? Associated reviews will not be deleted.
-action_plans.confirm_close=Close this action plan? There are still open reviews linked to it.
-action_plans.create_new_action_plan=Create a new action plan
-action_plans.create_action_plan=Create action plan
-action_plans.edit_action_plan=Edit action plan
-action_plans.same_name_in_same_project=An action plan with this name already exists in this project.
-action_plans.date_format_help=The date should be entered using the following pattern: 'day/month/year'. For instance, '31/12/2011'.
-action_plans.date_not_valid=Date not valid
-action_plans.date_cant_be_in_past=The dead-line can't be in the past
-action_plans.x_out_of_x_reviews_solved={0} of {1} reviews solved
-action_plans.resolved_reviews_x_percent=Resolved reviews - {0}% ({1} reviews)
-action_plans.open_reviews_x_percent=Open reviews - {0}% ({1} reviews)
-action_plans.reopen=Reopen
-action_plans.close=Close
-action_plans.closed_action_plan=Closed action plans
-
-
-#------------------------------------------------------------------------------
-#
-# DEPENDENCIES
-#
-#------------------------------------------------------------------------------
-
-dependencies.search_library=Search library
-dependencies.search_help=Find out which projects depend on a given library.<br/>Search by group, artifact or name. E.g.: org.apache.struts, struts-core or Struts
-dependencies.select_library=Select library
-dependencies.select_version=Select version
-dependencies.used_by=Used by
-dependencies.not_used=Not used
-
-
-#------------------------------------------------------------------------------
-#
-# DASHBOARD / DASHBOARDS
-#
-#------------------------------------------------------------------------------
-
-dashboard.cannot_render_widget_x=Can not render widget {0}: {1}
-dashboard.back_to_dashboard=Back to dashboard
-dashboard.configure_widgets=Configure widgets
-dashboard.manage_dashboards=Manage dashboards
-dashboard.add_widget=Add widget
-dashboard.please_configure_the_widget_x=Please configure the widget <b>{0}</b>.
-dashboard.global_dashboards=Global Dashboards
-dashboard.project_dashboards=Project Dashboards
-dashboard.my_global_dashboards=My Global Dashboards
-dashboard.my_project_dashboards=My Project Dashboards
-dashboard.no_dashboard=No dashboard
-dashboard.do_you_want_to_delete_dashboard=Do you want to delete this dashboard ?
-dashboard.available_dashboards=Available Dashboards
-dashboard.shared_dashboards=Shared Dashboards
-dashboard.create_dashboard=New dashboard
-dashboard.create_project_dashboard=Create project dashboard
-dashboard.create_global_dashboard=Create global dashboard
-dashboard.edit_dashboard=Edit dashboard
-dashboard.update_dashboard=Update dashboard
-dashboard.not_found=This dashboard was not found
-dashboard.error_create_existing_name=A dashboard already exists with the same name
-dashboard.error_follow_existing_name=A dashboard already exists with the same name
-dashboard.default_restored=Default dashboards are restored
-dashboard.error_delete_default=This dashboard can't be deleted as long as it's defined as a default dashboard
-dashboard.error_unshare_default=This dashboard can't be unshared as long as it's defined as a default dashboard
-dashboard.global_dashboards.description=These dashboards are displayed to anonymous users or users who have not customized their dashboards.
-dashboard.project_dashboards.description=These dashboards are displayed to anonymous users or users who have not customized their dashboards.
-dashboard.shared_dashboards.description=These dashboards can be added to default dashboards.
-dashboard.username.default=[Sonar]
-
-
-#------------------------------------------------------------------------------
-#
-# SETTINGS
-#
-#------------------------------------------------------------------------------
-settings.save_category=Save {0} Settings
-property.category.email=Email
-property.category.encryption=Encryption
-property.category.general=General
-property.category.security=Security
-property.category.java=Java
-property.category.differentialViews=Differential Views
-property.category.codeCoverage=Code Coverage
-property.category.duplications=Duplications
-property.category.localization=Localization
-property.category.server_id=Server ID
-
-property.error.notBoolean=Valid options are "true" and "false"
-property.error.notInteger=Only digits are allowed
-property.error.notFloat=Not a floating point number
-property.error.notInOptions=Not a valid option
-
-
-
-#------------------------------------------------------------------------------
-#
-# DASHBOARDS
-#
-#------------------------------------------------------------------------------
-
-# Default dashboard
-dashboard.Dashboard.name=Dashboard
-dashboard.Hotspots.name=Hotspots
-dashboard.Reviews.name=Reviews
-dashboard.TimeMachine.name=Time Machine
-
-#------------------------------------------------------------------------------
-#
-# SEARCH ENGINE FOR RESOURCES
-#
-#------------------------------------------------------------------------------
-search.results=results
-search.duration=({0} seconds)
-
-#------------------------------------------------------------------------------
-#
-# WIDGETS
-#
-#------------------------------------------------------------------------------
-
-widgets.more=More
-widget.error_occurred_please_read_logs=An error occurred while trying to display the widget "{0}". Please contact the administrator.
-
-widget.alerts.name=Alerts
-widget.alerts.description=Display current alerts on the project.
-widget.alerts.no_alert=No alerts
-widget.alerts.alerts=Alerts
-
-widget.code_coverage.name=Code coverage
-widget.code_coverage.description=Reports on units tests and code coverage by unit tests.
-widget.code_coverage.line_coverage.suffix=\ line coverage
-widget.code_coverage.branch_coverage.suffix=\ branch coverage
-widget.code_coverage.on_new_code=On new code
-widget.code_coverage.no_new_lines_to_cover=No new lines to cover
-widget.code_coverage.test_success=Unit test success
-widget.code_coverage.failures.suffix=\ failures
-widget.code_coverage.errors.suffix=\ errors
-widget.code_coverage.tests.suffix=\ tests
-widget.code_coverage.skipped.suffix=\ skipped
-
-# id of this widget does not use underscore in order to be backward-compatible with previous version of JaCoCo plugin
-widget.it-coverage.name=Integration test coverage
-widget.it-coverage.description=Reports on code coverage by integration tests
-widget.it-coverage.line_coverage.suffix=\ line coverage
-widget.it-coverage.branch_coverage.suffix=\ branch coverage
-widget.it-coverage.lines_to_cover.suffix=\ lines to cover
-widget.it-coverage.on_new_code=On new code
-widget.it-coverage.no_new_lines_to_cover=No new lines to cover
-
-
-widget.comments_duplications.name=Comments & Duplications
-widget.comments_duplications.description=Reports on copy/paste and documentation
-widget.comments_duplications.comments=Comments
-widget.comments_duplications.lines.suffix=\ lines
-widget.comments_duplications.blank.suffix=\ blank
-widget.comments_duplications.docu_api.suffix=\ docu. API
-widget.comments_duplications.undocu_api.suffix=\ undocu. API
-widget.comments_duplications.commented_locs.suffix=\ commented LOCs
-widget.comments_duplications.duplications=Duplications
-widget.comments_duplications.blocks.suffix=\ blocks
-widget.comments_duplications.files.suffix=\ files
-
-widget.complexity.name=Complexity
-widget.complexity.description=Reports on complexity, average complexity and complexity distribution.
-widget.complexity.per_method.suffix=\ /method
-widget.complexity.per_paragraph.suffix=\ /paragraph
-widget.complexity.per_class.suffix=\ /class
-widget.complexity.per_file.suffix=\ /file
-widget.complexity.total=Total
-
-widget.custom_measures.name=Custom Measures
-widget.custom_measures.description=Display a list of selected measures.
-
-widget.description.name=Description
-widget.description.description=Displays general project information
-widget.description.key=Key
-widget.description.language=Language
-widget.description.profile=Profile
-widget.description.profile_version_x=version {0}
-widget.description.alerts=Alerts
-widget.description.alerts_rss_feed=RSS Feed
-widget.description.links=Links
-
-widget.events.name=Events
-widget.events.description=Reports events on the project life cycle such as versions and alerts.
-
-widget.rules.name=Rules Compliance
-widget.rules.description=Reports violations and compliance index on coding standards.
-widget.rules.violations=Violations
-widget.rules.rules_compliance=Rules compliance
-widget.rules.added=Added:
-widget.rules.removed=Removed:
-
-widget.size.name=Size metrics
-widget.size.description=Reports general metrics on the size of the project.
-widget.size.lines_of_code=Lines of code
-widget.size.lines=Lines
-widget.size.generated.suffix=\ generated
-widget.size.lines.suffix=\ lines
-widget.size.statements.suffix=\ statements
-widget.size.files.suffix=\ files
-widget.size.classes=Classes
-widget.size.files=Files
-widget.size.packages.suffix=\ packages
-widget.size.directories.suffix=\ directories
-widget.size.methods.suffix=\ methods
-widget.size.accessors.suffix=\ accessors
-widget.size.paragraphs.suffix=\ paragraphs
-widget.size.projects.suffix=\ projects
-
-widget.timeline.name=Timeline
-widget.timeline.description=Displays up to 3 metrics on a history chart.
-widget.timeline.timeline_not_displayed=No history
-
-widget.time_machine.name=History Table
-widget.time_machine.description=Displays up to 10 metrics in a table, showing their value for a specified number of past snapshots.
-
-widget.ckjm.name=Chidamber & Kemerer
-widget.ckjm.description=Reports on LCOM4 and RFC average and distribution.
-widget.ckjm.lcom4=LCOM4
-widget.ckjm.per_class.suffix=\ /class
-widget.ckjm.files_having_lcom_greater_than_one=\ files having LCOM4>1
-widget.ckjm.rfc=Response for Class
-
-widget.file_design.name=File design
-widget.file_design.description=Reports on files dependency cycles and tangle index.
-widget.file_design.file_tangle_index=File tangle index
-widget.file_design.cycles.suffix=\ cycles
-widget.file_design.suspect_file_dependencies=Suspect file dependencies
-
-widget.package_design.name=Package design
-widget.package_design.description=Reports on package dependency cycles and tangle index.
-widget.package_design.package_tangle_index=Package tangle index
-widget.package_design.cycles.suffix=\ cycles
-widget.package_design.dependencies_to_cut=Dependencies to cut
-widget.package_design.between_packages.suffix=\ between packages
-widget.package_design.between_files.suffix=\ between files
-
-widget.hotspot_metric.name=Metric hotspot
-widget.hotspot_metric.description=Shows the files that have the worst result for a specific metric.
-widget.hotspot_metric.more=More
-widget.hotspot_metric.hotspots_by_x=Hotspots by {0}
-
-widget.hotspot_most_violated_rules.name=Most violated rules
-widget.hotspot_most_violated_rules.name_when_period=Most new violated rules
-widget.hotspot_most_violated_rules.description=Shows the rules that are the most violated.
-widget.hotspot_most_violated_rules.no_violation_for_severity=No result
-widget.hotspot_most_violated_rules.any_severity=Any severity
-
-widget.hotspot_most_violated_resources.name=Most violated resources
-widget.hotspot_most_violated_resources.description=Shows the resources that have the most violations.
-widget.hotspot_most_violated_resources.no_resource=No result
-
-widget.my_reviews.name=My active reviews
-widget.my_reviews.description=Shows open/reopened reviews assigned to the current user.
-widget.my_reviews.no_review=No review.
-
-widget.project_reviews.name=Active reviews
-widget.project_reviews.description=Shows all the open/reopened reviews.
-
-widget.false_positive_reviews.name=False positives
-widget.false_positive_reviews.description=Shows all the false positives found on the project.
-
-widget.reviews_per_developer.name=Active reviews per developer
-widget.reviews_per_developer.description=Shows the number of open/reopened reviews per developer.
-widget.reviews_per_developer.not_assigned=Not assigned
-
-widget.action_plans.name=Action plans
-widget.action_plans.description=Shows all the open action plans of the project
-widget.action_plans.title=Open action plans
-widget.action_plans.no_action_plan=No action plan
-
-widget.planned_reviews.name=Planned reviews
-widget.planned_reviews.description=Shows all the planned reviews of the project, gathered by action plan
-widget.planned_reviews.no_action_plan=No action plan
-
-widget.unplanned_reviews.name=Unplanned reviews
-widget.unplanned_reviews.description=Shows all the reviews of the project that are not planned yet in an action plan
-
-widget.reviews_metrics.name=Review Activity
-widget.reviews_metrics.description=Reports metrics about reviews
-widget.reviews_metrics.no_data=No data
-widget.reviews_metrics.active_reviews=Active reviews
-widget.reviews_metrics.unassigned.suffix=\ unassigned
-widget.reviews_metrics.unplanned.suffix=\ unplanned
-widget.reviews_metrics.false_positives=False positives
-widget.reviews_metrics.unreviewed_violations=Unreviewed violations
-widget.reviews_metrics.added_unreviewed_violations=Added:
-
-widget.treemap-widget.name=Treemap of components
-widget.treemap-widget.description=Displays a treemap of all direct components of the selected resource
-
-widget.image.name=Image
-widget.image.description=Shows an image with a link
-
-widget.filter.name=Filter
-widget.filter.description=Shows a pre-configured filter
-widget.filter.edit=Edit my filters
-
-widget.resource_id=project
-
-#------------------------------------------------------------------------------
-#
-# COMPONENTS
-#
-#------------------------------------------------------------------------------
-
-components.no_projects_have_been_analysed=No projects have been analysed.
-components.explanation_launch_sonar_to_have_results=If Maven and Sonar are installed with default parameters on the same box, just launch the command <code>mvn sonar:sonar</code> to analyse your first project. In any other case, please refer to the <a href="http://www.sonarsource.org/documentation">documentation</a>.
-components.note_changes_impact_all_users=Note that these changes will impact all users and all projects.
-
-
-#------------------------------------------------------------------------------
-#
-# DRILLDOWN
-#
-#------------------------------------------------------------------------------
-
-drilldown.drilldown_on=Drilldown on
-
-violations_drilldown.click_for_more_on_x=Click for more on {0} : {1}
-violations_drilldown.col.severity=Severity
-violations_drilldown.col.rule=Rule
-violations_drilldown.no_violations=No violations
-
-
-#------------------------------------------------------------------------------
-#
-# RESOURCE VIEWER
-#
-#------------------------------------------------------------------------------
-
-resource_viewer.resource_deleted=This resource has been deleted.
-
-
-#------------------------------------------------------------------------------
-#
-# VIOLATIONS VIEWER
-#
-#------------------------------------------------------------------------------
-
-violations_viewer.review_filter.false_positives=False positives
-violations_viewer.review_filter.active=Active
-violations_viewer.review_filter.unassigned=Unassigned
-violations_viewer.review_filter.unplanned=Unplanned
-violations_viewer.review_filter.unreviewed_violations=Unreviewed violations
-
-
-#------------------------------------------------------------------------------
-#
-# DUPLICATION VIEWER
-#
-#------------------------------------------------------------------------------
-
-duplications.no_duplicated_block=No duplicated blocks.
-duplications.dups_found_on_deleted_resource=This file contains duplicated blocks with some deleted resources. This project should be reanalyzed to remove these obsolete duplicated blocks.
-duplications.old_format_should_reanalyze=This file contains duplications but a new analysis must be done in order to be able to display them.
-duplications.blocks=Blocks
-duplications.number_of_lines=Nb Lines
-duplications.from_line=From line
-duplications.file=File
-duplications.details=Details
-duplications.expand=Expand
-duplications.collapse=Collapse
-
-
-#------------------------------------------------------------------------------
-#
-# COVERAGE VIEWER
-#
-#------------------------------------------------------------------------------
-coverage_viewer.on_new_code=On new code
-coverage_viewer.unit_tests=Unit Tests
-coverage_viewer.integration_tests=Integration Tests
-
-
-#------------------------------------------------------------------------------
-#
-# GENERIC CODE VIEWER
-#
-#------------------------------------------------------------------------------
-code_viewer.create_violation.new_rule=New Rule
-code_viewer.create_violation.rules=Rules
-code_viewer.create_violation.submit=Create Violation
-code_viewer.create_violation.missing_rule=Missing rule
-code_viewer.create_violation.missing_message=Missing message
-code_viewer.create_violation.missing_severity=Missing severity
-code_viewer.create_violation.no_rules=No rules. Please contact your administrator.
-code_viewer.create_violation.bad_assignee=Unknown assignee
-
-
-#------------------------------------------------------------------------------
-#
-# DEPENDENCIES VIEWER
-#
-#------------------------------------------------------------------------------
-dependencies.ca=Afferent (incoming) couplings
-dependencies.ce=Efferent (outgoing) couplings
-
-
-#------------------------------------------------------------------------------
-#
-# MANUAL MEASURES
-#
-#------------------------------------------------------------------------------
-
-manual_measures.add_measure_link=Add measure
-manual_measures.manage_metrics_link=Manage metrics
-manual_measures.col.domain=Domain
-manual_measures.col.metric=Metric
-manual_measures.col.value=Value
-manual_measures.col.description=Description
-manual_measures.col.author=Author
-manual_measures.col.date=Date
-manual_measures.col.operations=Operations
-manual_measures.col.last_change=Last change
-manual_measures.col.last_change_label=By {0} at {1}
-manual_measures.add_measure_title=Add manual measure
-manual_measures.save_button=Save
-manual_measures.save_and_add_button=Save & Add new
-manual_measures.pending_message=Pending measures are marked with orange box. Their values will be integrated to project during next analysis.
-
-
-#------------------------------------------------------------------------------
-#
-# MANUAL MEASURES
-#
-#------------------------------------------------------------------------------
-
-manual_rules.should_provide_real_description=Rule created on the fly. A description should be provided.
-
-
-#------------------------------------------------------------------------------
-#
-# PROJECT HISTORY SERVICE
-#
-#------------------------------------------------------------------------------
-
-project_history.description=Handle events and delete quality snapshots from history.
-project_history.col.year=Year
-project_history.col.month=Month
-project_history.col.day=Day
-project_history.col.time=Time
-project_history.col.events=Events
-project_history.col.action=Action
-project_history.col.version=Version
-project_history.col.alert=Alert
-project_history.col.profile=Profile
-project_history.delete=Delete
-project_history.last_snapshot=Last snapshot
-project_history.delete_snapshot=Delete snapshot
-project_history.snapshot_deleted=The snapshot is deleted.
-project_history.are_you_sure_delete_snapshot_x=Are you sure you want to delete the snapshot created on "{0}"?
-project_history.rename_version=Rename
-project_history.create_version=Create
-project_history.remove_version=Remove
-project_history.do_you_want_to_remove_version=Are you sure you want to remove "{0}" from this snapshot?
-project_history.version_updated=Version was updated to "{0}" for current project and all its sub-projects.
-project_history.version_created=Version "{0}" was created for current project and all its sub-projects.
-project_history.version_removed=Version "{0}" was removed from current project and all its sub-projects.
-project_history.version_already_exists=Version "{0}" already exists.
-project_history.rename_event=Rename
-project_history.create_event=Create
-project_history.remove_event=Remove
-project_history.event_updated=Event was successfully updated.
-project_history.event_deleted=Event "{0}" was deleted.
-project_history.event_created=Event "{0}" was created.
-project_history.event_already_exists=Event "{0}" already exists.
-
-
-#------------------------------------------------------------------------------
-#
-# PROJECT / MODULE "UPDATE KEY" PAGE
-#
-#------------------------------------------------------------------------------
-update_key.update_resource_key=Update Key
-update_key.description=This administration page allows to change the key of a project and of its modules. Those changes must be done BEFORE analyzing the project with the new keys otherwise this operation will fail.
-update_key.bulk_update=Bulk Update
-update_key.fine_grained_key_update=Fine-grained Update
-update_key.old_key=Old key
-update_key.new_key=New key
-update_key.rename=Rename
-update_key.reset=Reset
-update_key.new_key_cant_be_blank_for_x=The new key can not be blank for "{0}".
-update_key.same_key_for_x=The new key is the same as the original one ("{0}"), nothing has been updated.
-update_key.cant_update_x_because_resource_already_exist_with_key_x="{0}" can not be renamed because "{1}" is the key of an existing resource. The update has been canceled.
-update_key.error_occured_while_renaming_key_of_x=An error occurred while renaming the key "{0}": {1}
-update_key.key_updated=The key has successfully been updated for all required resources.
-update_key.fieds_cant_be_blank_for_bulk_update=The two fields can not be blank for the bulk update.
-update_key.bulk_change_description=The bulk update allows to replace a part of the current key(s) by another string on the current project and all its submodules - if applicable.
-update_key.current_key_for_project_x_is_x=The key of the "{0}" project is currently "<b>{1}</b>".
-update_key.are_you_sure_to_rename_x=Are you sure you want to rename "{0}", as well as all its modules and resources ?
-update_key.replace=Replace
-update_key.by=By
-update_key.replace_example=Ex.: "org.myCompany"
-update_key.by_example=Ex.: "com.myNewCompany"
-update_key.cant_update_because_duplicate_keys=The replacement of "{0}" by "{1}" is impossible as it would result in duplicate keys (in red below):
-update_key.keys_will_be_updated_as_follows=The resources will be updated as follows (updated keys in bold):
-update_key.duplicate_key=Duplicate key
-update_key.bulk_update_confirmation_page=Do you really want to perform the bulk update on project keys?
-update_key.bulk_update_impossible=Bulk update can not be performed
-update_key.no_key_to_update=No key contains the string to replace ("{0}").
-
-
-#------------------------------------------------------------------------------
-#
-# PROJECT QUALITY PROFILE PAGE
-#
-#------------------------------------------------------------------------------
-project_quality_profile.select_profile_for_x=Select the quality profile to be used when analyzing the "{0}" project:
-project_quality_profile.project_cannot_be_update_with_profile_x=The current project can not be updated with the following profile: "{0}".
-project_quality_profile.profile_successfully_updated=Quality profile successfully updated.
-project_quality_profile.default_profile=default
-
-
-#------------------------------------------------------------------------------
-#
-# PROJECT (RESOURCE) DELETION PAGE
-#
-#------------------------------------------------------------------------------
-
-project_deletion.delete_resource=Delete {0}
-project_deletion.operation_cannot_be_undone=This operation can not be undone.
-project_deletion.delete_resource_confirmation=Are you sure you want to delete this {0}?
-
-
-#------------------------------------------------------------------------------
-#
-# TIME MACHINE
-#
-#------------------------------------------------------------------------------
-
-time_machine.show_date=Show date
-time_machine.show_event=Show event
-time_machine.distributions=Distributions
-time_machine.distribution_chart=Distribution chart
-time_machine.compare_on_chart=Compare on chart
-time_machine.set_as_default_for_all_users=Set as default (for all users)
-
-
-#------------------------------------------------------------------------------
-#
-# CLOUDS
-#
-#------------------------------------------------------------------------------
-
-cloud.quick_wins=Quick wins
-cloud.top_risk=Top risk
-
-
-#------------------------------------------------------------------------------
-#
-# QUALITY PROFILES
-#
-#------------------------------------------------------------------------------
-
-quality_profiles.quality_profiles=Quality profiles
-quality_profiles.new_profile=New profile
-quality_profiles.compare_profiles=Compare profiles
-quality_profiles.restore_profile=Restore profile
-quality_profiles.x_language_profiles= {0} profiles
-quality_profiles.optional_configuration_file=Optional configuration file
-quality_profiles.create_x_language_profile=Create {0} profile
-quality_profiles.are_you_sure_want_x_profile_as_default=Are you sure that you want to set the profile "{0}" as default ?
-quality_profiles.profile_x_created=Profile "{0}" created. Set it as default or link it to a project to use it for next measures.
-quality_profiles.profile_x_already_exists=This profile already exists: {0}.
-quality_profiles.please_type_profile_name=Please type a profile name.
-quality_profiles.profile_x_deleted=Profile "{0}" is deleted.
-quality_profiles.default_profile_is_x=Default profile is "{0}".
-quality_profiles.profile_x_not_activated=Profile "{0}" is created but not activated.
-quality_profiles.please_upload_backup_file=Please upload a backup file.
-quality_profiles.profile_x_associated_to_x_projects=Profile "{0}" associated to {1} projects.
-quality_profiles.profile_name_cant_be_blank=Profile name can not be blank.
-quality_profiles.profile_name_already_exists=This profile name already exists.
-quality_profiles.new_name=New name
-quality_profiles.name_for_new_profile=Name for the new profile
-quality_profiles.are_you_sure_want_delete_profile_x=Are you sure that you want to delete the profile "{0}" ?
-quality_profiles.editing_profile=Editing profile
-quality_profiles.profile_inheritance=Profile inheritance
-quality_profiles.available_projects=Available projects
-quality_profiles.associated_projects=Associated projects
-quality_profiles.no_projects_associated_to_profile_x=No projects are explicitly associated to the profile "{0}".
-quality_profiles.projects_warning=List of projects explicitly associated to this Quality profile :
-quality_profiles.including_x_overriding.suffix=, incl. {0} overriding
-quality_profiles.profile_cant_be_edited=This profile can not be edited.
-quality_profiles.set_parent=Set parent
-quality_profiles.inherit_rules_from_profile=Inherit rules configuration from the profile
-quality_profiles.no_changes_done_on_this_profile=No changes has been done on this quality profile.
-quality_profiles.changelog_from=Changelog from
-quality_profiles.no_version=no version
-quality_profiles.last_version_x_with_date=last version {0} ({1})
-quality_profiles.version_x_with_date=version {0} ({1})
-quality_profiles.profile_version=Profile version
-quality_profiles.severity_changed_from_x_to=Severity changed from {0}<b>{1}</b> to
-quality_profiles.severity_was_x=Severity was {0}<b>{1}</b>
-quality_profiles.severity_set_to_x=Severity set to {0}<b>{1}</b>
-quality_profiles.parameter_set_to_x=Parameter <b>{0}</b> set to <b>{1}</b>
-quality_profiles.parameter_was_x=Parameter <b>{0}</b> was <b>{1}</b>
-quality_profiles.parameter_reset_to_default_value_x=Parameter <b>{0}</b> reset to default value (was <b>{1}</b>)
-quality_profiles.parameter_changed_from_x_to_x=Parameter <b>{0}</b> changed from <b>{1}</b> to <b>{2}</b>
-quality_profiles.only_in_profile_x=Only in {0}
-quality_profiles.with_different_configuration=With different configuration
-quality_profiles.with_same_configuration=With same configuration
-quality_profiles.x_rules_only_in={0} rules only in
-quality_profiles.x_rules_have_different_configuration={0} rules have a different configuration
-quality_profiles.export_all_rules=All rules
-
-
-#------------------------------------------------------------------------------
-#
-# RULES CONFIGURATION
-#
-#------------------------------------------------------------------------------
-
-rules_configuration.tab.new_rule=New rule
-rules_configuration.tab.edit_rule=Edit rule
-rules_configuration.profile_cant_be_updated_description=This profile can not be updated but it can be used as a template for your own configuration. Just copy it from the profiles page.
-rules_configuration.x_found_in_active_rules={0} found in active rules
-rules_configuration.x_found_in_inactive_rules={0} found in inactive rules
-rules_configuration.expand_collapse=expand/collapse
-rules_configuration.html_allowed=HTML is allowed.
-rules_configuration.inherited_from_parent=Inherited from parent
-rules_configuration.overrides_parent_definition=Overrides parent definition
-rules_configuration.parent_parameter.empty=empty
-rules_configuration.copy_rule=Copy rule
-rules_configuration.edit_rule=Edit rule
-rules_configuration.revert_to_parent_definition=Revert to parent definition
-rules_configuration.not_inherited=Not inherited
-rules_configuration.inherited=Inherited
-rules_configuration.overrides=Overrides
-rules_configuration.rule_not_valid_message_x=Rule is not valid: <br/>{0}
-rules_configuration.rule_deleted=Rule deleted
-rules_configuration.unknown_rule=Unknown rule
-rules_configuration.x_rules_have_been_activated={0} rules have been activated.
-rules_configuration.x_rules_have_been_deactivated={0} rules have been deactivated.
-rules_configuration.extend_description=Extend description
-rules_configuration.edit_note=Edit note
-rules_configuration.add_note=Add note
-rules_configuration.confirm_delete_note=Do you really want to delete this note?
-rules_configuration.rule_inherited_from_profile_x=Rule inherited from profile "{0}"
-rules_configuration.rule_overriding_from_profile_x=Rule overrides parent definition from profile "{0}"
-rules_configuration.original_value=Original value
-rules_configuration.original_severity=Original severity
-rules_configuration.repository=Repository
-
-
-#------------------------------------------------------------------------------
-#
-# RULES DOCUMENTATION PAGE
-#
-#------------------------------------------------------------------------------
-rules.more_about_rule_on_profile_x=More about this rule on profile "{0}"
-rules.identification=Identification
-rules.parameters=Parameters
-
-
-#------------------------------------------------------------------------------
-#
-# EMAIL CONFIGURATION
-#
-#------------------------------------------------------------------------------
-email_configuration.smtp_host=SMTP host
-email_configuration.smtp_host.description=For example "smtp.gmail.com". Leave blank to disable email sending.
-email_configuration.smtp_port=SMTP port
-email_configuration.smtp_port.description=Port number to connect with SMTP server.
-email_configuration.smtp_secure_connection=Use secure connection
-email_configuration.smtp_secure_connection.description=Whether to use secure connection and its type.
-email_configuration.smtp_username=SMTP username
-email_configuration.smtp_username.description=Optional - if you use authenticated SMTP, enter your username.
-email_configuration.smtp_password=SMTP password
-email_configuration.smtp_password.description=Optional - as above, enter your password if you use authenticated SMTP.
-email_configuration.from_address=From address
-email_configuration.from_address.description=Emails will come from this address. For example - "noreply@sonarsource.com". Note that server may ignore this setting (like does GMail).
-email_configuration.email_prefix=Email prefix
-email_configuration.email_prefix.description=This prefix will be prepended to all outgoing email subjects.
-email_configuration.save_settings=Save Email Settings
-email_configuration.saving_settings=Saving
-email_configuration.settings_saved=Settings are saved.
-
-email_configuration.test.title=Test Configuration
-email_configuration.test.to_address=To
-email_configuration.test.to_address_required=You must provide address where to send test email
-email_configuration.test.subject=Subject
-email_configuration.test.subject_text=Test Message from Sonar
-email_configuration.test.message=Message
-email_configuration.test.message_text=This is a test message from Sonar
-email_configuration.test.send=Send Test Email
-email_configuration.test.sending=Sending Test Email
-email_configuration.test.email_was_sent_to_x=Email was sent to {0}
-
-
-#------------------------------------------------------------------------------
-#
-# SERVER KEY CONFIGURATION
-#
-#------------------------------------------------------------------------------
-server_id_configuration.page=Server ID
-server_id_configuration.generate_button=Generate ID
-server_id_configuration.generating_button=Generating ID...
-server_id_configuration.bad_key=The ID is not valid anymore. Please check the organisation and the IP address.
-server_id_configuration.information=The Server ID is a unique identifier of this Sonar instance. It is used for example to obtain a license key for the SonarSource's commercial plugins. Two fields have to be provided to generate the ID : organisation name and one of the IP addresses of the machine that hosts this server.
-server_id_configuration.organisation.title=Organisation
-server_id_configuration.organisation.desc=Name of the organisation
-server_id_configuration.ip.title=Fixed IP Address
-server_id_configuration.ip.desc=A server ID is linked to the IP address of the hosting machine that runs Sonar. If the server IP address was to change, the server ID will have to be regenerated. The valid addresses are :
-server_id_configuration.generation_error=Organisation and/or IP address are not valid.
-
-
-#------------------------------------------------------------------------------
-#
-# NOTIFICATIONS
-#
-#------------------------------------------------------------------------------
-notification.channel.EmailNotificationChannel=Email
-notification.dispatcher.ChangesInReviewAssignedToMeOrCreatedByMe=Changes in review assigned to me or created by me
-notification.dispatcher.NewViolationsOnMyFavouriteProject=New violations on my favourite projects introduced during the first differential view period
-
-
-#------------------------------------------------------------------------------
-#
-# ALERTS
-#
-#------------------------------------------------------------------------------
-
-alerts.no_alerts=No alerts.
-alerts.notes.description=<p>Only project measures are checked against thresholds. Modules, packages and classes are ignored.</p>Project health icons represent :
-alerts.notes.ok=at least one threshold is defined, no threshold is reached.
-alerts.notes.warn=at least one warning threshold is reached, no error threshold is reached.
-alerts.notes.error=at least one error threshold is reached.
-alerts.new_alert=New alert
-alerts.editing_alert=Editing alert
-alerts.create_alert=Create alert
-alerts.select_metric=Select a metric
-alerts.warning_threshold=Warning threshold
-alerts.warning_tooltip=A warning is triggered when this value is reached.
-alerts.error_threshold=Error threshold
-alerts.error_tooltip=An error is triggered when this value is reached.
-alerts.alert_created=Alert is created.
-alerts.alert_updated=Alert is updated.
-alerts.alert_deleted=Alert is deleted.
-alerts.operator.<=is less than
-alerts.operator.>=is greater than
-alerts.operator.\==equals
-alerts.operator.!\==is not
-
-#------------------------------------------------------------------------------
-#
-# EVENTS
-#
-#------------------------------------------------------------------------------
-
-events.add_an_event=Add an event
-events.name_required=Name (required)
-
-
-#------------------------------------------------------------------------------
-#
-# MY PROFILE
-#
-#------------------------------------------------------------------------------
-my_profile.login=Login
-my_profile.name=Name
-my_profile.email=Email
-my_profile.groups=Groups
-my_profile.password.title=Change password
-my_profile.password.old=Old value
-my_profile.password.new=New value
-my_profile.password.confirm=Confirm new value
-my_profile.password.submit=Change password
-my_profile.notifications.title=Notifications
-my_profile.notifications.submit=Save changes
-my_profile.password.changed=Password changed
-my_profile.password.empty=Password can not be empty
-my_profile.password.mismatch=Password mismatch
-my_profile.password.wrong_old=Wrong old password
-
-
-#------------------------------------------------------------------------------
-#
-# BULK RESOURCE DELETION
-#
-#------------------------------------------------------------------------------
-bulk_deletion.resource.projects=Projects
-bulk_deletion.resource.views=Views
-bulk_deletion.resource.devs=Developers
-bulk_deletion.resource_name_filter_by_name=Filter by name:
-bulk_deletion.filter=Filter
-bulk_deletion.page_size=Page size
-bulk_deletion.select_all=Select all
-bulk_deletion.select_all_x_resources=Select all {0} resources
-bulk_deletion.clear_selection=Clear selection of all {0} resources
-bulk_deletion.following_deletions_failed=The following resources could not be deleted. Please check the logs to know more about it.
-bulk_deletion.hide_message=Hide message
-bulk_deletion.sure_to_delete_the_resources=Are you sure you want to delete the selected resources?
-bulk_deletion.please_select_at_least_one_resource=Please select at least one resource to delete.
-bulk_deletion.deletion_manager.deleting_resources=Deleting resources...
-bulk_deletion.deletion_manager.no_resource_to_delete=No results.
-bulk_deletion.deletion_manager.currently_deleting_x_out_of_x=Currently deleting resources... ({0} out of {1})
-bulk_deletion.deletion_manager.deletion_completed=Resource deletion completed.
-bulk_deletion.deletion_manager.however_failures_occurred=However, some failures occurred.
-bulk_deletion.started_since_x=Started {0} ago
-
-
-#------------------------------------------------------------------------------
-#
-# TREEMAP
-#
-#------------------------------------------------------------------------------
-treemap.click_help=Left click to zoom in. Right click to zoom out.
-
-
-
-#------------------------------------------------------------------------------
-#
-# RULE SEVERITIES
-#
-#------------------------------------------------------------------------------
-
-severity.BLOCKER=Blocker
-severity.CRITICAL=Critical
-severity.MAJOR=Major
-severity.MINOR=Minor
-severity.INFO=Info
-
-#------------------------------------------------------------------------------
-#
-# METRIC DOMAINS
-#
-#------------------------------------------------------------------------------
-
-metric_domain.Size=Size
-metric_domain.Tests=Tests
-metric_domain.Integration Tests=Integration Tests
-metric_domain.Complexity=Complexity
-metric_domain.Documentation=Documentation
-metric_domain.Rules=Rules
-metric_domain.General=General
-metric_domain.Duplication=Duplication
-metric_domain.Design=Design
-metric_domain.SCM=SCM
-metric_domain.Management=Management
-metric_domain.Reviews=Reviews
-
-
-#------------------------------------------------------------------------------
-#
-# METRICS
-#
-#------------------------------------------------------------------------------
-
-metric.accessors.name=Accessors
-metric.accessors.description=Accessors
-
-metric.alert_status.name=Alert
-metric.alert_status.description=Alert
-
-metric.classes.name=Classes
-metric.classes.description=Classes
-
-metric.comment_blank_lines.name=Blank comments
-metric.comment_blank_lines.description=Comments that do not contain comments
-
-metric.comment_lines.name=Comment lines
-metric.comment_lines.description=Number of comment lines
-
-metric.comment_lines_density.name=Comments (%)
-metric.comment_lines_density.description=Comments balanced by ncloc + comment lines
-
-metric.commented_out_code_lines.name=Commented-out LOC
-metric.commented_out_code_lines.description=Commented lines of code
-
-metric.complexity.name=Complexity
-metric.complexity.description=Cyclomatic complexity
-
-metric.directories.name=Directories
-metric.directories.description=Directories
-
-metric.files.name=Files
-metric.files.description=Number of files
-
-metric.functions.name=Methods
-metric.functions.description=Methods
-
-metric.generated_lines.name=Generated Lines
-metric.generated_lines.description=Number of generated lines
-
-metric.generated_ncloc.name=Generated lines of code
-metric.generated_ncloc.description=Generated non Commenting Lines of Code
-
-metric.lines.name=Lines
-metric.lines.description=Lines
-
-metric.ncloc.name=Lines of code
-metric.ncloc.description=Non Commenting Lines of Code
-
-metric.packages.name=Packages
-metric.packages.description=Packages
-
-metric.paragraphs.name=Paragraphs
-metric.paragraphs.description=Number of paragraphs
-
-metric.public_api.name=Public API
-metric.public_api.description=Public API
-
-metric.public_documented_api_density.name=Public documented API (%)
-metric.public_documented_api_density.description=Public documented classes and methods balanced by ncloc
-
-metric.public_undocumented_api.name=Public undocumented API
-metric.public_undocumented_api.description=Public undocumented classes, methods and variables
-
-metric.statements.name=Statements
-metric.statements.description=Number of statements
-
-
-
-metric.class_complexity.name=Complexity /class
-metric.class_complexity.description=Complexity average by class
-
-metric.function_complexity.name=Complexity /method
-metric.function_complexity.description=Complexity average by method
-
-metric.file_complexity.name=Complexity /file
-metric.file_complexity.description=Complexity average by file
-
-metric.paragraph_complexity.name=Complexity /paragraph
-metric.paragraph_complexity.description=Complexity average by paragraph
-
-metric.class_complexity_distribution.name=Classes distribution /complexity
-metric.class_complexity_distribution.description=Classes distribution /complexity
-
-metric.function_complexity_distribution.name=Methods distribution /complexity
-metric.function_complexity_distribution.description=Methods distribution /complexity
-
-metric.file_complexity_distribution.name=Files distribution /complexity
-metric.file_complexity_distribution.description=Files distribution /complexity
-
-metric.paragraph_complexity_distribution.name=Paragraph distribution /complexity
-metric.paragraph_complexity_distribution.description=Paragraph distribution /complexity
-
-#--------------------------------------------------------------------------------------------------------------------
-#
-# UNIT TESTS
-#
-#--------------------------------------------------------------------------------------------------------------------
-
-metric.tests.name=Unit tests
-metric.tests.description=Number of unit tests
-
-metric.test_execution_time.name=Unit tests duration
-metric.test_execution_time.description=Execution duration of unit tests
-
-metric.test_errors.name=Unit test errors
-metric.test_errors.description=Number of unit test errors
-
-metric.skipped_tests.name=Skipped unit tests
-metric.skipped_tests.description=Number of skipped unit tests
-
-metric.test_failures.name=Unit test failures
-metric.test_failures.description=Number of unit test failures
-
-metric.test_success_density.name=Unit test success (%)
-metric.test_success_density.description=Density of successful unit tests
-
-metric.test_data.name=Unit tests details
-metric.test_data.description=Unit tests details
-
-metric.coverage.name=Coverage
-metric.coverage.description=Coverage by unit tests
-
-metric.new_coverage.name=New coverage
-metric.new_coverage.description=Coverage of new/changed code
-
-metric.lines_to_cover.name=Lines to cover
-metric.lines_to_cover.description=Lines to cover
-
-metric.new_lines_to_cover.name=New lines to cover
-metric.new_lines_to_cover.description=New lines to cover
-
-metric.uncovered_lines.name=Uncovered lines
-metric.uncovered_lines.description=Uncovered lines
-
-metric.new_uncovered_lines.name=New uncovered lines
-metric.new_uncovered_lines.description=New uncovered lines
-
-metric.line_coverage.name=Line coverage
-metric.line_coverage.description=Line coverage
-
-metric.new_line_coverage.name=New line coverage
-metric.new_line_coverage.description=Line coverage of added/changed code
-
-metric.coverage_line_hits_data.name=Coverage hits by line
-metric.coverage_line_hits_data.description=Coverage hits by line
-
-metric.conditions_to_cover.name=Branches to cover
-metric.conditions_to_cover.description=Branches to cover
-
-metric.new_conditions_to_cover.name=New branches to cover
-metric.new_conditions_to_cover.description=New branches to cover
-
-metric.uncovered_conditions.name=Uncovered branches
-metric.uncovered_conditions.description=Uncovered branches
-
-metric.new_uncovered_conditions.name=New uncovered branches
-metric.new_uncovered_conditions.description=New uncovered branches
-
-metric.branch_coverage.name=Branch coverage
-metric.branch_coverage.description=Branch coverage
-
-metric.new_branch_coverage.name=New branch coverage
-metric.new_branch_coverage.description=Branch coverage of new/changed code
-
-metric.branch_coverage_hits_data.name=Branch coverage hits
-metric.branch_coverage_hits_data.description=Branch coverage hits
-
-metric.conditions_by_line.name=Branches by line
-metric.conditions_by_line.description=Branches by line
-
-metric.covered_conditions_by_line.name=Covered branches by line
-metric.covered_conditions_by_line.description=Covered branches by line
-
-
-#--------------------------------------------------------------------------------------------------------------------
-#
-# INTEGRATION TESTS
-#
-#--------------------------------------------------------------------------------------------------------------------
-
-metric.it_coverage.name=IT Coverage
-metric.it_coverage.description=Integration Test Coverage
-
-metric.it_lines_to_cover.name=IT Lines to Cover
-metric.it_lines_to_cover.description=Lines to cover by Integration Tests
-
-metric.it_uncovered_lines.name=IT Uncovered Lines
-metric.it_uncovered_lines.description=Uncovered lines by Integration Tests
-
-metric.it_line_coverage.name=IT Line Coverage
-metric.it_line_coverage.description=Line coverage by Integration Tests
-
-metric.it_coverage_line_hits_data.name=IT Coverage hits by line
-metric.it_coverage_line_hits_data.description=Coverage hits by line by Integration Tests
-
-metric.it_conditions_to_cover.name=IT Branches to Cover
-metric.it_conditions_to_cover.description=Branches to cover by Integration Tests
-
-metric.it_uncovered_conditions.name=IT Uncovered Branches
-metric.it_uncovered_conditions.description=Uncovered branches by Integration Tests
-
-metric.it_branch_coverage.name=IT Branch Coverage
-metric.it_branch_coverage.description=Branch coverage by Integration Tests
-
-metric.it_conditions_by_line.name=IT Branches by Line
-metric.it_conditions_by_line.description=IT Branches by line
-
-metric.it_covered_conditions_by_line.name=IT Covered Branches by Line
-metric.it_covered_conditions_by_line.description=IT Covered branches by line
-
-metric.new_it_coverage.name=New IT Coverage
-metric.new_it_coverage.description=Integration Test Coverage of new/changed code
-
-metric.new_it_lines_to_cover.name=New Lines to Cover by IT
-metric.new_it_lines_to_cover.description=New lines to cover by integration tests
-
-metric.new_it_uncovered_lines.name=New Lines Uncovered by IT
-metric.new_it_uncovered_lines.description=New lines that are not covered by integration tests
-
-metric.new_it_line_coverage.name=New IT Line Coverage
-metric.new_it_line_coverage.description=Integration Test Line coverage of added/changed code
-
-metric.new_it_conditions_to_cover.name=New Branches to Cover by IT
-metric.new_it_conditions_to_cover.description=New branches to cover by integration tests
-
-metric.new_it_uncovered_conditions.name=New Branches Uncovered by IT
-metric.new_it_uncovered_conditions.description=New branches that are not covered by IT
-
-metric.new_it_branch_coverage.name=New IT Branch Coverage
-metric.new_it_branch_coverage.description=Integration Test Branch Coverage of new/changed code
-
-#--------------------------------------------------------------------------------------------------------------------
-#
-# DUPLICATIONS
-#
-#--------------------------------------------------------------------------------------------------------------------
-
-metric.duplicated_lines.name=Duplicated lines
-metric.duplicated_lines.description=Duplicated lines
-
-metric.duplicated_blocks.name=Duplicated blocks
-metric.duplicated_blocks.description=Duplicated blocks
-
-metric.duplicated_files.name=Duplicated files
-metric.duplicated_files.description=Duplicated files
-
-metric.duplicated_lines_density.name=Duplicated lines (%)
-metric.duplicated_lines_density.description=Duplicated lines balanced by statements
-
-metric.duplications_data.name=Duplications details
-metric.duplications_data.description=Duplications details
-
-#--------------------------------------------------------------------------------------------------------------------
-#
-# CODING RULES
-#
-#--------------------------------------------------------------------------------------------------------------------
-
-metric.usability.name=Usability
-metric.usability.description=Usability
-
-metric.reliability.name=Reliability
-metric.reliability.description=Reliability
-
-metric.efficiency.name=Efficiency
-metric.efficiency.description=Efficiency
-
-metric.portability.name=Portability
-metric.portability.description=Portability
-
-metric.maintainability.name=Maintainability
-metric.maintainability.description=Maintainability
-
-metric.weighted_violations.name=Weighted violations
-metric.weighted_violations.description=Weighted Violations
-
-metric.violations_density.name=Rules compliance
-metric.violations_density.description=Rules compliance
-
-metric.violations.name=Violations
-metric.violations.description=Violations
-
-metric.blocker_violations.name=Blocker violations
-metric.blocker_violations.description=Blocker violations
-
-metric.critical_violations.name=Critical violations
-metric.critical_violations.description=Critical violations
-
-metric.major_violations.name=Major violations
-metric.major_violations.description=Major violations
-
-metric.minor_violations.name=Minor violations
-metric.minor_violations.description=Minor violations
-
-metric.info_violations.name=Info violations
-metric.info_violations.description=Info violations
-
-metric.new_violations.name=New violations
-metric.new_violations.description=New Violations
-
-metric.new_blocker_violations.name=New Blocker violations
-metric.new_blocker_violations.description=New Blocker violations
-
-metric.new_critical_violations.name=New Critical violations
-metric.new_critical_violations.description=New Critical violations
-
-metric.new_major_violations.name=New Major violations
-metric.new_major_violations.description=New Major violations
-
-metric.new_minor_violations.name=New Minor violations
-metric.new_minor_violations.description=New Minor violations
-
-metric.new_info_violations.name=New Info violations
-metric.new_info_violations.description=New Info violations
-
-#--------------------------------------------------------------------------------------------------------------------
-#
-# DESIGN
-#
-#--------------------------------------------------------------------------------------------------------------------
-
-metric.abstractness.name=Abstractness
-metric.abstractness.description=Abstractness
-
-metric.instability.name=Instability
-metric.instability.description=Instability
-
-metric.distance.name=Distance
-metric.distance.description=Distance
-
-metric.dit.name=Depth in Tree
-metric.dit.description=Depth in Inheritance Tree
-
-metric.noc.name=Number of Children
-metric.noc.description=Number of Children
-
-metric.rfc.name=Response for Class
-metric.rfc.description=Response for Class
-
-metric.rfc_distribution.name=Class distribution /RFC
-metric.rfc_distribution.description=Class distribution /RFC
-
-metric.lcom4.name=LCOM4
-metric.lcom4.description=Lack of Cohesion of Methods
-
-metric.lcom4_blocks.name=LCOM4 blocks
-metric.lcom4_blocks.description=LCOM4 blocks
-
-metric.lcom4_distribution.name=Class distribution /LCOM4
-metric.lcom4_distribution.description=Class distribution /LCOM4
-
-metric.suspect_lcom4_density.name=Suspect LCOM4 density
-metric.suspect_lcom4_density.description=Density of classes having LCOM4>1
-
-metric.ca.name=Afferent couplings
-metric.ca.description=Afferent couplings
-
-metric.ce.name=Efferent couplings
-metric.ce.description=Efferent couplings
-
-metric.dsm.name=Dependency Matrix
-metric.dsm.description=Dependency Matrix
-
-metric.package_cycles.name=Package cycles
-metric.package_cycles.description=Package cycles
-
-metric.package_tangle_index.name=Package tangle index
-metric.package_tangle_index.description=Package tangle index
-
-metric.package_tangles.name=File dependencies to cut
-metric.package_tangles.description=File dependencies to cut
-
-metric.package_feedback_edges.name=Package dependencies to cut
-metric.package_feedback_edges.description=Package dependencies to cut
-
-metric.package_edges_weight.name=Package edges weight
-metric.package_edges_weight.description=Package edges weight
-
-metric.file_cycles.name=File cycles
-metric.file_cycles.description=File cycles
-
-metric.file_tangle_index.name=File tangle index
-metric.file_tangle_index.description=File tangle index
-
-metric.file_tangles.name=File tangles
-metric.file_tangles.description=Files tangles
-
-metric.file_feedback_edges.name=Suspect file dependencies
-metric.file_feedback_edges.description=Suspect file dependencies
-
-metric.file_edges_weight.name=File edges weight
-metric.file_edges_weight.description=File edges weight
-
-metric.commits.name=Commits
-metric.commits.description=Commits
-
-metric.last_commit_date.name=Last commit
-metric.last_commit_date.description=Last commit
-
-metric.revision.name=Revision
-metric.revision.description=Revision
-
-metric.authors_by_line.name=Authors by line
-metric.authors_by_line.description=Authors by line
-
-metric.revisions_by_line.name=Revisions by line
-metric.revisions_by_line.description=Revisions by line
-
-metric.last_commit_datetimes_by_line.name=Last commit dates by line
-metric.last_commit_datetimes_by_line.description=Last commit dates by line
-
-metric.profile.name=Profile
-metric.profile.description=Selected quality profile
-
-metric.profile_version.name=Profile version
-metric.profile_version.description=Selected quality profile version
-
-
-#--------------------------------------------------------------------------------------------------------------------
-#
-# MANUAL METRICS
-#
-#--------------------------------------------------------------------------------------------------------------------
-metric.burned_budget.name=Burned budget
-metric.burned_budget.description=The budget already used in the project
-
-metric.business_value.name=Business value
-metric.business_value.description=An indication on the value of the project for the business
-
-metric.team_size.name=Team size
-metric.team_size.description=Size of the project team
-
-
-#--------------------------------------------------------------------------------------------------------------------
-#
-# REVIEWS METRICS
-#
-#--------------------------------------------------------------------------------------------------------------------
-metric.unreviewed_violations.name=Unreviewed violations
-metric.unreviewed_violations.description=Violations that have not been reviewed yet
-
-metric.new_unreviewed_violations.name=New unreviewed violations
-metric.new_unreviewed_violations.description=New violations that have not been reviewed yet
-
-metric.false_positive_reviews.name=False-positive reviews
-metric.false_positive_reviews.description=Active false-positive reviews
-
-metric.active_reviews.name=Active reviews
-metric.active_reviews.description=Active open and reopened reviews
-
-metric.unassigned_reviews.name=Unassigned reviews
-metric.unassigned_reviews.description=Active unassigned reviews
-
-metric.unplanned_reviews.name=Unplanned reviews
-metric.unplanned_reviews.description=Active unplanned reviews
+++ /dev/null
-rule.findbugs.IMSE_DONT_CATCH_IMSE.name=Bad practice - Dubious catching of IllegalMonitorStateException
-rule.findbugs.BX_BOXING_IMMEDIATELY_UNBOXED.name=Performance - Primitive value is boxed and then immediately unboxed
-rule.findbugs.IJU_SETUP_NO_SUPER.name=Correctness - TestCase defines setUp that doesn't call super.setUp()
-rule.findbugs.TQ_ALWAYS_VALUE_USED_WHERE_NEVER_REQUIRED.name=Correctness - Value annotated as carrying a type qualifier used where a value that must not carry that qualifier is required
-rule.findbugs.TLW_TWO_LOCK_WAIT.name=Multithreaded correctness - Wait with two locks held
-rule.findbugs.RV_01_TO_INT.name=Correctness - Random value from 0 to 1 is coerced to the integer 0
-rule.findbugs.NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE.name=Dodgy - Parameter must be nonnull but is marked as nullable
-rule.findbugs.RV_ABSOLUTE_VALUE_OF_RANDOM_INT.name=Correctness - Bad attempt to compute absolute value of signed 32-bit random integer
-rule.findbugs.EC_INCOMPATIBLE_ARRAY_COMPARE.name=Correctness - equals(...) used to compare incompatible arrays
-rule.findbugs.UL_UNRELEASED_LOCK_EXCEPTION_PATH.name=Multithreaded correctness - Method does not release lock on all exception paths
-rule.findbugs.SE_NONSTATIC_SERIALVERSIONID.name=Bad practice - serialVersionUID isn't static
-rule.findbugs.UCF_USELESS_CONTROL_FLOW.name=Dodgy - Useless control flow
-rule.findbugs.BC_IMPOSSIBLE_CAST.name=Correctness - Impossible cast
-rule.findbugs.XSS_REQUEST_PARAMETER_TO_SEND_ERROR.name=Security - Servlet reflected cross site scripting vulnerability
-rule.findbugs.DM_NEW_FOR_GETCLASS.name=Performance - Method allocates an object, only to get the class object
-rule.findbugs.OBL_UNSATISFIED_OBLIGATION.name=Experimental - Method may fail to clean up stream or resource
-rule.findbugs.UW_UNCOND_WAIT.name=Multithreaded correctness - Unconditional wait
-rule.findbugs.DLS_DEAD_LOCAL_STORE_OF_NULL.name=Dodgy - Dead store of null to local variable
-rule.findbugs.NM_CLASS_NAMING_CONVENTION.name=Class names should start with an upper case letter
-rule.findbugs.RC_REF_COMPARISON_BAD_PRACTICE_BOOLEAN.name=Correctness - Suspicious reference comparison of Boolean values
-rule.findbugs.MWN_MISMATCHED_NOTIFY.name=Multithreaded correctness - Mismatched notify()
-rule.findbugs.NM_VERY_CONFUSING.name=Correctness - Very confusing method names
-rule.findbugs.FI_NULLIFY_SUPER.name=Bad practice - Finalizer nullifies superclass finalizer
-rule.findbugs.MTIA_SUSPECT_STRUTS_INSTANCE_FIELD.name=Dodgy - Class extends Struts Action class and uses instance variables
-rule.findbugs.DM_STRING_CTOR.name=Performance - Method invokes inefficient new String(String) constructor
-rule.findbugs.STCAL_INVOKE_ON_STATIC_DATE_FORMAT_INSTANCE.name=Multithreaded correctness - Call to static DateFormat
-rule.findbugs.NP_NULL_PARAM_DEREF_NONVIRTUAL.name=Correctness - Non-virtual method call passes null for nonnull parameter
-rule.findbugs.FI_EMPTY.name=Bad practice - Empty finalizer should be deleted
-rule.findbugs.CD_CIRCULAR_DEPENDENCY.name=Experimental - Test for circular dependencies among classes
-rule.findbugs.EC_UNRELATED_TYPES.name=Correctness - Call to equals() comparing different types
-rule.findbugs.EI_EXPOSE_STATIC_REP2.name=Malicious code vulnerability - May expose internal static state by storing a mutable object into a static field
-rule.findbugs.DMI_INVOKING_TOSTRING_ON_ANONYMOUS_ARRAY.name=Correctness - Invocation of toString on an anonymous array
-rule.findbugs.SIC_INNER_SHOULD_BE_STATIC_ANON.name=Performance - Could be refactored into a named static inner class
-rule.findbugs.STI_INTERRUPTED_ON_UNKNOWNTHREAD.name=Correctness - Static Thread.interrupted() method invoked on thread instance
-rule.findbugs.CN_IDIOM_NO_SUPER_CALL.name=Bad practice - clone method does not call super.clone()
-rule.findbugs.VA_FORMAT_STRING_BAD_ARGUMENT.name=Correctness - Format string placeholder incompatible with passed argument
-rule.findbugs.EQ_DOESNT_OVERRIDE_EQUALS.name=Dodgy - Class doesn't override equals in superclass
-rule.findbugs.BC_IMPOSSIBLE_DOWNCAST_OF_TOARRAY.name=Correctness - Impossible downcast of toArray() result
-rule.findbugs.SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION.name=Bad practice - Class is Externalizable but doesn't define a void constructor
-rule.findbugs.TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_ALWAYS_SINK.name=Correctness - Value required to have type qualifier, but marked as unknown
-rule.findbugs.SIC_INNER_SHOULD_BE_STATIC_NEEDS_THIS.name=Performance - Could be refactored into a static inner class
-rule.findbugs.EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS.name=Bad practice - Equals checks for noncompatible operand
-rule.findbugs.RV_RETURN_VALUE_OF_PUTIFABSENT_IGNORED.name=Correctness - Return value of putIfAbsent ignored, value passed to putIfAbsent reused
-rule.findbugs.STCAL_INVOKE_ON_STATIC_CALENDAR_INSTANCE.name=Multithreaded correctness - Call to static Calendar
-rule.findbugs.MS_CANNOT_BE_FINAL.name=Malicious code vulnerability - Field isn't final and can't be protected from malicious code
-rule.findbugs.IS_INCONSISTENT_SYNC.name=Multithreaded correctness - Inconsistent synchronization
-rule.findbugs.SE_NO_SERIALVERSIONID.name=Bad practice - Class is Serializable, but doesn't define serialVersionUID
-rule.findbugs.EI_EXPOSE_REP2.name=Malicious code vulnerability - May expose internal representation by incorporating reference to mutable object
-rule.findbugs.NM_METHOD_CONSTRUCTOR_CONFUSION.name=Correctness - Apparent method/constructor confusion
-rule.findbugs.ICAST_INTEGER_MULTIPLY_CAST_TO_LONG.name=Dodgy - Result of integer multiplication cast to long
-rule.findbugs.QF_QUESTIONABLE_FOR_LOOP.name=Dodgy - Complicated, subtle or wrong increment in for-loop
-rule.findbugs.DLS_DEAD_STORE_OF_CLASS_LITERAL.name=Correctness - Dead store of class literal
-rule.findbugs.NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER.name=Bad practice - Use of identifier that is a keyword in later versions of Java
-rule.findbugs.BC_VACUOUS_INSTANCEOF.name=Dodgy - instanceof will always return true
-rule.findbugs.INT_VACUOUS_BIT_OPERATION.name=Dodgy - Vacuous bit mask operation on integer value
-rule.findbugs.NP_NULL_INSTANCEOF.name=Correctness - A known null value is checked to see if it is an instance of a type
-rule.findbugs.SIC_THREADLOCAL_DEADLY_EMBRACE.name=Correctness - Deadly embrace of non-static inner class and thread local
-rule.findbugs.EQ_UNUSUAL.name=Dodgy - Unusual equals method
-rule.findbugs.IJU_NO_TESTS.name=Correctness - TestCase has no tests
-rule.findbugs.EQ_OVERRIDING_EQUALS_NOT_SYMMETRIC.name=Correctness - equals method overrides equals in superclass and may not be symmetric
-rule.findbugs.XFB_XML_FACTORY_BYPASS.name=Dodgy - Method directly allocates a specific implementation of xml interfaces
-rule.findbugs.SWL_SLEEP_WITH_LOCK_HELD.name=Multithreaded correctness - Method calls Thread.sleep() with a lock held
-rule.findbugs.CN_IDIOM.name=Bad practice - Class implements Cloneable but does not define or use clone method
-rule.findbugs.WA_AWAIT_NOT_IN_LOOP.name=Multithreaded correctness - Condition.await() not in loop
-rule.findbugs.DM_FP_NUMBER_CTOR.name=Performance - Method invokes inefficient floating-point Number constructor; use static valueOf instead
-rule.findbugs.SF_SWITCH_NO_DEFAULT.name=Switch statement found where default case is missing
-rule.findbugs.NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE.name=Dodgy - Possible null pointer dereference due to return value of called method
-rule.findbugs.NP_CLONE_COULD_RETURN_NULL.name=Bad practice - Clone method may return null
-rule.findbugs.MS_OOI_PKGPROTECT.name=Malicious code vulnerability - Field should be moved out of an interface and made package protected
-rule.findbugs.DM_BOXED_PRIMITIVE_TOSTRING.name=Performance - Method allocates a boxed primitive just to call toString
-rule.findbugs.EQ_ABSTRACT_SELF.name=Bad practice - Abstract class defines covariant equals() method
-rule.findbugs.DM_STRING_TOSTRING.name=Performance - Method invokes toString() method on a String
-rule.findbugs.SE_METHOD_MUST_BE_PRIVATE.name=Correctness - Method must be private in order for serialization to work
-rule.findbugs.DL_SYNCHRONIZATION_ON_BOOLEAN.name=Multithreaded correctness - Synchronization on Boolean could lead to deadlock
-rule.findbugs.UWF_UNWRITTEN_FIELD.name=Correctness - Unwritten field
-rule.findbugs.IS2_INCONSISTENT_SYNC.name=Multithreaded correctness - Inconsistent synchronization
-rule.findbugs.IM_AVERAGE_COMPUTATION_COULD_OVERFLOW.name=Dodgy - Computation of average could overflow
-rule.findbugs.BIT_SIGNED_CHECK_HIGH_BIT.name=Correctness - Check for sign of bitwise operation
-rule.findbugs.FL_MATH_USING_FLOAT_PRECISION.name=Correctness - Method performs math using floating point precision
-rule.findbugs.WS_WRITEOBJECT_SYNC.name=Multithreaded correctness - Class's writeObject() method is synchronized but nothing else is
-rule.findbugs.RV_RETURN_VALUE_IGNORED.name=Correctness - Method ignores return value
-rule.findbugs.SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE.name=Security - Nonconstant string passed to execute method on an SQL statement
-rule.findbugs.JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS.name=Bad practice - Fields of immutable classes should be final
-rule.findbugs.AM_CREATES_EMPTY_ZIP_FILE_ENTRY.name=Bad practice - Creates an empty zip file entry
-rule.findbugs.DM_NEXTINT_VIA_NEXTDOUBLE.name=Performance - Use the nextInt method of Random rather than nextDouble to generate a random integer
-rule.findbugs.UI_INHERITANCE_UNSAFE_GETRESOURCE.name=Bad practice - Usage of GetResource may be unsafe if class is extended
-rule.findbugs.SIO_SUPERFLUOUS_INSTANCEOF.name=Correctness - Unnecessary type check done using instanceof operator
-rule.findbugs.EQ_OTHER_NO_OBJECT.name=Correctness - equals() method defined that doesn't override equals(Object)
-rule.findbugs.USM_USELESS_ABSTRACT_METHOD.name=Experimental - Abstract Method is already defined in implemented interface
-rule.findbugs.MTIA_SUSPECT_SERVLET_INSTANCE_FIELD.name=Dodgy - Class extends Servlet class and uses instance variables
-rule.findbugs.DM_USELESS_THREAD.name=Multithreaded correctness - A thread was created using the default empty run method
-rule.findbugs.ML_SYNC_ON_UPDATED_FIELD.name=Multithreaded correctness - Method synchronizes on an updated field
-rule.findbugs.CO_SELF_NO_OBJECT.name=Bad practice - Covariant compareTo() method defined
-rule.findbugs.BC_UNCONFIRMED_CAST.name=Dodgy - Unchecked/unconfirmed cast
-rule.findbugs.FI_FINALIZER_NULLS_FIELDS.name=Bad practice - Finalizer nulls fields
-rule.findbugs.BIT_AND.name=Correctness - Incompatible bit masks (BIT_AND)
-rule.findbugs.FE_FLOATING_POINT_EQUALITY.name=Dodgy - Test for floating point equality
-rule.findbugs.TQ_EXPLICIT_UNKNOWN_SOURCE_VALUE_REACHES_NEVER_SINK.name=Correctness - Value required to not have type qualifier, but marked as unknown
-rule.findbugs.NP_NULL_PARAM_DEREF.name=Correctness - Method call passes null for nonnull parameter
-rule.findbugs.FB_MISSING_EXPECTED_WARNING.name=Experimental - Missing expected or desired warning from FindBugs
-rule.findbugs.DMI_INVOKING_HASHCODE_ON_ARRAY.name=Correctness - Invocation of hashCode on an array
-rule.findbugs.QBA_QUESTIONABLE_BOOLEAN_ASSIGNMENT.name=Correctness - Method assigns boolean literal in boolean expression
-rule.findbugs.SA_FIELD_SELF_COMPARISON.name=Correctness - Self comparison of field with itself
-rule.findbugs.UR_UNINIT_READ_CALLED_FROM_SUPER_CONSTRUCTOR.name=Correctness - Uninitialized read of field method called from constructor of superclass
-rule.findbugs.ES_COMPARING_PARAMETER_STRING_WITH_EQ.name=Bad practice - Comparison of String parameter using == or !=
-rule.findbugs.INT_BAD_COMPARISON_WITH_NONNEGATIVE_VALUE.name=Correctness - Bad comparison of nonnegative value with negative constant
-rule.findbugs.INT_BAD_COMPARISON_WITH_SIGNED_BYTE.name=Correctness - Bad comparison of signed byte
-rule.findbugs.IO_APPENDING_TO_OBJECT_OUTPUT_STREAM.name=Correctness - Doomed attempt to append to an object output stream
-rule.findbugs.FI_MISSING_SUPER_CALL.name=Bad practice - Finalizer does not call superclass finalizer
-rule.findbugs.VA_FORMAT_STRING_EXTRA_ARGUMENTS_PASSED.name=Correctness - More arguments are passed that are actually used in the format string
-rule.findbugs.HE_EQUALS_USE_HASHCODE.name=Bad practice - Class defines equals() and uses Object.hashCode()
-rule.findbugs.IJU_BAD_SUITE_METHOD.name=Correctness - TestCase declares a bad suite method
-rule.findbugs.DMI_CONSTANT_DB_PASSWORD.name=Security - Hardcoded constant database password
-rule.findbugs.REC_CATCH_EXCEPTION.name=Dodgy - Exception is caught when Exception is not thrown
-rule.findbugs.PS_PUBLIC_SEMAPHORES.name=Dodgy - Class exposes synchronization and semaphores in its public interface
-rule.findbugs.EC_UNRELATED_INTERFACES.name=Correctness - Call to equals() comparing different interface types
-rule.findbugs.UCF_USELESS_CONTROL_FLOW_NEXT_LINE.name=Correctness - Useless control flow to next line
-rule.findbugs.LG_LOST_LOGGER_DUE_TO_WEAK_REFERENCE.name=Experimental - Potential lost logger changes due to weak reference in OpenJDK
-rule.findbugs.NP_UNWRITTEN_FIELD.name=Correctness - Read of unwritten field
-rule.findbugs.DMI_UNSUPPORTED_METHOD.name=Dodgy - Call to unsupported method
-rule.findbugs.RCN_REDUNDANT_COMPARISON_OF_NULL_AND_NONNULL_VALUE.name=Dodgy - Redundant comparison of non-null value to null
-rule.findbugs.EC_BAD_ARRAY_COMPARE.name=Correctness - Invocation of equals() on an array, which is equivalent to ==
-rule.findbugs.EI_EXPOSE_REP.name=Malicious code vulnerability - May expose internal representation by returning reference to mutable object
-rule.findbugs.NP_DEREFERENCE_OF_READLINE_VALUE.name=Dodgy - Dereference of the result of readLine() without nullcheck
-rule.findbugs.UPM_UNCALLED_PRIVATE_METHOD.name=Performance - Private method is never called
-rule.findbugs.NP_NULL_ON_SOME_PATH.name=Correctness - Possible null pointer dereference
-rule.findbugs.NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT.name=Bad practice - equals() method does not check for null argument
-rule.findbugs.EC_NULL_ARG.name=Correctness - Call to equals() with null argument
-rule.findbugs.SE_BAD_FIELD_STORE.name=Bad practice - Non-serializable value stored into instance field of a serializable class
-rule.findbugs.VO_VOLATILE_REFERENCE_TO_ARRAY.name=Multithreaded correctness - A volatile reference to an array doesn't treat the array elements as volatile
-rule.findbugs.NP_SYNC_AND_NULL_CHECK_FIELD.name=Multithreaded correctness - Synchronize and null check on the same field.
-rule.findbugs.DM_EXIT.name=Bad practice - Method invokes System.exit(...)
-rule.findbugs.RC_REF_COMPARISON.name=Bad practice - Suspicious reference comparison
-rule.findbugs.SE_NO_SUITABLE_CONSTRUCTOR.name=Bad practice - Class is Serializable but its superclass doesn't define a void constructor
-rule.findbugs.DC_DOUBLECHECK.name=Multithreaded correctness - Possible double check of field
-rule.findbugs.DMI_LONG_BITS_TO_DOUBLE_INVOKED_ON_INT.name=Correctness - Double.longBitsToDouble invoked on an int
-rule.findbugs.RpC_REPEATED_CONDITIONAL_TEST.name=Correctness - Repeated conditional tests
-rule.findbugs.WMI_WRONG_MAP_ITERATOR.name=Performance - Inefficient use of keySet iterator instead of entrySet iterator
-rule.findbugs.DLS_DEAD_LOCAL_STORE.name=Dodgy - Dead store to local variable
-rule.findbugs.INT_BAD_REM_BY_1.name=Correctness - Integer remainder modulo 1
-rule.findbugs.RV_RETURN_VALUE_IGNORED_BAD_PRACTICE.name=Bad practice - Method ignores exceptional return value
-rule.findbugs.SA_LOCAL_SELF_ASSIGNMENT.name=Dodgy - Self assignment of local variable
-rule.findbugs.MS_SHOULD_BE_FINAL.name=Malicious code vulnerability - Field isn't final but should be
-rule.findbugs.SIC_INNER_SHOULD_BE_STATIC.name=Performance - Should be a static inner class
-rule.findbugs.NP_GUARANTEED_DEREF.name=Correctness - Null value is guaranteed to be dereferenced
-rule.findbugs.SE_READ_RESOLVE_MUST_RETURN_OBJECT.name=Bad practice - The readResolve method must be declared with a return type of Object.
-rule.findbugs.NP_LOAD_OF_KNOWN_NULL_VALUE.name=Dodgy - Load of known null value
-rule.findbugs.BX_BOXING_IMMEDIATELY_UNBOXED_TO_PERFORM_COERCION.name=Performance - Primitive value is boxed then unboxed to perform primitive coercion
-rule.findbugs.CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE.name=Bad practice - Class defines clone() but doesn't implement Cloneable
-rule.findbugs.CO_ABSTRACT_SELF.name=Bad practice - Abstract class defines covariant compareTo() method
-rule.findbugs.BAC_BAD_APPLET_CONSTRUCTOR.name=Experimental - Bad Applet Constructor relies on uninitialized AppletStub
-rule.findbugs.EQ_GETCLASS_AND_CLASS_CONSTANT.name=Bad practice - equals method fails for subtypes
-rule.findbugs.DB_DUPLICATE_SWITCH_CLAUSES.name=Dodgy - Method uses the same code for two switch clauses
-rule.findbugs.DB_DUPLICATE_BRANCHES.name=Dodgy - Method uses the same code for two branches
-rule.findbugs.UOE_USE_OBJECT_EQUALS.name=Experimental - Calls to equals on a final class that doesn't override Object's equals method
-rule.findbugs.FI_USELESS.name=Bad practice - Finalizer does nothing but call superclass finalizer
-rule.findbugs.NP_ALWAYS_NULL.name=Correctness - Null pointer dereference
-rule.findbugs.DMI_VACUOUS_SELF_COLLECTION_CALL.name=Correctness - Vacuous call to collections
-rule.findbugs.DLS_DEAD_LOCAL_STORE_IN_RETURN.name=Correctness - Useless assignment in return statement
-rule.findbugs.IJU_ASSERT_METHOD_INVOKED_FROM_RUN_METHOD.name=Correctness - JUnit assertion in run method will not be noticed by JUnit
-rule.findbugs.DMI_EMPTY_DB_PASSWORD.name=Security - Empty database password
-rule.findbugs.DM_BOOLEAN_CTOR.name=Performance - Method invokes inefficient Boolean constructor; use Boolean.valueOf(...) instead
-rule.findbugs.BC_IMPOSSIBLE_DOWNCAST.name=Correctness - Impossible downcast
-rule.findbugs.BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS.name=Bad practice - Equals method should not assume anything about the type of its argument
-rule.findbugs.RV_EXCEPTION_NOT_THROWN.name=Correctness - Exception created and dropped rather than thrown
-rule.findbugs.VA_PRIMITIVE_ARRAY_PASSED_TO_OBJECT_VARARG.name=Correctness - Primitive array passed to function expecting a variable number of object arguments
-rule.findbugs.LI_LAZY_INIT_UPDATE_STATIC.name=Multithreaded correctness - Incorrect lazy initialization and update of static field
-rule.findbugs.SA_FIELD_SELF_ASSIGNMENT.name=Correctness - Self assignment of field
-rule.findbugs.EQ_ALWAYS_FALSE.name=Correctness - equals method always returns false
-rule.findbugs.DMI_RANDOM_USED_ONLY_ONCE.name=Bad practice - Random object created and used only once
-rule.findbugs.NM_CLASS_NOT_EXCEPTION.name=Bad practice - Class is not derived from an Exception, even though it is named as such
-rule.findbugs.SA_LOCAL_DOUBLE_ASSIGNMENT.name=Dodgy - Double assignment of local variable
-rule.findbugs.NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS.name=Correctness - Method call passes null for nonnull parameter (ALL_TARGETS_DANGEROUS)
-rule.findbugs.NP_TOSTRING_COULD_RETURN_NULL.name=Bad practice - toString method may return null
-rule.findbugs.BC_BAD_CAST_TO_ABSTRACT_COLLECTION.name=Dodgy - Questionable cast to abstract collection
-rule.findbugs.NM_LCASE_HASHCODE.name=Class defines hashcode(); should it be hashCode()?
-rule.findbugs.RU_INVOKE_RUN.name=Multithreaded correctness - Invokes run on a thread (did you mean to start it instead?)
-rule.findbugs.DMI_INVOKING_TOSTRING_ON_ARRAY.name=Correctness - Invocation of toString on an array
-rule.findbugs.NM_METHOD_NAMING_CONVENTION.name=Method names should start with a lower case letter
-rule.findbugs.RCN_REDUNDANT_COMPARISON_TWO_NULL_VALUES.name=Dodgy - Redundant comparison of two null values
-rule.findbugs.SA_LOCAL_SELF_COMPUTATION.name=Correctness - Nonsensical self computation involving a variable (e.g., x & x)
-rule.findbugs.MS_MUTABLE_HASHTABLE.name=Malicious code vulnerability - Field is a mutable Hashtable
-rule.findbugs.RV_DONT_JUST_NULL_CHECK_READLINE.name=Dodgy - Method discards result of readLine after checking if it is nonnull
-rule.findbugs.ES_COMPARING_STRINGS_WITH_EQ.name=Bad practice - Comparison of String objects using == or !=
-rule.findbugs.DL_SYNCHRONIZATION_ON_SHARED_CONSTANT.name=Multithreaded correctness - Synchronization on interned String could lead to deadlock
-rule.findbugs.MF_METHOD_MASKS_FIELD.name=Correctness - Method defines a variable that obscures a field
-rule.findbugs.EQ_SELF_USE_OBJECT.name=Correctness - Covariant equals() method defined, Object.equals(Object) inherited
-rule.findbugs.ICAST_INT_CAST_TO_FLOAT_PASSED_TO_ROUND.name=Correctness - int value cast to float and then passed to Math.round
-rule.findbugs.GC_UNRELATED_TYPES.name=Correctness - No relationship between generic parameter and method argument
-rule.findbugs.BC_IMPOSSIBLE_INSTANCEOF.name=Correctness - instanceof will always return false
-rule.findbugs.SBSC_USE_STRINGBUFFER_CONCATENATION.name=Performance - Method concatenates strings using + in a loop
-rule.findbugs.ICAST_INT_CAST_TO_DOUBLE_PASSED_TO_CEIL.name=Correctness - int value cast to double and then passed to Math.ceil
-rule.findbugs.UG_SYNC_SET_UNSYNC_GET.name=Multithreaded correctness - Unsynchronized get method, synchronized set method
-rule.findbugs.RE_BAD_SYNTAX_FOR_REGULAR_EXPRESSION.name=Correctness - Invalid syntax for regular expression
-rule.findbugs.SA_FIELD_SELF_COMPUTATION.name=Correctness - Nonsensical self computation involving a field (e.g., x & x)
-rule.findbugs.DMI_SCHEDULED_THREAD_POOL_EXECUTOR_WITH_ZERO_CORE_THREADS.name=Correctness - Creation of ScheduledThreadPoolExecutor with zero core threads
-rule.findbugs.DMI_USELESS_SUBSTRING.name=Dodgy - Invocation of substring(0), which returns the original value
-rule.findbugs.IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD.name=Dodgy - Ambiguous invocation of either an inherited or outer method
-rule.findbugs.OS_OPEN_STREAM.name=Bad practice - Method may fail to close stream
-rule.findbugs.HE_INHERITS_EQUALS_USE_HASHCODE.name=Bad practice - Class inherits equals() and uses Object.hashCode()
-rule.findbugs.SE_NONFINAL_SERIALVERSIONID.name=Bad practice - serialVersionUID isn't final
-rule.findbugs.EQ_SELF_NO_OBJECT.name=Bad practice - Covariant equals() method defined
-rule.findbugs.SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH.name=Dead store due to switch statement fall through
-rule.findbugs.SW_SWING_METHODS_INVOKED_IN_SWING_THREAD.name=Bad practice - Certain swing methods needs to be invoked in Swing thread
-rule.findbugs.VA_FORMAT_STRING_ILLEGAL.name=Correctness - Illegal format string
-rule.findbugs.DM_NUMBER_CTOR.name=Performance - Method invokes inefficient Number constructor; use static valueOf instead
-rule.findbugs.RV_REM_OF_RANDOM_INT.name=Dodgy - Remainder of 32-bit signed random integer
-rule.findbugs.EQ_COMPARING_CLASS_NAMES.name=Correctness - equals method compares class names rather than class objects
-rule.findbugs.ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD.name=Dodgy - Write to static field from instance method
-rule.findbugs.TQ_NEVER_VALUE_USED_WHERE_ALWAYS_REQUIRED.name=Correctness - Value annotated as never carrying a type qualifier used where value carrying that qualifier is required
-rule.findbugs.NS_NON_SHORT_CIRCUIT.name=Dodgy - Questionable use of non-short-circuit logic
-rule.findbugs.VA_FORMAT_STRING_NO_PREVIOUS_ARGUMENT.name=Correctness - No previous argument for format string
-rule.findbugs.SE_PRIVATE_READ_RESOLVE_NOT_INHERITED.name=Dodgy - private readResolve method not inherited by subclasses
-rule.findbugs.RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE.name=Dodgy - Redundant nullcheck of value known to be non-null
-rule.findbugs.NM_LCASE_TOSTRING.name=Class defines tostring(); should it be toString()?
-rule.findbugs.HSC_HUGE_SHARED_STRING_CONSTANT.name=Performance - Huge string constants is duplicated across multiple class files
-rule.findbugs.SE_TRANSIENT_FIELD_NOT_RESTORED.name=Bad practice - Transient field that isn't set by deserialization.
-rule.findbugs.JLM_JSR166_LOCK_MONITORENTER.name=Multithreaded correctness - Synchronization performed on java.util.concurrent Lock
-rule.findbugs.EQ_ALWAYS_TRUE.name=Correctness - equals method always returns true
-rule.findbugs.ISC_INSTANTIATE_STATIC_CLASS.name=Bad practice - Needless instantiation of class that only supplies static methods
-rule.findbugs.ICAST_IDIV_CAST_TO_DOUBLE.name=Dodgy - int division result cast to double or float
-rule.findbugs.RC_REF_COMPARISON_BAD_PRACTICE.name=Correctness - Suspicious reference comparison to constant
-rule.findbugs.FI_EXPLICIT_INVOCATION.name=Bad practice - Explicit invocation of finalizer
-rule.findbugs.ESync_EMPTY_SYNC.name=Multithreaded correctness - Empty synchronized block
-rule.findbugs.DMI_USING_REMOVEALL_TO_CLEAR_COLLECTION.name=Correctness - Don't use removeAll to clear a collection
-rule.findbugs.SE_BAD_FIELD.name=Non-transient non-serializable instance field in serializable class
-rule.findbugs.NP_STORE_INTO_NONNULL_FIELD.name=Correctness - Store of null value into field annotated NonNull
-rule.findbugs.IT_NO_SUCH_ELEMENT.name=Bad practice - Iterator next() method can't throw NoSuchElementException
-rule.findbugs.HRS_REQUEST_PARAMETER_TO_HTTP_HEADER.name=Security - HTTP Response splitting vulnerability
-rule.findbugs.DMI_THREAD_PASSED_WHERE_RUNNABLE_EXPECTED.name=Dodgy - Thread passed where Runnable expected
-rule.findbugs.NP_GUARANTEED_DEREF_ON_EXCEPTION_PATH.name=Correctness - Value is null and guaranteed to be dereferenced on exception path
-rule.findbugs.RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE.name=Dodgy - Redundant nullcheck of value known to be null
-rule.findbugs.DMI_CALLING_NEXT_FROM_HASNEXT.name=Correctness - hasNext method invokes next
-rule.findbugs.HE_HASHCODE_USE_OBJECT_EQUALS.name=Bad practice - Class defines hashCode() and uses Object.equals()
-rule.findbugs.VA_FORMAT_STRING_EXPECTED_MESSAGE_FORMAT_SUPPLIED.name=Correctness - MessageFormat supplied where printf style format expected
-rule.findbugs.NP_BOOLEAN_RETURN_NULL.name=Bad practice - Method with Boolean return type returns explicit null
-rule.findbugs.RI_REDUNDANT_INTERFACES.name=Dodgy - Class implements same interface as superclass
-rule.findbugs.DL_SYNCHRONIZATION_ON_UNSHARED_BOXED_PRIMITIVE.name=Multithreaded correctness - Synchronization on boxed primitive values
-rule.findbugs.STCAL_STATIC_CALENDAR_INSTANCE.name=Multithreaded correctness - Static Calendar
-rule.findbugs.RR_NOT_CHECKED.name=Bad practice - Method ignores results of InputStream.read()
-rule.findbugs.IL_INFINITE_RECURSIVE_LOOP.name=Correctness - An apparent infinite recursive loop
-rule.findbugs.DMI_NONSERIALIZABLE_OBJECT_WRITTEN.name=Dodgy - Non serializable object written to ObjectOutput
-rule.findbugs.GC_UNCHECKED_TYPE_IN_GENERIC_CALL.name=Bad practice - Unchecked type in generic call
-rule.findbugs.IMA_INEFFICIENT_MEMBER_ACCESS.name=Experimental - Method accesses a private member variable of owning class
-rule.findbugs.FI_PUBLIC_SHOULD_BE_PROTECTED.name=Malicious code vulnerability - Finalizer should be protected, not public
-rule.findbugs.RV_CHECK_FOR_POSITIVE_INDEXOF.name=Dodgy - Method checks to see if result of String.indexOf is positive
-rule.findbugs.ICAST_QUESTIONABLE_UNSIGNED_RIGHT_SHIFT.name=Dodgy - Unsigned right shift cast to short/byte
-rule.findbugs.DM_STRING_VOID_CTOR.name=Performance - Method invokes inefficient new String() constructor
-rule.findbugs.RE_POSSIBLE_UNINTENDED_PATTERN.name=Correctness - "." used for regular expression
-rule.findbugs.WL_USING_GETCLASS_RATHER_THAN_CLASS_LITERAL.name=Multithreaded correctness - Sychronization on getClass rather than class literal
-rule.findbugs.ICAST_BAD_SHIFT_AMOUNT.name=Correctness - Integer shift by an amount not in the range 0..31
-rule.findbugs.SF_SWITCH_FALLTHROUGH.name=Switch statement found where one case falls through to the next case
-rule.findbugs.DP_DO_INSIDE_DO_PRIVILEGED.name=Bad practice - Method invoked that should be only be invoked inside a doPrivileged block
-rule.findbugs.NO_NOTIFY_NOT_NOTIFYALL.name=Multithreaded correctness - Using notify() rather than notifyAll()
-rule.findbugs.SS_SHOULD_BE_STATIC.name=Performance - Unread field: should this field be static?
-rule.findbugs.DM_RUN_FINALIZERS_ON_EXIT.name=Bad practice - Method invokes dangerous method runFinalizersOnExit
-rule.findbugs.MS_FINAL_PKGPROTECT.name=Malicious code vulnerability - Field should be both final and package protected
-rule.findbugs.BC_BAD_CAST_TO_CONCRETE_COLLECTION.name=Dodgy - Questionable cast to concrete collection
-rule.findbugs.BIT_IOR_OF_SIGNED_BYTE.name=Correctness - Bitwise OR of signed byte value
-rule.findbugs.MSF_MUTABLE_SERVLET_FIELD.name=Multithreaded correctness - Mutable servlet field
-rule.findbugs.SE_BAD_FIELD_INNER_CLASS.name=Bad practice - Non-serializable class has a serializable inner class
-rule.findbugs.BIT_ADD_OF_SIGNED_BYTE.name=Correctness - Bitwise add of signed byte value
-rule.findbugs.FI_FINALIZER_ONLY_NULLS_FIELDS.name=Bad practice - Finalizer only nulls fields
-rule.findbugs.DE_MIGHT_IGNORE.name=Bad practice - Method might ignore exception
-rule.findbugs.XSS_REQUEST_PARAMETER_TO_SERVLET_WRITER.name=Security - Servlet reflected cross site scripting vulnerability
-rule.findbugs.ML_SYNC_ON_FIELD_TO_GUARD_CHANGING_THAT_FIELD.name=Multithreaded correctness - Synchronization on field in futile attempt to guard that field
-rule.findbugs.SQL_BAD_PREPARED_STATEMENT_ACCESS.name=Correctness - Method attempts to access a prepared statement parameter with index 0
-rule.findbugs.DM_CONVERT_CASE.name=Internationalization - Consider using Locale parameterized version of invoked method
-rule.findbugs.SE_TRANSIENT_FIELD_OF_NONSERIALIZABLE_CLASS.name=Dodgy - Transient field of class that isn't Serializable.
-rule.findbugs.NN_NAKED_NOTIFY.name=Multithreaded correctness - Naked notify
-rule.findbugs.VA_FORMAT_STRING_MISSING_ARGUMENT.name=Correctness - Format string references missing argument
-rule.findbugs.IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION.name=Bad practice - Superclass uses subclass during initialization
-rule.findbugs.SA_LOCAL_SELF_COMPARISON.name=Correctness - Self comparison of value with itself
-rule.findbugs.IM_BAD_CHECK_FOR_ODD.name=Dodgy - Check for oddness that won't work for negative numbers
-rule.findbugs.NP_CLOSING_NULL.name=Correctness - close() invoked on a value that is always null
-rule.findbugs.XSS_REQUEST_PARAMETER_TO_JSP_WRITER.name=Security - JSP reflected cross site scripting vulnerability
-rule.findbugs.IS_FIELD_NOT_GUARDED.name=Multithreaded correctness - Field not guarded against concurrent access
-rule.findbugs.DM_GC.name=Performance - Explicit garbage collection; extremely dubious except in benchmarking code
-rule.findbugs.IM_MULTIPLYING_RESULT_OF_IREM.name=Correctness - Integer multiply of result of integer remainder
-rule.findbugs.SE_COMPARATOR_SHOULD_BE_SERIALIZABLE.name=Bad practice - Comparator doesn't implement Serializable
-rule.findbugs.HE_HASHCODE_NO_EQUALS.name=Bad practice - Class defines hashCode() but not equals()
-rule.findbugs.MF_CLASS_MASKS_FIELD.name=Correctness - Class defines field that masks a superclass field
-rule.findbugs.NM_VERY_CONFUSING_INTENTIONAL.name=Bad practice - Very confusing method names (but perhaps intentional)
-rule.findbugs.SR_NOT_CHECKED.name=Bad practice - Method ignores results of InputStream.skip()
-rule.findbugs.LI_LAZY_INIT_STATIC.name=Multithreaded correctness - Incorrect lazy initialization of static field
-rule.findbugs.DMI_ANNOTATION_IS_NOT_VISIBLE_TO_REFLECTION.name=Correctness - Can't use reflection to check for presence of annotation without runtime retention
-rule.findbugs.ODR_OPEN_DATABASE_RESOURCE_EXCEPTION_PATH.name=Bad practice - Method may fail to close database resource on exception
-rule.findbugs.BIT_IOR.name=Correctness - Incompatible bit masks (BIT_IOR)
-rule.findbugs.ODR_OPEN_DATABASE_RESOURCE.name=Bad practice - Method may fail to close database resource
-rule.findbugs.IP_PARAMETER_IS_DEAD_BUT_OVERWRITTEN.name=Correctness - A parameter is dead upon entry to a method but overwritten
-rule.findbugs.SQL_PREPARED_STATEMENT_GENERATED_FROM_NONCONSTANT_STRING.name=Security - A prepared statement is generated from a nonconstant String
-rule.findbugs.UUF_UNUSED_FIELD.name=Performance - Unused field
-rule.findbugs.RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE.name=Correctness - Nullcheck of value previously dereferenced
-rule.findbugs.EQ_OTHER_USE_OBJECT.name=Correctness - equals() method defined that doesn't override Object.equals(Object)
-rule.findbugs.SP_SPIN_ON_FIELD.name=Multithreaded correctness - Method spins on field
-rule.findbugs.SI_INSTANCE_BEFORE_FINALS_ASSIGNED.name=Bad practice - Static initializer creates instance before all static final fields assigned
-rule.findbugs.NP_ALWAYS_NULL_EXCEPTION.name=Correctness - Null pointer dereference in method on exception path
-rule.findbugs.MS_EXPOSE_REP.name=Malicious code vulnerability - Public static method may expose internal representation by returning array
-rule.findbugs.VA_FORMAT_STRING_BAD_CONVERSION_TO_BOOLEAN.name=Dodgy - Non-Boolean argument formatted using %b format specifier
-rule.findbugs.MS_PKGPROTECT.name=Malicious code vulnerability - Field should be package protected
-rule.findbugs.NP_NONNULL_RETURN_VIOLATION.name=Correctness - Method may return null, but is declared @NonNull
-rule.findbugs.J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION.name=Bad practice - Store of non serializable object into HttpSession
-rule.findbugs.NM_SAME_SIMPLE_NAME_AS_SUPERCLASS.name=Bad practice - Class names shouldn't shadow simple name of superclass
-rule.findbugs.DMI_BLOCKING_METHODS_ON_URL.name=Performance - The equals and hashCode methods of URL are blocking
-rule.findbugs.HE_SIGNATURE_DECLARES_HASHING_OF_UNHASHABLE_CLASS.name=Correctness - Signature declares use of unhashable class in hashed construct
-rule.findbugs.UR_UNINIT_READ.name=Correctness - Uninitialized read of field in constructor
-rule.findbugs.WA_NOT_IN_LOOP.name=Multithreaded correctness - Wait not in loop
-rule.findbugs.DMI_FUTILE_ATTEMPT_TO_CHANGE_MAXPOOL_SIZE_OF_SCHEDULED_THREAD_POOL_EXECUTOR.name=Correctness - Futile attempt to change max pool size of ScheduledThreadPoolExecutor
-rule.findbugs.RV_RETURN_VALUE_IGNORED2.name=Correctness - Method ignores return value
-rule.findbugs.NM_FIELD_NAMING_CONVENTION.name=Field names should start with a lower case letter
-rule.findbugs.FB_UNEXPECTED_WARNING.name=Experimental - Unexpected/undesired warning from FindBugs
-rule.findbugs.BX_UNBOXED_AND_COERCED_FOR_TERNARY_OPERATOR.name=Correctness - Primitive value is unboxed and coerced for ternary operator
-rule.findbugs.DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED.name=Bad practice - Classloaders should only be created inside doPrivileged block
-rule.findbugs.NM_WRONG_PACKAGE.name=Correctness - Method doesn't override method in superclass due to wrong package for parameter
-rule.findbugs.IL_CONTAINER_ADDED_TO_ITSELF.name=Correctness - A collection is added to itself
-rule.findbugs.CI_CONFUSED_INHERITANCE.name=Dodgy - Class is final but declares protected field
-rule.findbugs.HE_USE_OF_UNHASHABLE_CLASS.name=Correctness - Use of class without a hashCode() method in a hashed data structure
-rule.findbugs.IJU_SUITE_NOT_STATIC.name=Correctness - TestCase implements a non-static suite method
-rule.findbugs.RS_READOBJECT_SYNC.name=Multithreaded correctness - Class's readObject() method is synchronized
-rule.findbugs.AM_CREATES_EMPTY_JAR_FILE_ENTRY.name=Bad practice - Creates an empty jar file entry
-rule.findbugs.VA_FORMAT_STRING_BAD_CONVERSION_FROM_ARRAY.name=Correctness - Array formatted in useless way using format string
-rule.findbugs.SF_DEAD_STORE_DUE_TO_SWITCH_FALLTHROUGH_TO_THROW.name=Dead store due to switch statement fall through to throw
-rule.findbugs.RV_ABSOLUTE_VALUE_OF_HASHCODE.name=Correctness - Bad attempt to compute absolute value of signed 32-bit hashcode
-rule.findbugs.EQ_DONT_DEFINE_EQUALS_FOR_ENUM.name=Correctness - Covariant equals() method defined for enum
-rule.findbugs.SA_FIELD_DOUBLE_ASSIGNMENT.name=Correctness - Double assignment of field
-rule.findbugs.DMI_COLLECTION_OF_URLS.name=Performance - Maps and sets of URLs can be performance hogs
-rule.findbugs.NM_SAME_SIMPLE_NAME_AS_INTERFACE.name=Bad practice - Class names shouldn't shadow simple name of implemented interface
-rule.findbugs.UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR.name=Correctness - Field not initialized in constructor
-rule.findbugs.TQ_MAYBE_SOURCE_VALUE_REACHES_NEVER_SINK.name=Correctness - Value that might carry a type qualifier is always used in a way prohibits it from having that type qualifier
-rule.findbugs.SE_NONLONG_SERIALVERSIONID.name=Bad practice - serialVersionUID isn't long
-rule.findbugs.RV_REM_OF_HASHCODE.name=Dodgy - Remainder of hashCode could be negative
-rule.findbugs.NS_DANGEROUS_NON_SHORT_CIRCUIT.name=Dodgy - Potentially dangerous use of non-short-circuit logic
-rule.findbugs.USM_USELESS_SUBCLASS_METHOD.name=Experimental - Method superfluously delegates to parent class method
-rule.findbugs.ITA_INEFFICIENT_TO_ARRAY.name=Performance - Method uses toArray() with zero-length array argument
-rule.findbugs.DM_MONITOR_WAIT_ON_CONDITION.name=Multithreaded correctness - Monitor wait() called on Condition
-rule.findbugs.BOA_BADLY_OVERRIDDEN_ADAPTER.name=Correctness - Class overrides a method implemented in super class Adapter wrongly
-rule.findbugs.IC_INIT_CIRCULARITY.name=Dodgy - Initialization circularity
-rule.findbugs.NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER.name=Bad practice - Use of identifier that is a keyword in later versions of Java
-rule.findbugs.EC_UNRELATED_CLASS_AND_INTERFACE.name=Correctness - Call to equals() comparing unrelated class and interface
-rule.findbugs.TQ_MAYBE_SOURCE_VALUE_REACHES_ALWAYS_SINK.name=Correctness - Value that might not carry a type qualifier is always used in a way requires that type qualifier
-rule.findbugs.FE_TEST_IF_EQUAL_TO_NOT_A_NUMBER.name=Correctness - Doomed test for equality to NaN
-rule.findbugs.NM_CONFUSING.name=Bad practice - Confusing method names
-rule.findbugs.VA_FORMAT_STRING_ARG_MISMATCH.name=Correctness - Number of format-string arguments does not correspond to number of placeholders
-rule.findbugs.NP_NULL_ON_SOME_PATH_EXCEPTION.name=Correctness - Possible null pointer dereference in method on exception path
-rule.findbugs.DL_SYNCHRONIZATION_ON_BOXED_PRIMITIVE.name=Multithreaded correctness - Synchronization on boxed primitive could lead to deadlock
-rule.findbugs.IJU_TEARDOWN_NO_SUPER.name=Correctness - TestCase defines tearDown that doesn't call super.tearDown()
-rule.findbugs.SE_READ_RESOLVE_IS_STATIC.name=Correctness - The readResolve method must not be declared as a static method.
-rule.findbugs.NP_NULL_ON_SOME_PATH_MIGHT_BE_INFEASIBLE.name=Dodgy - Possible null pointer dereference on path that might be infeasible
-rule.findbugs.UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS.name=Correctness - Uncallable method defined in anonymous class
-rule.findbugs.VA_FORMAT_STRING_BAD_CONVERSION.name=Correctness - The type of a supplied argument doesn't match format specifier
-rule.findbugs.EC_ARRAY_AND_NONARRAY.name=Correctness - equals() used to compare array and nonarray
-rule.findbugs.NM_BAD_EQUAL.name=Class defines equal(Object); should it be equals(Object)?
-rule.findbugs.EC_UNRELATED_TYPES_USING_POINTER_EQUALITY.name=Correctness - Using pointer equality to compare different types
-rule.findbugs.STI_INTERRUPTED_ON_CURRENTTHREAD.name=Correctness - Unneeded use of currentThread() call, to call interrupted()
-rule.findbugs.RE_CANT_USE_FILE_SEPARATOR_AS_REGULAR_EXPRESSION.name=Correctness - File.separator used for regular expression
-rule.findbugs.MWN_MISMATCHED_WAIT.name=Multithreaded correctness - Mismatched wait()
-rule.findbugs.IL_INFINITE_LOOP.name=Correctness - An apparent infinite loop
-rule.findbugs.NP_IMMEDIATE_DEREFERENCE_OF_READLINE.name=Dodgy - Immediate dereference of the result of readLine()
-rule.findbugs.SC_START_IN_CTOR.name=Multithreaded correctness - Constructor invokes Thread.start()
-rule.findbugs.STCAL_STATIC_SIMPLE_DATE_FORMAT_INSTANCE.name=Multithreaded correctness - Static DateFormat
-rule.findbugs.HE_EQUALS_NO_HASHCODE.name=Bad practice - Class defines equals() but not hashCode()
-rule.findbugs.UL_UNRELEASED_LOCK.name=Multithreaded correctness - Method does not release lock on all paths
-rule.findbugs.PZLA_PREFER_ZERO_LENGTH_ARRAYS.name=Dodgy - Consider returning a zero length array rather than null
-rule.findbugs.SKIPPED_CLASS_TOO_BIG.name=Dodgy - Class too big for analysis
-rule.findbugs.NP_ARGUMENT_MIGHT_BE_NULL.name=Correctness - Method does not check for null argument
-rule.findbugs.UM_UNNECESSARY_MATH.name=Performance - Method calls static Math class method on a constant value
-rule.findbugs.NM_WRONG_PACKAGE_INTENTIONAL.name=Bad practice - Method doesn't override method in superclass due to wrong package for parameter
-rule.findbugs.NP_NONNULL_PARAM_VIOLATION.name=Correctness - Method call passes null to a nonnull parameter
-rule.findbugs.BIT_AND_ZZ.name=Correctness - Check to see if ((...) & 0) == 0
-rule.findbugs.HRS_REQUEST_PARAMETER_TO_COOKIE.name=Security - HTTP cookie formed from untrusted input
-rule.findbugs.SQL_BAD_RESULTSET_ACCESS.name=Correctness - Method attempts to access a result set field with index 0
-rule.findbugs.INT_VACUOUS_COMPARISON.name=Dodgy - Vacuous comparison of integer value
-rule.findbugs.EQ_COMPARETO_USE_OBJECT_EQUALS.name=Bad practice - Class defines compareTo(...) and uses Object.equals()
-rule.findbugs.DMI_HARDCODED_ABSOLUTE_FILENAME.name=Dodgy - Code contains a hard coded reference to an absolute pathname
-rule.findbugs.DMI_COLLECTIONS_SHOULD_NOT_CONTAIN_THEMSELVES.name=Correctness - Collections should not contain themselves
-rule.findbugs.URF_UNREAD_FIELD.name=Performance - Unread field
-rule.findbugs.DLS_OVERWRITTEN_INCREMENT.name=Correctness - Overwritten increment
-rule.findbugs.BIT_SIGNED_CHECK.name=Bad practice - Check for sign of bitwise operation
-rule.findbugs.UWF_NULL_FIELD.name=Correctness - Field only ever set to null
-rule.findbugs.DE_MIGHT_DROP.name=Bad practice - Method might drop exception
-rule.findbugs.DMI_BAD_MONTH.name=Correctness - Bad constant value for month
-rule.findbugs.MS_MUTABLE_ARRAY.name=Malicious code vulnerability - Field is a mutable array
-rule.findbugs.SE_INNER_CLASS.name=Bad practice - Serializable inner class
-rule.findbugs.OS_OPEN_STREAM_EXCEPTION_PATH.name=Bad practice - Method may fail to close stream on exception
-rule.findbugs.AT_OPERATION_SEQUENCE_ON_CONCURRENT_ABSTRACTION.name=Sequence of calls to concurrent abstraction may not be atomic
-rule.findbugs.BX_UNBOXING_IMMEDIATELY_REBOXED.name=Boxed value is unboxed and then immediately reboxed
-rule.findbugs.CO_COMPARETO_RESULTS_MIN_VALUE.name=compareTo()/compare() returns Integer.MIN_VALUE
-rule.findbugs.DLS_DEAD_LOCAL_STORE_SHADOWS_FIELD.name=Dead store to local variable that shadows field
-rule.findbugs.DMI_ARGUMENTS_WRONG_ORDER.name=Reversed method arguments
-rule.findbugs.DMI_BIGDECIMAL_CONSTRUCTED_FROM_DOUBLE.name=BigDecimal constructed from double that isn't represented precisely
-rule.findbugs.DMI_DOH.name=D'oh! A nonsensical method invocation
-rule.findbugs.DMI_ENTRY_SETS_MAY_REUSE_ENTRY_OBJECTS.name=Adding elements of an entry set may fail due to reuse of Entry objects
-rule.findbugs.DM_DEFAULT_ENCODING.name=Reliance on default encoding
-rule.findbugs.ICAST_INT_2_LONG_AS_INSTANT.name=int value converted to long and used as absolute time
-rule.findbugs.INT_BAD_COMPARISON_WITH_INT_VALUE.name=Bad comparison of int value with long constant
-rule.findbugs.JML_JSR166_CALLING_WAIT_RATHER_THAN_AWAIT.name=Using monitor style wait methods on util.concurrent abstraction
-rule.findbugs.NP_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD.name=Read of unwritten public or protected field
-rule.findbugs.OBL_UNSATISFIED_OBLIGATION_EXCEPTION_EDGE.name=Method may fail to clean up stream or resource on checked exception
-rule.findbugs.PZ_DONT_REUSE_ENTRY_OBJECTS_IN_ITERATORS.name=Don't reuse entry objects in iterators
-rule.findbugs.RV_CHECK_COMPARETO_FOR_SPECIFIC_RETURN_VALUE.name=Code checks for specific values returned by compareTo
-rule.findbugs.RV_NEGATING_RESULT_OF_COMPARETO.name=Negating the result of compareTo()/compare()
-rule.findbugs.RV_RETURN_VALUE_IGNORED_INFERRED.name=Method ignores return value, is this OK?
-rule.findbugs.SA_LOCAL_SELF_ASSIGNMENT_INSTEAD_OF_FIELD.name=Self assignment of local rather than assignment to field
-rule.findbugs.URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD.name=Unread public/protected field
-rule.findbugs.UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD.name=Unused public or protected field
-rule.findbugs.UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD.name=Unwritten public or protected field
-rule.findbugs.VA_FORMAT_STRING_USES_NEWLINE.name=Format string should use %n rather than \\n
-rule.findbugs.VO_VOLATILE_INCREMENT.name=An increment to a volatile field isn't atomic
-rule.findbugs.PT_ABSOLUTE_PATH_TRAVERSAL.name=Absolute path traversal in servlet
-rule.findbugs.PT_RELATIVE_PATH_TRAVERSAL.name=Relative path traversal in servlet
-rule.findbugs.NP_NONNULL_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR.name=Nonnull field is not initialized
-rule.findbugs.MS_SHOULD_BE_REFACTORED_TO_BE_FINAL.name=Field isn't final but should be refactored to be so
-rule.findbugs.BC_UNCONFIRMED_CAST_OF_RETURN_VALUE.name=Unchecked/unconfirmed cast of return value from method
-rule.findbugs.TQ_COMPARING_VALUES_WITH_INCOMPATIBLE_TYPE_QUALIFIERS.name=Comparing values with incompatible type qualifiers
+++ /dev/null
-<p>The code calls <code>putNextEntry()</code>, immediately
-followed by a call to <code>closeEntry()</code>. This results
-in an empty JarFile entry. The contents of the entry
-should be written to the JarFile between the calls to
-<code>putNextEntry()</code> and
-<code>closeEntry()</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p>The code calls <code>putNextEntry()</code>, immediately
-followed by a call to <code>closeEntry()</code>. This results
-in an empty ZipFile entry. The contents of the entry
-should be written to the ZipFile between the calls to
-<code>putNextEntry()</code> and
-<code>closeEntry()</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p>This code contains a sequence of calls to a concurrent abstraction (such as a concurrent hash map). These calls will not be executed atomically.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This constructor calls methods in the parent Applet that rely on the AppletStub. Since the AppletStub
- isn't initialized until the init() method of this applet is called, these methods will not perform
- correctly.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code casts a Collection to an abstract collection
-(such as <code>List</code>, <code>Set</code>, or <code>Map</code>).
-Ensure that you are guaranteed that the object is of the type
-you are casting to. If all you need is to be able
-to iterate through a collection, you don't need to cast it to a Set or List.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code casts an abstract collection (such as a Collection, List, or Set)
-to a specific concrete implementation (such as an ArrayList or HashSet).
-This might not be correct, and it may make your code fragile, since
-it makes it harder to switch to other concrete implementations at a future
-point. Unless you have a particular reason to do so, just use the abstract
-collection class.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The <code>equals(Object o)</code> method shouldn't make any assumptions
-about the type of <code>o</code>. It should simply return
-false if <code>o</code> is not the same type as <code>this</code>.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This cast will always throw a ClassCastException.
-</p>
\ No newline at end of file
+++ /dev/null
-This cast will always throw a ClassCastException. The analysis believes it knows the precise type of the value being cast, and the attempt to downcast it to a subtype will always fail by throwing a ClassCastException.
\ No newline at end of file
+++ /dev/null
-<p>This code is casting the result of calling toArray() on a collection to a type more specific than Object[], as in:</p>
-<pre>
- String[] getAsArray(Collection<String> c) {
- return (String[]) c.toArray();
- }
-</pre>
-<p>This will usually fail by throwing a ClassCastException. The <code>toArray()</code> of almost all collections return an <code>Object[]</code>. They can't really do anything else, since the Collection object has no reference to the declared generic type of the collection.</p>
-<p>The correct way to do get an array of a specific type from a collection is to use <code>c.toArray(new String[]);</code> or <code>c.toArray(new String[c.size()]);</code> (the latter is slightly more efficient).</p>
-<p>There is one common/known exception exception to this. The toArray() method of lists returned by Arrays.asList(...) will return a covariantly typed array. For example, <code>Arrays.asArray(new String[] { "a" }).toArray()</code> will return a String []. FindBugs attempts to detect and suppress such cases, but may miss some.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This instanceof test will always return false. Although this is safe, make sure it isn't
-an indication of some misunderstanding or some other logic error.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This cast is unchecked, and not all instances of the type casted from can be cast to
-the type it is being cast to. Ensure that your program logic ensures that this
-cast will not fail.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code performs an unchecked cast of the return value of a method.
-The code might be calling the method in such a way that the cast is guaranteed to be
-safe, but FindBugs is unable to verify that the cast is safe. Check that your program logic ensures that this
-cast will not fail.
-</p>
+++ /dev/null
-<p>
-This instanceof test will always return true (unless the value being tested is null).
-Although this is safe, make sure it isn't
-an indication of some misunderstanding or some other logic error.
-If you really want to test the value for being null, perhaps it would be clearer to do
-better to do a null test rather than an instanceof test.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> Adds a byte value and a value which is known to the 8 lower bits clear.
-Values loaded from a byte array are sign extended to 32 bits
-before any any bitwise operations are performed on the value.
-Thus, if <code>b[0]</code> contains the value <code>0xff</code>, and
-<code>x</code> is initially 0, then the code
-<code>((x << 8) + b[0])</code> will sign extend <code>0xff</code>
-to get <code>0xffffffff</code>, and thus give the value
-<code>0xffffffff</code> as the result.
-</p>
-
-<p>In particular, the following code for packing a byte array into an int is badly wrong: </p>
-<pre>
-int result = 0;
-for(int i = 0; i < 4; i++)
- result = ((result << 8) + b[i]);
-</pre>
-
-<p>The following idiom will work instead: </p>
-<pre>
-int result = 0;
-for(int i = 0; i < 4; i++)
- result = ((result << 8) + (b[i] & 0xff));
-</pre>
\ No newline at end of file
+++ /dev/null
-<p> This method compares an expression of the form (e & C) to D,
-which will always compare unequal
-due to the specific values of constants C and D.
-This may indicate a logic error or typo.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method compares an expression of the form (e & 0) to 0,
-which will always compare equal.
-This may indicate a logic error or typo.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method compares an expression of the form (e | C) to D.
-which will always compare unequal
-due to the specific values of constants C and D.
-This may indicate a logic error or typo.</p>
-
-<p> Typically, this bug occurs because the code wants to perform
-a membership test in a bit set, but uses the bitwise OR
-operator ("|") instead of bitwise AND ("&").</p>
\ No newline at end of file
+++ /dev/null
-<p> Loads a value from a byte array and performs a bitwise OR with
-that value. Values loaded from a byte array are sign extended to 32 bits
-before any any bitwise operations are performed on the value.
-Thus, if <code>b[0]</code> contains the value <code>0xff</code>, and
-<code>x</code> is initially 0, then the code
-<code>((x << 8) | b[0])</code> will sign extend <code>0xff</code>
-to get <code>0xffffffff</code>, and thus give the value
-<code>0xffffffff</code> as the result.
-</p>
-
-<p>In particular, the following code for packing a byte array into an int is badly wrong: </p>
-<pre>
-int result = 0;
-for(int i = 0; i < 4; i++)
- result = ((result << 8) | b[i]);
-</pre>
-
-<p>The following idiom will work instead: </p>
-<pre>
-int result = 0;
-for(int i = 0; i < 4; i++)
- result = ((result << 8) | (b[i] & 0xff));
-</pre>
\ No newline at end of file
+++ /dev/null
-<p> This method compares an expression such as
-<pre>((event.detail & SWT.SELECTED) > 0)</pre>.
-Using bit arithmetic and then comparing with the greater than operator can
-lead to unexpected results (of course depending on the value of
-SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate
-for a bug. Even when SWT.SELECTED is not negative, it seems good practice
-to use '!= 0' instead of '> 0'.
-</p>
-<p>
-<em>Boris Bokowski</em>
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method compares an expression such as
-<pre>((event.detail & SWT.SELECTED) > 0)</pre>.
-Using bit arithmetic and then comparing with the greater than operator can
-lead to unexpected results (of course depending on the value of
-SWT.SELECTED). If SWT.SELECTED is a negative number, this is a candidate
-for a bug. Even when SWT.SELECTED is not negative, it seems good practice
-to use '!= 0' instead of '> 0'.
-</p>
-<p>
-<em>Boris Bokowski</em>
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method overrides a method found in a parent class, where that class is an Adapter that implements
-a listener defined in the java.awt.event or javax.swing.event package. As a result, this method will not
-get called when the event occurs.</p>
\ No newline at end of file
+++ /dev/null
-<p>A primitive is boxed, and then immediately unboxed. This probably is due to a manual
- boxing in a place where an unboxed value is required, thus forcing the compiler
-to immediately undo the work of the boxing.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>A primitive boxed value constructed and then immediately converted into a different primitive type
-(e.g., <code>new Double(d).intValue()</code>). Just perform direct primitive coercion (e.g., <code>(int) d</code>).</p>
\ No newline at end of file
+++ /dev/null
-<p>A wrapped primitive value is unboxed and converted to another primitive type as part of the
-evaluation of a conditional ternary operator (the <code> b ? e1 : e2</code> operator). The
-semantics of Java mandate that if <code>e1</code> and <code>e2</code> are wrapped
-numeric values, the values are unboxed and converted/coerced to their common type (e.g,
-if <code>e1</code> is of type <code>Integer</code>
-and <code>e2</code> is of type <code>Float</code>, then <code>e1</code> is unboxed,
-converted to a floating point value, and boxed. See JLS Section 15.25.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>A boxed value is unboxed and then immediately reboxed.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This class has a circular dependency with other classes. This makes building these classes
- difficult, as each is dependent on the other to build correctly. Consider using interfaces
- to break the hard dependency.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This class is declared to be final, but declares fields to be protected. Since the class
- is final, it can not be derived from, and the use of protected is confusing. The access
- modifier for the field should be changed to private or public to represent the true
- use for the field.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- Class implements Cloneable but does not define or
- use the clone method.</p>
\ No newline at end of file
+++ /dev/null
-<p> This non-final class defines a clone() method that does not call super.clone().
-If this class ("<i>A</i>") is extended by a subclass ("<i>B</i>"),
-and the subclass <i>B</i> calls super.clone(), then it is likely that
-<i>B</i>'s clone() method will return an object of type <i>A</i>,
-which violates the standard contract for clone().</p>
-
-<p> If all clone() methods call super.clone(), then they are guaranteed
-to use Object.clone(), which always returns an object of the correct type.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a clone() method but the class doesn't implement Cloneable.
-There are some situations in which this is OK (e.g., you want to control how subclasses
-can clone themselves), but just make sure that this is what you intended.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a covariant version of <code>compareTo()</code>.
- To correctly override the <code>compareTo()</code> method in the
- <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
- must have type <code>java.lang.Object</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p>In some situation, this compareTo or compare method returns the constant Integer.MIN_VALUE,
-which is an exceptionally bad practice. The only thing that matters about the return value of
-compareTo is the sign of the result. But people will sometimes negate the return value of compareTo,
-expecting that this will negate the sign of the result. And it will, except in the case where
-the value returned is Integer.MIN_VALUE. So just return -1 rather than Integer.MIN_VALUE.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a covariant version of <code>compareTo()</code>.
- To correctly override the <code>compareTo()</code> method in the
- <code>Comparable</code> interface, the parameter of <code>compareTo()</code>
- must have type <code>java.lang.Object</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method uses the same code to implement two branches of a conditional branch.
- Check to ensure that this isn't a coding mistake.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method uses the same code to implement two clauses of a switch statement.
- This could be a case of duplicate code, but it might also indicate
- a coding mistake.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This method may contain an instance of double-checked locking.
- This idiom is not correct according to the semantics of the Java memory
- model. For more information, see the web page
- <a href="http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html"
- >http://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html</a>.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method might drop an exception. In general, exceptions
- should be handled or reported in some way, or they should be thrown
- out of the method.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method might ignore an exception. In general, exceptions
- should be handled or reported in some way, or they should be thrown
- out of the method.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This instruction assigns a value to a local variable,
-but the value is not read or used in any subsequent instruction.
-Often, this indicates an error, because the value computed is never
-used.
-</p>
-<p>
-Note that Sun's javac compiler often generates dead stores for
-final local variables. Because FindBugs is a bytecode-based tool,
-there is no easy way to eliminate these false positives.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This statement assigns to a local variable in a return statement. This assignment
-has effect. Please verify that this statement does the right thing.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>The code stores null into a local variable, and the stored value is not
-read. This store may have been introduced to assist the garbage collector, but
-as of Java SE 6.0, this is no longer needed or useful.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This instruction assigns a value to a local variable, but the value is not read or used in
-any subsequent instruction. Often, this indicates an error, because the value computed is never
-used. There is a field with the same name as the local variable. Did you mean to assign to that
-variable instead?</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This instruction assigns a class literal to a variable and then never uses it.
-<a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">The behavior of this differs in Java 1.4 and in Java 5.</a>
-In Java 1.4 and earlier, a reference to <code>Foo.class</code> would force the static initializer
-for <code>Foo</code> to be executed, if it has not been executed already.
-In Java 5 and later, it does not.
-</p>
-<p>See Sun's <a href="//java.sun.com/j2se/1.5.0/compatibility.html#literal">article on Java SE compatibility</a>
-for more details and examples, and suggestions on how to force class initialization in Java 5.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code performs an increment operation (e.g., <code>i++</code>) and then
-immediately overwrites it. For example, <code>i = i++</code> immediately
-overwrites the incremented value with the original value.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The code synchronizes on a boxed primitive constant, such as an Boolean.
-<pre>
-private static Boolean inited = Boolean.FALSE;
-...
- synchronized(inited) {
- if (!inited) {
- init();
- inited = Boolean.TRUE;
- }
- }
-...
-</pre>
-</p>
-<p>Since there normally exist only two Boolean objects, this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness
-and possible deadlock</p>
\ No newline at end of file
+++ /dev/null
-<p> The code synchronizes on a boxed primitive constant, such as an Integer.
-<pre>
-private static Integer count = 0;
-...
- synchronized(count) {
- count++;
- }
-...
-</pre>
-</p>
-<p>Since Integer objects can be cached and shared,
-this code could be synchronizing on the same object as other, unrelated code, leading to unresponsiveness
-and possible deadlock</p>
\ No newline at end of file
+++ /dev/null
-<p> The code synchronizes on interned String.
-<pre>
-private static String LOCK = "LOCK";
-...
- synchronized(LOCK) { ...}
-...
-</pre>
-</p>
-<p>Constant Strings are interned and shared across all other classes loaded by the JVM. Thus, this could
-is locking on something that other code might also be locking. This could result in very strange and hard to diagnose
-blocking and deadlock behavior. See <a href="http://www.javalobby.org/java/forums/t96352.html">http://www.javalobby.org/java/forums/t96352.html</a> and <a href="http://jira.codehaus.org/browse/JETTY-352">http://jira.codehaus.org/browse/JETTY-352</a>.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The code synchronizes on an apparently unshared boxed primitive,
-such as an Integer.
-<pre>
-private static final Integer fileLock = new Integer(1);
-...
- synchronized(fileLock) {
- .. do something ..
- }
-...
-</pre>
-</p>
-<p>It would be much better, in this code, to redeclare fileLock as
-<pre>
-private static final Object fileLock = new Object();
-</pre>
-The existing code might be OK, but it is confusing and a
-future refactoring, such as the "Remove Boxing" refactoring in IntelliJ,
-might replace this with the use of an interned Integer object shared
-throughout the JVM, leading to very confusing behavior and potential deadlock.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> Unless an annotation has itself been annotated with @Retention(RetentionPolicy.RUNTIME), the annotation can't be observed using reflection
-(e.g., by using the isAnnotationPresent method).
- .</p>
\ No newline at end of file
+++ /dev/null
-<p>The arguments to this method call seem to be in the wrong order. For example, a call
-<code>Preconditions.checkNotNull("message", message)</code> has reserved arguments: the value
-to be checked is the first argument.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code passes a constant month
-value outside the expected range of 0..11 to a method.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code creates a BigDecimal from a double value that doesn't translate well to a decimal number. For example,
-one might assume that writing <code>new BigDecimal(0.1)</code> in Java creates a BigDecimal which is exactly equal to 0.1
-(an unscaled value of 1, with a scale of 1), but it is actually equal to 0.1000000000000000055511151231257827021181583404541015625.
-You probably want to use the <code>BigDecimal.valueOf(double d)</code> method, which uses the String representation of the double to
-create the BigDecimal (e.g., <code>BigDecimal.valueOf(0.1)</code> gives 0.1).</p>
\ No newline at end of file
+++ /dev/null
-<p> The equals and hashCode
-method of URL perform domain name resolution, this can result in a big performance hit.
-See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information.
-Consider using <code>java.net.URI</code> instead.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
-The hasNext() method invokes the next() method. This is almost certainly wrong,
-since the hasNext() method is not supposed to change the state of the iterator,
-and the next method is supposed to change the state of the iterator.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This call to a generic collection's method would only make sense if a collection contained
-itself (e.g., if <code>s.contains(s)</code> were true). This is unlikely to be true and would cause
-problems if it were true (such as the computation of the hash code resulting in infinite recursion).
-It is likely that the wrong value is being passed as a parameter.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This method or field is or uses a Map or Set of URLs. Since both the equals and hashCode
-method of URL perform domain name resolution, this can result in a big performance hit.
-See <a href="http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html">http://michaelscharf.blogspot.com/2006/11/javaneturlequals-and-hashcode-make.html</a> for more information.
-Consider using <code>java.net.URI</code> instead.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>This code creates a database connect using a hardcoded, constant password. Anyone with access to either the source code or the compiled code can
- easily learn the password.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This partical method invocation doesn't make sense, for reasons that should be apparent from inspection.</p>
\ No newline at end of file
+++ /dev/null
-<p>This code creates a database connect using a blank or empty password. This indicates that the database is not protected by a password.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>The entrySet() method is allowed to return a view of the underlying Map in which a single Entry
- object is reused and returned during the iteration. As of Java 1.6, both IdentityHashMap and EnumMap
- did so. When iterating through such a Map, the Entry value is only valid until you advance to the
- next iteration. If, for example, you try to pass such an entrySet to an addAll method, things will
- go badly wrong.</p>
\ No newline at end of file
+++ /dev/null
-<p>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html">Javadoc</a>)
-While ScheduledThreadPoolExecutor inherits from ThreadPoolExecutor, a few of the inherited tuning methods are not useful for it. In particular, because it acts as a fixed-sized pool using corePoolSize threads and an unbounded queue, adjustments to maximumPoolSize have no useful effect.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>This code constructs a File object using a hard coded to an absolute pathname
-(e.g., <code>new File("/home/dannyc/workspace/j2ee/src/share/com/sun/enterprise/deployment");</code>
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code invokes hashCode on an array. Calling hashCode on
-an array returns the same value as System.identityHashCode, and ingores
-the contents and length of the array. If you need a hashCode that
-depends on the contents of an array <code>a</code>,
-use <code>java.util.Arrays.hashCode(a)</code>.
-
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code invokes toString on an (anonymous) array. Calling toString on an array generates a fairly useless result
-such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable
-String that gives the contents of the array. See Programming Puzzlers, chapter 3, puzzle 12.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code invokes toString on an array, which will generate a fairly useless result
-such as [C@16f0472. Consider using Arrays.toString to convert the array into a readable
-String that gives the contents of the array. See Programming Puzzlers, chapter 3, puzzle 12.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The Double.longBitsToDouble method is invoked, but a 32 bit int value is passed
- as an argument. This almostly certainly is not intended and is unlikely
- to give the intended result.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code seems to be passing a non-serializable object to the ObjectOutput.writeObject method.
-If the object is, indeed, non-serializable, an error will result.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This code creates a java.util.Random object, uses it to generate one random number, and then discards
-the Random object. This produces mediocre quality random numbers and is inefficient.
-If possible, rewrite the code so that the Random object is created once and saved, and each time a new random number
-is required invoke a method on the existing Random object to obtain it.
-</p>
-
-<p>If it is important that the generated Random numbers not be guessable, you <em>must</em> not create a new Random for each random
-number; the values are too easily guessable. You should strongly consider using a java.security.SecureRandom instead
-(and avoid allocating a new SecureRandom for each random number needed).
-</p>
\ No newline at end of file
+++ /dev/null
-<p>(<a href="http://java.sun.com/javase/6/docs/api/java/util/concurrent/ScheduledThreadPoolExecutor.html#ScheduledThreadPoolExecutor(int)">Javadoc</a>)
-A ScheduledThreadPoolExecutor with zero core threads will never execute anything; changes to the max pool size are ignored.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> A Thread object is passed as a parameter to a method where
-a Runnable is expected. This is rather unusual, and may indicate a logic error
-or cause unexpected behavior.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>All targets of this method invocation throw an UnsupportedOperationException.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code invokes substring(0) on a String, which returns the original value.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> If you want to remove all elements from a collection <code>c</code>, use <code>c.clear</code>,
-not <code>c.removeAll(c)</code>.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This call doesn't make sense. For any collection <code>c</code>, calling <code>c.containsAll(c)</code> should
-always be true, and <code>c.retainAll(c)</code> should have no effect.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> Creating new instances of <code>java.lang.Boolean</code> wastes
- memory, since <code>Boolean</code> objects are immutable and there are
- only two useful values of this type. Use the <code>Boolean.valueOf()</code>
- method (or Java 1.5 autoboxing) to create <code>Boolean</code> objects instead.</p>
\ No newline at end of file
+++ /dev/null
-<p>A boxed primitive is allocated just to call toString(). It is more effective to just use the static
- form of toString which takes the primitive value. So,</p>
- <table>
- <tr><th>Replace...</th><th>With this...</th></tr>
- <tr><td>new Integer(1).toString()</td><td>Integer.toString(1)</td></tr>
- <tr><td>new Long(1).toString()</td><td>Long.toString(1)</td></tr>
- <tr><td>new Float(1.0).toString()</td><td>Float.toString(1.0)</td></tr>
- <tr><td>new Double(1.0).toString()</td><td>Double.toString(1.0)</td></tr>
- <tr><td>new Byte(1).toString()</td><td>Byte.toString(1)</td></tr>
- <tr><td>new Short(1).toString()</td><td>Short.toString(1)</td></tr>
- <tr><td>new Boolean(true).toString()</td><td>Boolean.toString(true)</td></tr>
- </table>
\ No newline at end of file
+++ /dev/null
-<p> A String is being converted to upper or lowercase, using the platform's default encoding. This may
- result in improper conversions when used with international characters. Use the </p>
- <table><tr><td>String.toUpperCase( Locale l )</td></tr><tr><td>String.toLowerCase( Locale l )</td></tr></table>
- <p>versions instead.</p>
\ No newline at end of file
+++ /dev/null
-<p>Found a call to a method which will perform a byte to String (or String to byte) conversion,
-and will assume that the default platform encoding is suitable. This will cause the application
-behaviour to vary between platforms. Use an alternative API and specify a charset name or
-Charset object explicitly.</p>
\ No newline at end of file
+++ /dev/null
-<p> Invoking System.exit shuts down the entire Java virtual machine. This
- should only been done when it is appropriate. Such calls make it
- hard or impossible for your code to be invoked by other code.
- Consider throwing a RuntimeException instead.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- Using <code>new Double(double)</code> is guaranteed to always result in a new object whereas
- <code>Double.valueOf(double)</code> allows caching of values to be done by the compiler, class library, or JVM.
- Using of cached values avoids object allocation and the code will be faster.
- </p>
- <p>
- Unless the class must be compatible with JVMs predating Java 1.5,
- use either autoboxing or the <code>valueOf()</code> method when creating instances of <code>Double</code> and <code>Float</code>.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> Code explicitly invokes garbage collection.
- Except for specific use in benchmarking, this is very dubious.</p>
- <p>In the past, situations where people have explicitly invoked
- the garbage collector in routines such as close or finalize methods
- has led to huge performance black holes. Garbage collection
- can be expensive. Any situation that forces hundreds or thousands
- of garbage collections will bring the machine to a crawl.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method calls <code>wait()</code> on a
- <code>java.util.concurrent.locks.Condition</code> object.
- Waiting for a <code>Condition</code> should be done using one of the <code>await()</code>
- methods defined by the <code>Condition</code> interface.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>This method allocates an object just to call getClass() on it, in order to
- retrieve the Class object for it. It is simpler to just access the .class property of the class.</p>
\ No newline at end of file
+++ /dev/null
-<p>If <code>r</code> is a <code>java.util.Random</code>, you can generate a random number from <code>0</code> to <code>n-1</code>
-using <code>r.nextInt(n)</code>, rather than using <code>(int)(r.nextDouble() * n)</code>.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- Using <code>new Integer(int)</code> is guaranteed to always result in a new object whereas
- <code>Integer.valueOf(int)</code> allows caching of values to be done by the compiler, class library, or JVM.
- Using of cached values avoids object allocation and the code will be faster.
- </p>
- <p>
- Values between -128 and 127 are guaranteed to have corresponding cached instances
- and using <code>valueOf</code> is approximately 3.5 times faster than using constructor.
- For values outside the constant range the performance of both styles is the same.
- </p>
- <p>
- Unless the class must be compatible with JVMs predating Java 1.5,
- use either autoboxing or the <code>valueOf()</code> method when creating instances of
- <code>Long</code>, <code>Integer</code>, <code>Short</code>, <code>Character</code>, and <code>Byte</code>.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> <em>Never call System.runFinalizersOnExit
-or Runtime.runFinalizersOnExit for any reason: they are among the most
-dangerous methods in the Java libraries.</em> -- Joshua Bloch</p>
\ No newline at end of file
+++ /dev/null
-<p> Using the <code>java.lang.String(String)</code> constructor wastes memory
- because the object so constructed will be functionally indistinguishable
- from the <code>String</code> passed as a parameter. Just use the
- argument <code>String</code> directly.</p>
\ No newline at end of file
+++ /dev/null
-<p> Calling <code>String.toString()</code> is just a redundant operation.
- Just use the String.</p>
\ No newline at end of file
+++ /dev/null
-<p> Creating a new <code>java.lang.String</code> object using the
- no-argument constructor wastes memory because the object so created will
- be functionally indistinguishable from the empty string constant
- <code>""</code>. Java guarantees that identical string constants
- will be represented by the same <code>String</code> object. Therefore,
- you should just use the empty string constant directly.</p>
\ No newline at end of file
+++ /dev/null
-<p>This method creates a thread without specifying a run method either by deriving from the Thread class, or
- by passing a Runnable object. This thread, then, does nothing but waste time.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This code creates a classloader, which requires a security manager.
- If this code will be granted security permissions, but might be invoked by code that does not
- have security permissions, then the classloader creation needs to occur inside a doPrivileged block.</p>
\ No newline at end of file
+++ /dev/null
-<p> This code invokes a method that requires a security permission check.
- If this code will be granted security permissions, but might be invoked by code that does not
- have security permissions, then the invocation needs to occur inside a doPrivileged block.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This method invokes the .equals(Object o) to compare an array and a reference that doesn't seem
-to be an array. If things being compared are of different types, they are guaranteed to be unequal
-and the comparison is almost certainly an error. Even if they are both arrays, the equals method
-on arrays only determines of the two arrays are the same object.
-To compare the
-contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This method invokes the .equals(Object o) method on an array. Since arrays do not override the equals
-method of Object, calling equals on an array is the same as comparing their addresses. To compare the
-contents of the arrays, use java.util.Arrays.equals(Object[], Object[]).
-</p>
\ No newline at end of file
+++ /dev/null
-This method invokes the .equals(Object o) to compare two arrays, but the arrays of of incompatible types (e.g., String[] and StringBuffer[], or String[] and int[]). They will never be equal. In addition, when equals(...) is used to compare arrays it only checks to see if they are the same array, and ignores the contents of the arrays.
\ No newline at end of file
+++ /dev/null
-<p> This method calls equals(Object), passing a null value as
-the argument. According to the contract of the equals() method,
-this call should always return <code>false</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This method calls equals(Object) on two references, one of which is a class
-and the other an interface, where neither the class nor any of its
-non-abstract subclasses implement the interface.
-Therefore, the objects being compared
-are unlikely to be members of the same class at runtime
-(unless some application classes were not analyzed, or dynamic class
-loading can occur at runtime).
-According to the contract of equals(),
-objects of different
-classes should always compare as unequal; therefore, according to the
-contract defined by java.lang.Object.equals(Object),
-the result of this comparison will always be false at runtime.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method calls equals(Object) on two references of unrelated
-interface types, where neither is a subtype of the other,
-and there are no known non-abstract classes which implement both interfaces.
-Therefore, the objects being compared
-are unlikely to be members of the same class at runtime
-(unless some application classes were not analyzed, or dynamic class
-loading can occur at runtime).
-According to the contract of equals(),
-objects of different
-classes should always compare as unequal; therefore, according to the
-contract defined by java.lang.Object.equals(Object),
-the result of this comparison will always be false at runtime.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method calls equals(Object) on two references of different
-class types with no common subclasses.
-Therefore, the objects being compared
-are unlikely to be members of the same class at runtime
-(unless some application classes were not analyzed, or dynamic class
-loading can occur at runtime).
-According to the contract of equals(),
-objects of different
-classes should always compare as unequal; therefore, according to the
-contract defined by java.lang.Object.equals(Object),
-the result of this comparison will always be false at runtime.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method uses using pointer equality to compare two references that seem to be of
-different types. The result of this comparison will always be false at runtime.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> Returning a reference to a mutable object value stored in one of the object's fields
- exposes the internal representation of the object.
- If instances
- are accessed by untrusted code, and unchecked changes to
- the mutable object would compromise security or other
- important properties, you will need to do something different.
- Returning a new copy of the object is better approach in many situations.</p>
\ No newline at end of file
+++ /dev/null
-<p> This code stores a reference to an externally mutable object into the
- internal representation of the object.
- If instances
- are accessed by untrusted code, and unchecked changes to
- the mutable object would compromise security or other
- important properties, you will need to do something different.
- Storing a copy of the object is better approach in many situations.</p>
\ No newline at end of file
+++ /dev/null
-<p> This code stores a reference to an externally mutable object into a static
- field.
- If unchecked changes to
- the mutable object would compromise security or other
- important properties, you will need to do something different.
- Storing a copy of the object is better approach in many situations.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a covariant version of <code>equals()</code>.
- To correctly override the <code>equals()</code> method in
- <code>java.lang.Object</code>, the parameter of <code>equals()</code>
- must have type <code>java.lang.Object</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines an equals method that always returns false. This means that an object is not equal to itself, and it is impossible to create useful Maps or Sets of this class. More fundamentally, it means
-that equals is not reflexive, one of the requirements of the equals method.</p>
-<p>The likely intended semantics are object identity: that an object is equal to itself. This is the behavior inherited from class <code>Object</code>. If you need to override an equals inherited from a different
-superclass, you can use use:
-<pre>
-public boolean equals(Object o) { return this == o; }
-</pre>
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines an equals method that always returns true. This is imaginative, but not very smart.
-Plus, it means that the equals method is not symmetric.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This equals method is checking to see if the argument is some incompatible type
-(i.e., a class that is neither a supertype nor subtype of the class that defines
-the equals method). For example, the Foo class might have an equals method
-that looks like:
-
-<p><code><pre>
-public boolean equals(Object o) {
- if (o instanceof Foo)
- return name.equals(((Foo)o).name);
- else if (o instanceof String)
- return name.equals(o);
- else return false;
-</pre></code></p>
-
-<p>This is considered bad practice, as it makes it very hard to implement an equals method that
-is symmetric and transitive. Without those properties, very unexpected behavoirs are possible.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a <code>compareTo(...)</code> method but inherits its
- <code>equals()</code> method from <code>java.lang.Object</code>.
- Generally, the value of compareTo should return zero if and only if
- equals returns true. If this is violated, weird and unpredictable
- failures will occur in classes such as PriorityQueue.
- In Java 5 the PriorityQueue.remove method uses the compareTo method,
- while in Java 6 it uses the equals method.
-
-<p>From the JavaDoc for the compareTo method in the Comparable interface:
-<blockquote>
-It is strongly recommended, but not strictly required that <code>(x.compareTo(y)==0) == (x.equals(y))</code>.
-Generally speaking, any class that implements the Comparable interface and violates this condition
-should clearly indicate this fact. The recommended language
-is "Note: this class has a natural ordering that is inconsistent with equals."
-</blockquote>
\ No newline at end of file
+++ /dev/null
-<p> This method checks to see if two objects are the same class by checking to see if the names
-of their classes are equal. You can have different classes with the same name if they are loaded by
-different class loaders. Just check to see if the class objects are the same.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class extends a class that defines an equals method and adds fields, but doesn't
-define an equals method itself. Thus, equality on instances of this class will
-ignore the identity of the subclass and the added fields. Be sure this is what is intended,
-and that you don't need to override the equals method. Even if you don't need to override
-the equals method, consider overriding it anyway to document the fact
-that the equals method for the subclass just return the result of
-invoking super.equals(o).
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines an enumeration, and equality on enumerations are defined
-using object identity. Defining a covariant equals method for an enumeration
-value is exceptionally bad practice, since it would likely result
-in having two different enumeration values that compare as equals using
-the covariant enum method, and as not equal when compared normally.
-Don't do it.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class has an equals method that will be broken if it is inherited by subclasses.
-It compares a class literal with the class of the argument (e.g., in class <code>Foo</code>
-it might check if <code>Foo.class == o.getClass()</code>).
-It is better to check if <code>this.getClass() == o.getClass()</code>.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines an <code>equals()</code>
- method, that doesn't override the normal <code>equals(Object)</code> method
- defined in the base <code>java.lang.Object</code> class. Instead, it
- inherits an <code>equals(Object)</code> method from a superclass.
- The class should probably define a <code>boolean equals(Object)</code> method.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines an <code>equals()</code>
- method, that doesn't override the normal <code>equals(Object)</code> method
- defined in the base <code>java.lang.Object</code> class.
- The class should probably define a <code>boolean equals(Object)</code> method.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines an equals method that overrides an equals method in a superclass. Both equals methods
-methods use <code>instanceof</code> in the determination of whether two objects are equal. This is fraught with peril,
-since it is important that the equals method is symmetrical (in other words, <code>a.equals(b) == b.equals(a)</code>).
-If B is a subtype of A, and A's equals method checks that the argument is an instanceof A, and B's equals method
-checks that the argument is an instanceof B, it is quite likely that the equivalence relation defined by these
-methods is not symmetric.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a covariant version of <code>equals()</code>.
- To correctly override the <code>equals()</code> method in
- <code>java.lang.Object</code>, the parameter of <code>equals()</code>
- must have type <code>java.lang.Object</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a covariant version of the <code>equals()</code>
- method, but inherits the normal <code>equals(Object)</code> method
- defined in the base <code>java.lang.Object</code> class.
- The class should probably define a <code>boolean equals(Object)</code> method.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This class doesn't do any of the patterns we recognize for checking that the type of the argument
-is compatible with the type of the <code>this</code> object. There might not be anything wrong with
-this code, but it is worth reviewing.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code compares a <code>java.lang.String</code> parameter for reference
-equality using the == or != operators. Requiring callers to
-pass only String constants or interned strings to a method is unnecessarily
-fragile, and rarely leads to measurable performance gains. Consider
-using the <code>equals(Object)</code> method instead.</p>
\ No newline at end of file
+++ /dev/null
-<p>This code compares <code>java.lang.String</code> objects for reference
-equality using the == or != operators.
-Unless both strings are either constants in a source file, or have been
-interned using the <code>String.intern()</code> method, the same string
-value may be represented by two different String objects. Consider
-using the <code>equals(Object)</code> method instead.</p>
\ No newline at end of file
+++ /dev/null
-<p> The code contains an empty synchronized block:</p>
-<pre>
-synchronized() {}
-</pre>
-<p>Empty synchronized blocks are far more subtle and hard to use correctly
-than most people recognize, and empty synchronized blocks
-are almost never a better solution
-than less contrived solutions.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- FindBugs didn't generate generated a warning that, according to a @ExpectedWarning annotated,
- is expected or desired
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- FindBugs generated a warning that, according to a @NoWarning annotated,
- is unexpected or undesired
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This operation compares two floating point values for equality.
- Because floating point calculations may involve rounding,
- calculated float and double values may not be accurate.
- For values that must be precise, such as monetary values,
- consider using a fixed-precision type such as BigDecimal.
- For values that need not be precise, consider comparing for equality
- within some range, for example:
- <code>if ( Math.abs(x - y) < .0000001 )</code>.
- See the Java Language Specification, section 4.2.4.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This code checks to see if a floating point value is equal to the special
- Not A Number value (e.g., <code>if (x == Double.NaN)</code>). However,
- because of the special semantics of <code>NaN</code>, no value
- is equal to <code>Nan</code>, including <code>NaN</code>. Thus,
- <code>x == Double.NaN</code> always evaluates to false.
-
- To check to see if a value contained in <code>x</code>
- is the special Not A Number value, use
- <code>Double.isNaN(x)</code> (or <code>Float.isNaN(x)</code> if
- <code>x</code> is floating point precision).
- </p>
\ No newline at end of file
+++ /dev/null
-<p> Empty <code>finalize()</code> methods are useless, so they should
- be deleted.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains an explicit invocation of the <code>finalize()</code>
- method on an object. Because finalizer methods are supposed to be
- executed once, and only by the VM, this is a bad idea.</p>
-<p>If a connected set of objects beings finalizable, then the VM will invoke the
-finalize method on all the finalizable object, possibly at the same time in different threads.
-Thus, it is a particularly bad idea, in the finalize method for a class X, invoke finalize
-on objects referenced by X, because they may already be getting finalized in a separate thread.
\ No newline at end of file
+++ /dev/null
-<p> This finalizer nulls out fields. This is usually an error, as it does not aid garbage collection,
- and the object is going to be garbage collected anyway.
\ No newline at end of file
+++ /dev/null
-<p> This finalizer does nothing except null out fields. This is completely pointless, and requires that
-the object be garbage collected, finalized, and then garbage collected again. You should just remove the finalize
-method.
\ No newline at end of file
+++ /dev/null
-<p> This <code>finalize()</code> method does not make a call to its
- superclass's <code>finalize()</code> method. So, any finalizer
- actions defined for the superclass will not be performed.
- Add a call to <code>super.finalize()</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p> This empty <code>finalize()</code> method explicitly negates the
- effect of any finalizer defined by its superclass. Any finalizer
- actions defined for the superclass will not be performed.
- Unless this is intended, delete this method.</p>
\ No newline at end of file
+++ /dev/null
-<p> A class's <code>finalize()</code> method should have protected access,
- not public.</p>
\ No newline at end of file
+++ /dev/null
-<p> The only thing this <code>finalize()</code> method does is call
- the superclass's <code>finalize()</code> method, making it
- redundant. Delete it.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- The method performs math operations using floating point precision.
- Floating point precision is very imprecise. For example,
- 16777216.0f + 1.0f = 16777216.0f. Consider using double math instead.</p>
\ No newline at end of file
+++ /dev/null
-<p> This call to a generic collection method passes an argument
- while compile type Object where a specific type from
- the generic type parameters is expected.
- Thus, neither the standard Java type system nor static analysis
- can provide useful information on whether the
- object being passed as a parameter is of an appropriate type.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This call to a generic collection method contains an argument
- with an incompatible class from that of the collection's parameter
- (i.e., the type of the argument is neither a supertype nor a subtype
- of the corresponding generic type argument).
- Therefore, it is unlikely that the collection contains any objects
- that are equal to the method argument used here.
- Most likely, the wrong value is being passed to the method.</p>
- <p>In general, instances of two unrelated classes are not equal.
- For example, if the <code>Foo</code> and <code>Bar</code> classes
- are not related by subtyping, then an instance of <code>Foo</code>
- should not be equal to an instance of <code>Bar</code>.
- Among other issues, doing so will likely result in an equals method
- that is not symmetrical. For example, if you define the <code>Foo</code> class
- so that a <code>Foo</code> can be equal to a <code>String</code>,
- your equals method isn't symmetrical since a <code>String</code> can only be equal
- to a <code>String</code>.
- </p>
- <p>In rare cases, people do define nonsymmetrical equals methods and still manage to make
- their code work. Although none of the APIs document or guarantee it, it is typically
- the case that if you check if a <code>Collection<String></code> contains
- a <code>Foo</code>, the equals method of argument (e.g., the equals method of the
- <code>Foo</code> class) used to perform the equality checks.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This class overrides <code>equals(Object)</code>, but does not
- override <code>hashCode()</code>. Therefore, the class may violate the
- invariant that equal objects must have equal hashcodes.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class overrides <code>equals(Object)</code>, but does not
- override <code>hashCode()</code>, and inherits the implementation of
- <code>hashCode()</code> from <code>java.lang.Object</code> (which returns
- the identity hash code, an arbitrary value assigned to the object
- by the VM). Therefore, the class is very likely to violate the
- invariant that equal objects must have equal hashcodes.</p>
-
-<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
-the recommended <code>hashCode</code> implementation to use is:</p>
-<pre>public int hashCode() {
- assert false : "hashCode not designed";
- return 42; // any arbitrary constant will do
- }</pre>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a <code>hashCode()</code> method but not an
- <code>equals()</code> method. Therefore, the class may
- violate the invariant that equal objects must have equal hashcodes.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a <code>hashCode()</code> method but inherits its
- <code>equals()</code> method from <code>java.lang.Object</code>
- (which defines equality by comparing object references). Although
- this will probably satisfy the contract that equal objects must have
- equal hashcodes, it is probably not what was intended by overriding
- the <code>hashCode()</code> method. (Overriding <code>hashCode()</code>
- implies that the object's identity is based on criteria more complicated
- than simple reference equality.)</p>
-<p>If you don't think instances of this class will ever be inserted into a HashMap/HashTable,
-the recommended <code>hashCode</code> implementation to use is:</p>
-<p><pre>public int hashCode() {
- assert false : "hashCode not designed";
- return 42; // any arbitrary constant will do
- }</pre></p>
\ No newline at end of file
+++ /dev/null
-<p> This class inherits <code>equals(Object)</code> from an abstract
- superclass, and <code>hashCode()</code> from
-<code>java.lang.Object</code> (which returns
- the identity hash code, an arbitrary value assigned to the object
- by the VM). Therefore, the class is very likely to violate the
- invariant that equal objects must have equal hashcodes.</p>
-
- <p>If you don't want to define a hashCode method, and/or don't
- believe the object will ever be put into a HashMap/Hashtable,
- define the <code>hashCode()</code> method
- to throw <code>UnsupportedOperationException</code>.</p>
\ No newline at end of file
+++ /dev/null
-<p> A method, field or class declares a generic signature where a non-hashable class
-is used in context where a hashable class is required.
-A class that declares an equals method but inherits a hashCode() method
-from Object is unhashable, since it doesn't fulfill the requirement that
-equal objects have equal hashCodes.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> A class defines an equals(Object) method but not a hashCode() method,
-and thus doesn't fulfill the requirement that equal objects have equal hashCodes.
-An instance of this class is used in a hash data structure, making the need to
-fix this problem of highest importance.
\ No newline at end of file
+++ /dev/null
-<p>This code constructs an HTTP Cookie using an untrusted HTTP parameter. If this cookie is added to an HTTP response, it will allow a HTTP response splitting
-vulnerability. See <a href="http://en.wikipedia.org/wiki/HTTP_response_splitting">http://en.wikipedia.org/wiki/HTTP_response_splitting</a>
-for more information.</p>
-<p>FindBugs looks only for the most blatant, obvious cases of HTTP response splitting.
-If FindBugs found <em>any</em>, you <em>almost certainly</em> have more
-vulnerabilities that FindBugs doesn't report. If you are concerned about HTTP response splitting, you should seriously
-consider using a commercial static analysis or pen-testing tool.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code directly writes an HTTP parameter to an HTTP header, which allows for a HTTP response splitting
-vulnerability. See <a href="http://en.wikipedia.org/wiki/HTTP_response_splitting">http://en.wikipedia.org/wiki/HTTP_response_splitting</a>
-for more information.</p>
-<p>FindBugs looks only for the most blatant, obvious cases of HTTP response splitting.
-If FindBugs found <em>any</em>, you <em>almost certainly</em> have more
-vulnerabilities that FindBugs doesn't report. If you are concerned about HTTP response splitting, you should seriously
-consider using a commercial static analysis or pen-testing tool.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A large String constant is duplicated across multiple class files.
- This is likely because a final field is initialized to a String constant, and the Java language
- mandates that all references to a final field from other classes be inlined into
-that classfile. See <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6447475">JDK bug 6447475</a>
- for a description of an occurrence of this bug in the JDK and how resolving it reduced
- the size of the JDK by 1 megabyte.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> An inner class is invoking a method that could be resolved to either a inherited method or a method defined in an outer class. By the Java semantics,
-it will be resolved to invoke the inherited method, but this may not be want
-you intend. If you really intend to invoke the inherited method,
-invoke it by invoking the method on super (e.g., invoke super.foo(17)), and
-thus it will be clear to other readers of your code and to FindBugs
-that you want to invoke the inherited method, not the method in the outer class.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code performs an integer shift by a constant amount outside
-the range 0..31.
-The effect of this is to use the lower 5 bits of the integer
-value to decide how much to shift by. This probably isn't want was expected,
-and it at least confusing.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code casts the result of an integer division operation to double or
-float.
-Doing division on integers truncates the result
-to the integer value closest to zero. The fact that the result
-was cast to double suggests that this precision should have been retained.
-What was probably meant was to cast one or both of the operands to
-double <em>before</em> performing the division. Here is an example:
-</p>
-<blockquote>
-<pre>
-int x = 2;
-int y = 5;
-// Wrong: yields result 0.0
-double value1 = x / y;
-
-// Right: yields result 0.4
-double value2 = x / (double) y;
-</pre>
-</blockquote>
\ No newline at end of file
+++ /dev/null
-<p>
-This code performs integer multiply and then converts the result to a long,
-as in:
-<code>
-<pre>
- long convertDaysToMilliseconds(int days) { return 1000*3600*24*days; }
-</pre></code>
-If the multiplication is done using long arithmetic, you can avoid
-the possibility that the result will overflow. For example, you
-could fix the above code to:
-<code>
-<pre>
- long convertDaysToMilliseconds(int days) { return 1000L*3600*24*days; }
-</pre></code>
-or
-<code>
-<pre>
- static final long MILLISECONDS_PER_DAY = 24L*3600*1000;
- long convertDaysToMilliseconds(int days) { return days * MILLISECONDS_PER_DAY; }
-</pre></code>
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code converts a 32-bit int value to a 64-bit long value, and then passes that value for a
-method parameter that requires an absolute time value. An absolute time value is the number of
-milliseconds since the standard base time known as "the epoch", namely January 1, 1970, 00:00:00 GMT.
-For example, the following method, intended to convert seconds since the epoc into a Date, is badly broken:
-<pre>
-Date getDate(int seconds) { return new Date(seconds * 1000); }
-</pre>
-</p>
-<p>The multiplication is done using 32-bit arithmetic, and then converted to a 64-bit value. When a 32-bit
-value is converted to 64-bits and used to express an absolute time value, only dates in December 1969 and
-January 1970 can be represented.</p>
-<p>Correct implementations for the above method are:
-<pre>
-// Fails for dates after 2037
-Date getDate(int seconds) { return new Date(seconds * 1000L); }
-
-// better, works for all dates
-Date getDate(long seconds) { return new Date(seconds * 1000); }
-</pre>
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code converts an int value to a double precision
-floating point number and then
-passing the result to the Math.ceil() function, which rounds a double to
-the next higher integer value. This operation should always be a no-op,
-since the converting an integer to a double should give a number with no fractional part.
-It is likely that the operation that generated the value to be passed
-to Math.ceil was intended to be performed using double precision
-floating point arithmetic.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code converts an int value to a float precision
-floating point number and then
-passing the result to the Math.round() function, which returns the int/long closest
-to the argument. This operation should always be a no-op,
-since the converting an integer to a float should give a number with no fractional part.
-It is likely that the operation that generated the value to be passed
-to Math.round was intended to be performed using
-floating point arithmetic.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code performs an unsigned right shift, whose result is then
-cast to a short or byte, which discards the upper bits of the result.
-Since the upper bits are discarded, there may be no difference between
-a signed and unsigned right shift (depending upon the size of the shift).
-</p>
\ No newline at end of file
+++ /dev/null
-<p> A circularity was detected in the static initializers of the two
- classes referenced by the bug instance. Many kinds of unexpected
- behavior may arise from such circularity.</p>
\ No newline at end of file
+++ /dev/null
-<p> During the initialization of a class, the class makes an active use of a subclass.
-That subclass will not yet be initialized at the time of this use.
-For example, in the following code, <code>foo</code> will be null.</p>
-
-<pre>
-public class CircularClassInitialization {
- static class InnerClassSingleton extends CircularClassInitialization {
- static InnerClassSingleton singleton = new InnerClassSingleton();
- }
-
- static CircularClassInitialization foo = InnerClassSingleton.singleton;
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-<p> A JUnit assertion is performed in a run method. Failed JUnit assertions
-just result in exceptions being thrown.
-Thus, if this exception occurs in a thread other than the thread that invokes
-the test method, the exception will terminate the thread but not result
-in the test failing.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> Class is a JUnit TestCase and defines a suite() method.
-However, the suite method needs to be declared as either
-<pre>public static junit.framework.Test suite()</pre>
-or
-<pre>public static junit.framework.TestSuite suite()</pre>
-</p>
\ No newline at end of file
+++ /dev/null
-<p> Class is a JUnit TestCase but has not implemented any test methods</p>
\ No newline at end of file
+++ /dev/null
-<p> Class is a JUnit TestCase and implements the setUp method. The setUp method should call
-super.setUp(), but doesn't.</p>
\ No newline at end of file
+++ /dev/null
-<p> Class is a JUnit TestCase and implements the suite() method.
- The suite method should be declared as being static, but isn't.</p>
\ No newline at end of file
+++ /dev/null
-<p> Class is a JUnit TestCase and implements the tearDown method. The tearDown method should call
-super.tearDown(), but doesn't.</p>
\ No newline at end of file
+++ /dev/null
-<p>A collection is added to itself. As a result, computing the hashCode of this
-set will throw a StackOverflowException.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This loop doesn't seem to have a way to terminate (other than by perhaps
-throwing an exception).</p>
\ No newline at end of file
+++ /dev/null
-<p>This method unconditionally invokes itself. This would seem to indicate
-an infinite recursive loop that will result in a stack overflow.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method of an inner class reads from or writes to a private member variable of the owning class,
- or calls a private method of the owning class. The compiler must generate a special method to access this
- private member, causing this to be less efficient. Relaxing the protection of the member variable or method
- will allow the compiler to treat this as a normal access.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>IllegalMonitorStateException is generally only
- thrown in case of a design flaw in your code (calling wait or
- notify on an object you do not hold a lock on).</p>
\ No newline at end of file
+++ /dev/null
-<p>The code computes the average of two integers using either division or signed right shift,
-and then uses the result as the index of an array.
-If the values being averaged are very large, this can overflow (resulting in the computation
-of a negative average). Assuming that the result is intended to be nonnegative, you
-can use an unsigned right shift instead. In other words, rather that using <code>(low+high)/2</code>,
-use <code>(low+high) >>> 1</code>
-</p>
-<p>This bug exists in many earlier implementations of binary search and merge sort.
-Martin Buchholz <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6412541">found and fixed it</a>
-in the JDK libraries, and Joshua Bloch
-<a href="http://googleresearch.blogspot.com/2006/06/extra-extra-read-all-about-it-nearly.html">widely
-publicized the bug pattern</a>.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code uses x % 2 == 1 to check to see if a value is odd, but this won't work
-for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check
-for oddness, consider using x & 1 == 1, or x % 2 != 0.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code multiplies the result of an integer remaining by an integer constant.
-Be sure you don't have your operator precedence confused. For example
-i % 60 * 1000 is (i % 60) * 1000, not i % (60 * 1000).
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code compares an int value with a long constant that is outside the range of values that can
- be represented as an int value. This comparison is vacuous and possibily to be incorrect.</p>
\ No newline at end of file
+++ /dev/null
-<p> This code compares a value that is guaranteed to be non-negative with a negative constant.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> Signed bytes can only have a value in the range -128 to 127. Comparing
-a signed byte with a value outside that range is vacuous and likely to be incorrect.
-To convert a signed byte <code>b</code> to an unsigned value in the range 0..255,
-use <code>0xff & b</code>
-</p>
\ No newline at end of file
+++ /dev/null
-<p> Any expression (exp % 1) is guaranteed to always return zero.
-Did you mean (exp & 1) or (exp % 2) instead?
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This is an integer bit operation (and, or, or exclusive or) that doesn't do any useful work
-(e.g., <code>v & 0xffffffff</code>).
-
-</p>
\ No newline at end of file
+++ /dev/null
-<p> There is an integer comparison that always returns
-the same value (e.g., x <= Integer.MAX_VALUE).
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This code opens a file in append mode and then wraps the result in an object output stream.
- This won't allow you to append to an existing object output stream stored in a file. If you want to be
- able to append to an object output stream, you need to keep the object output stream open.
- </p>
- <p>The only situation in which opening a file in append mode and the writing an object output stream
- could work is if on reading the file you plan to open it in random access mode and seek to the byte offset
- where the append started.
- </p>
-
- <p>
- TODO: example.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
-The initial value of this parameter is ignored, and the parameter
-is overwritten here. This often indicates a mistaken belief that
-the write to the parameter will be conveyed back to
-the caller.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The fields of this class appear to be accessed inconsistently with respect
- to synchronization. This bug report indicates that the bug pattern detector
- judged that
- </p>
- <ol>
- <li> The class contains a mix of locked and unlocked accesses,</li>
- <li> At least one locked access was performed by one of the class's own methods, and</li>
- <li> The number of unsynchronized field accesses (reads and writes) was no more than
- one third of all accesses, with writes being weighed twice as high as reads</li>
- </ol>
-
- <p> A typical bug matching this bug pattern is forgetting to synchronize
- one of the methods in a class that is intended to be thread-safe.</p>
-
- <p> You can select the nodes labeled "Unsynchronized access" to show the
- code locations where the detector believed that a field was accessed
- without synchronization.</p>
-
- <p> Note that there are various sources of inaccuracy in this detector;
- for example, the detector cannot statically detect all situations in which
- a lock is held. Also, even when the detector is accurate in
- distinguishing locked vs. unlocked accesses, the code in question may still
- be correct.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class allocates an object that is based on a class that only supplies static methods. This object
-does not need to be created, just access the static methods directly using the class name as a qualifier.</p>
\ No newline at end of file
+++ /dev/null
-<p> This field is annotated with net.jcip.annotations.GuardedBy,
-but can be accessed in a way that seems to violate the annotation.</p>
\ No newline at end of file
+++ /dev/null
-<p> The fields of this class appear to be accessed inconsistently with respect
- to synchronization. This bug report indicates that the bug pattern detector
- judged that
- </p>
- <ol>
- <li> The class contains a mix of locked and unlocked accesses,</li>
- <li> At least one locked access was performed by one of the class's own methods, and</li>
- <li> The number of unsynchronized field accesses (reads and writes) was no more than
- one third of all accesses, with writes being weighed twice as high as reads</li>
- </ol>
-
- <p> A typical bug matching this bug pattern is forgetting to synchronize
- one of the methods in a class that is intended to be thread-safe.</p>
-
- <p> Note that there are various sources of inaccuracy in this detector;
- for example, the detector cannot statically detect all situations in which
- a lock is held. Also, even when the detector is accurate in
- distinguishing locked vs. unlocked accesses, the code in question may still
- be correct.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method uses the toArray() method of a collection derived class, and passes
-in a zero-length prototype array argument. It is more efficient to use
-<code>myCollection.toArray(new Foo[myCollection.size()])</code>
-If the array passed in is big enough to store all of the
-elements of the collection, then it is populated and returned
-directly. This avoids the need to create a second array
-(by reflection) to return as the result.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class implements the <code>java.util.Iterator</code> interface.
- However, its <code>next()</code> method is not capable of throwing
- <code>java.util.NoSuchElementException</code>. The <code>next()</code>
- method should be changed so it throws <code>NoSuchElementException</code>
- if is called when there are no more elements to return.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code seems to be storing a non-serializable object into an HttpSession.
-If this session is passivated or migrated, an error will result.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The class is annotated with net.jcip.annotations.Immutable, and the rules for that annotation require
-that all fields are final.
- .</p>
\ No newline at end of file
+++ /dev/null
-<p> This method performs synchronization on an implementation of
-<code>java.util.concurrent.locks.Lock</code>. You should use
-the <code>lock()</code> and <code>unlock()</code> methods instead.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This method calls <code>wait()</code>, <code>notify()</code> or <code>notifyAll()</code> on an object that also
-provides an <code>await()</code>, <code>signal()</code>, <code>signalAll()</code> method (such as util.concurrent
-Condition objects). This probably isn't what you want, and even if you do want it, you should consider changing your
-design, as other developers will find it exceptionally confusing.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- OpenJDK introduces a potential incompatibility.
- In particular, the java.util.logging.Logger behavior has
- changed. Instead of using strong references, it now uses weak references
- internally. That's a reasonable change, but unfortunately some code relies on
- the old behavior - when changing logger configuration, it simply drops the
- logger reference. That means that the garbage collector is free to reclaim
- that memory, which means that the logger configuration is lost. For example,
- consider:
- </p>
- <p><pre>public static void initLogging() throws Exception {
- Logger logger = Logger.getLogger("edu.umd.cs");
- logger.addHandler(new FileHandler()); // call to change logger configuration
- logger.setUseParentHandlers(false); // another call to change logger configuration
- }</pre></p>
- <p>The logger reference is lost at the end of the method (it doesn't
- escape the method), so if you have a garbage collection cycle just
- after the call to initLogging, the logger configuration is lost
- (because Logger only keeps weak references).</p>
- <p><pre>public static void main(String[] args) throws Exception {
- initLogging(); // adds a file handler to the logger
- System.gc(); // logger configuration lost
- Logger.getLogger("edu.umd.cs").info("Some message"); // this isn't logged to the file as expected
- }</pre></p>
- <p><em>Ulf Ochsenfahrt and Eric Fellheimer</em>
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains an unsynchronized lazy initialization of a non-volatile static field.
-Because the compiler or processor may reorder instructions,
-threads are not guaranteed to see a completely initialized object,
-<em>if the method can be called by multiple threads</em>.
-You can make the field volatile to correct the problem.
-For more information, see the
-<a href="http://www.cs.umd.edu/~pugh/java/memoryModel/">Java Memory Model web site</a>.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains an unsynchronized lazy initialization of a static field.
-After the field is set, the object stored into that location is further accessed.
-The setting of the field is visible to other threads as soon as it is set. If the
-futher accesses in the method that set the field serve to initialize the object, then
-you have a <em>very serious</em> multithreading bug, unless something else prevents
-any other thread from accessing the stored object until it is fully initialized.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a field with the same name as a visible
-instance field in a superclass. This is confusing, and
-may indicate an error if methods update or access one of
-the fields when they wanted the other.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method defines a local variable with the same name as a field
-in this class or a superclass. This may cause the method to
-read an uninitialized value from the field, leave the field uninitialized,
-or both.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method synchronizes on a field in what appears to be an attempt
-to guard against simultaneous updates to that field. But guarding a field
-gets a lock on the referenced object, not on the field. This may not
-provide the mutual exclusion you need, and other threads might
-be obtaining locks on the referenced objects (for other purposes). An example
-of this pattern would be:
-
-<p><pre>
-private Long myNtfSeqNbrCounter = new Long(0);
-private Long getNotificationSequenceNumber() {
- Long result = null;
- synchronized(myNtfSeqNbrCounter) {
- result = new Long(myNtfSeqNbrCounter.longValue() + 1);
- myNtfSeqNbrCounter = new Long(result.longValue());
- }
- return result;
- }
-</pre>
-
-
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method synchronizes on an object
- referenced from a mutable field.
- This is unlikely to have useful semantics, since different
-threads may be synchronizing on different objects.</p>
\ No newline at end of file
+++ /dev/null
-<p>A web server generally only creates one instance of servlet or jsp class (i.e., treats
-the class as a Singleton),
-and will
-have multiple threads invoke methods on that instance to service multiple
-simultaneous requests.
-Thus, having a mutable instance field generally creates race conditions.
\ No newline at end of file
+++ /dev/null
-<p>
- A mutable static field could be changed by malicious code or
- by accident from another package.
- Unfortunately, the way the field is used doesn't allow
- any easy fix to this problem.</p>
\ No newline at end of file
+++ /dev/null
-<p> A public static method returns a reference to
- an array that is part of the static state of the class.
- Any code that calls this method can freely modify
- the underlying array.
- One fix is to return a copy of the array.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A mutable static field could be changed by malicious code or
- by accident from another package.
- The field could be made package protected and/or made final
- to avoid
- this vulnerability.</p>
\ No newline at end of file
+++ /dev/null
-<p> A final static field references an array
- and can be accessed by malicious code or
- by accident from another package.
- This code can freely modify the contents of the array.</p>
\ No newline at end of file
+++ /dev/null
-<p>A final static field references a Hashtable
- and can be accessed by malicious code or
- by accident from another package.
- This code can freely modify the contents of the Hashtable.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A final static field that is
-defined in an interface references a mutable
- object such as an array or hashtable.
- This mutable object could
- be changed by malicious code or
- by accident from another package.
- To solve this, the field needs to be moved to a class
- and made package protected
- to avoid
- this vulnerability.</p>
\ No newline at end of file
+++ /dev/null
-<p> A mutable static field could be changed by malicious code or
- by accident.
- The field could be made package protected to avoid
- this vulnerability.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A mutable static field could be changed by malicious code or
- by accident from another package.
- The field could be made final to avoid
- this vulnerability.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This static field public but not final, and
-could be changed by malicious code or
-by accident from another package.
-The field could be made final to avoid
-this vulnerability. However, the static initializer contains more than one write
-to the field, so doing so will require some refactoring.
-</p>
+++ /dev/null
-<p>
- This class extends from a Servlet class, and uses an instance member variable. Since only
- one instance of a Servlet class is created by the J2EE framework, and used in a
- multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
- only using method local variables.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This class extends from a Struts Action class, and uses an instance member variable. Since only
- one instance of a struts Action class is created by the Struts framework, and used in a
- multithreaded way, this paradigm is highly discouraged and most likely problematic. Consider
- only using method local variables. Only instance fields that are written outside of a monitor
- are reported.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This method calls Object.notify() or Object.notifyAll() without obviously holding a lock
-on the object. Calling notify() or notifyAll() without a lock held will result in
-an <code>IllegalMonitorStateException</code> being thrown.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method calls Object.wait() without obviously holding a lock
-on the object. Calling wait() without a lock held will result in
-an <code>IllegalMonitorStateException</code> being thrown.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This class defines a method <code>equal(Object)</code>.
- This method does not override the <code>equals(Object)</code> method
- in <code>java.lang.Object</code>, which is probably what was intended.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- Class names should be nouns, in mixed case with the first letter of each internal word capitalized.
- Try to keep your class names simple and descriptive. Use whole words-avoid acronyms and abbreviations
- (unless the abbreviation is much more widely used than the long form, such as URL or HTML).
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This class is not derived from another exception, but ends with 'Exception'. This will
-be confusing to users of this class.</p>
\ No newline at end of file
+++ /dev/null
-<p> The referenced methods have names that differ only by capitalization.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- Names of fields that are not final should be in mixed case
- with a lowercase first letter and the first letters of subsequent words capitalized.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>The identifier is a word that is reserved as a keyword in later versions of Java, and your code will need to be changed
-in order to compile it in later versions of Java.</p>
\ No newline at end of file
+++ /dev/null
-<p>This identifier is used as a keyword in later versions of Java. This code, and
-any code that references this API,
-will need to be changed in order to compile it in later versions of Java.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This class defines a method called <code>hashcode()</code>.
- This method does not override the <code>hashCode()</code>
- method in <code>java.lang.Object</code>, which is probably what was intended.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This class defines a method called <code>tostring()</code>.
- This method does not override the <code>toString()</code>
- method in <code>java.lang.Object</code>, which is probably what was intended.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This regular method has the same name as the class it is defined in. It is likely that this was intended to be a constructor.
- If it was intended to be a constructor, remove the declaration of a void return value.
- If you had accidently defined this method, realized the mistake, defined a proper constructor
- but can't get rid of this method due to backwards compatibility, deprecate the method.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- Methods should be verbs, in mixed case with the first letter lowercase,
- with the first letter of each internal word capitalized.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This class/interface has a simple name that is identical to that of an implemented/extended interface, except
-that the interface is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>).
-This can be exceptionally confusing, create lots of situations in which you have to look at import statements
-to resolve references and creates many
-opportunities to accidently define methods that do not override methods in their superclasses.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class has a simple name that is identical to that of its superclass, except
-that its superclass is in a different package (e.g., <code>alpha.Foo</code> extends <code>beta.Foo</code>).
-This can be exceptionally confusing, create lots of situations in which you have to look at import statements
-to resolve references and creates many
-opportunities to accidently define methods that do not override methods in their superclasses.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The referenced methods have names that differ only by capitalization.
-This is very confusing because if the capitalization were
-identical then one of the methods would override the other.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The referenced methods have names that differ only by capitalization.
-This is very confusing because if the capitalization were
-identical then one of the methods would override the other. From the existence of other methods, it
-seems that the existence of both of these methods is intentional, but is sure is confusing.
-You should try hard to eliminate one of them, unless you are forced to have both due to frozen APIs.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match
-the type of the corresponding parameter in the superclass. For example, if you have:</p>
-
-<blockquote>
-<pre>
-import alpha.Foo;
-public class A {
- public int f(Foo x) { return 17; }
-}
-----
-import beta.Foo;
-public class B extends A {
- public int f(Foo x) { return 42; }
-}
-</pre>
-</blockquote>
-
-<p>The <code>f(Foo)</code> method defined in class <code>B</code> doesn't
-override the
-<code>f(Foo)</code> method defined in class <code>A</code>, because the argument
-types are <code>Foo</code>'s from different packages.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The method in the subclass doesn't override a similar method in a superclass because the type of a parameter doesn't exactly match
-the type of the corresponding parameter in the superclass. For example, if you have:</p>
-
-<blockquote>
-<pre>
-import alpha.Foo;
-public class A {
- public int f(Foo x) { return 17; }
-}
-----
-import beta.Foo;
-public class B extends A {
- public int f(Foo x) { return 42; }
- public int f(alpha.Foo x) { return 27; }
-}
-</pre>
-</blockquote>
-
-<p>The <code>f(Foo)</code> method defined in class <code>B</code> doesn't
-override the
-<code>f(Foo)</code> method defined in class <code>A</code>, because the argument
-types are <code>Foo</code>'s from different packages.
-</p>
-
-<p>In this case, the subclass does define a method with a signature identical to the method in the superclass,
-so this is presumably understood. However, such methods are exceptionally confusing. You should strongly consider
-removing or deprecating the method with the similar but not identical signature.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> A call to <code>notify()</code> or <code>notifyAll()</code>
- was made without any (apparent) accompanying
- modification to mutable object state. In general, calling a notify
- method on a monitor is done because some condition another thread is
- waiting for has become true. However, for the condition to be meaningful,
- it must involve a heap object that is visible to both threads.</p>
-
- <p> This bug does not necessarily indicate an error, since the change to
- mutable object state may have taken place in a method which then called
- the method containing the notification.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method calls <code>notify()</code> rather than <code>notifyAll()</code>.
- Java monitors are often used for multiple conditions. Calling <code>notify()</code>
- only wakes up one thread, meaning that the thread woken up might not be the
- one waiting for the condition that the caller just satisfied.</p>
\ No newline at end of file
+++ /dev/null
-<p> A null pointer is dereferenced here. This will lead to a
-<code>NullPointerException</code> when the code is executed.</p>
\ No newline at end of file
+++ /dev/null
-<p> A pointer which is null on an exception path is dereferenced here.
-This will lead to a <code>NullPointerException</code> when the code is executed.
-Note that because FindBugs currently does not prune infeasible exception paths,
-this may be a false warning.</p>
-
-<p> Also note that FindBugs considers the default case of a switch statement to
-be an exception path, since the default case is often infeasible.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A parameter to this method has been identified as a value that should
- always be checked to see whether or not it is null, but it is being dereferenced
- without a preceding null check.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- A method that returns either Boolean.TRUE, Boolean.FALSE or null is an accident waiting to happen.
- This method can be invoked as though it returned a value of type boolean, and
- the compiler will insert automatic unboxing of the Boolean value. If a null value is returned,
- this will result in a NullPointerException.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This clone method seems to return null in some circumstances, but clone is never
- allowed to return a null value. If you are convinced this path is unreachable, throw an AssertionError
- instead.
- </p>
\ No newline at end of file
+++ /dev/null
-close() is being invoked on a value that is always null. If this statement is executed, a null pointer exception will occur. But the big risk here you never close something that should be closed.
\ No newline at end of file
+++ /dev/null
-<p> The result of invoking readLine() is dereferenced without checking to see if the result is null. If there are no more lines of text
-to read, readLine() will return null and dereferencing that will generate a null pointer exception.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This implementation of equals(Object) violates the contract defined
- by java.lang.Object.equals() because it does not check for null
- being passed as the argument. All equals() methods should return
- false if passed a null value.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- There is a statement or branch that if executed guarantees that
- a value is null at this point, and that
- value that is guaranteed to be dereferenced
- (except on forward paths involving runtime exceptions).
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- There is a statement or branch on an exception path
- that if executed guarantees that
- a value is null at this point, and that
- value that is guaranteed to be dereferenced
- (except on forward paths involving runtime exceptions).
- </p>
\ No newline at end of file
+++ /dev/null
-<p> The result of invoking readLine() is immediately dereferenced. If there are no more lines of text
-to read, readLine() will return null and dereferencing that will generate a null pointer exception.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The variable referenced at this point is known to be null due to an earlier
- check against null. Although this is valid, it might be a mistake (perhaps you
-intended to refer to a different variable, or perhaps the earlier check to see if the
-variable is null should have been a check to see if it was nonnull).
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The field is marked as nonnull, but isn't written to by the constructor.
-The field might be initialized elsewhere during constructor, or might always
-be initialized before use.
-</p>
+++ /dev/null
-<p>
- This method passes a null value as the parameter of a method which
- must be nonnull. Either this parameter has been explicitly marked
- as @Nonnull, or analysis has determined that this parameter is
- always dereferenced.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method may return a null value, but the method (or a superclass method
- which it overrides) is declared to return @NonNull.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
-This instanceof test will always return false, since the value being checked is guaranteed to be null.
-Although this is safe, make sure it isn't
-an indication of some misunderstanding or some other logic error.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> There is a branch of statement that, <em>if executed,</em> guarantees that
-a null value will be dereferenced, which
-would generate a <code>NullPointerException</code> when the code is executed.
-Of course, the problem might be that the branch or statement is infeasible and that
-the null pointer exception can't ever be executed; deciding that is beyond the ability of FindBugs.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> A reference value which is null on some exception control path is
-dereferenced here. This may lead to a <code>NullPointerException</code>
-when the code is executed.
-Note that because FindBugs currently does not prune infeasible exception paths,
-this may be a false warning.</p>
-
-<p> Also note that FindBugs considers the default case of a switch statement to
-be an exception path, since the default case is often infeasible.</p>
\ No newline at end of file
+++ /dev/null
-<p> The return value from a method is dereferenced without a null check,
-and the return value of that method is one that should generally be checked
-for null. This may lead to a <code>NullPointerException</code> when the code is executed.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> There is a branch of statement that, <em>if executed,</em> guarantees that
-a null value will be dereferenced, which
-would generate a <code>NullPointerException</code> when the code is executed.
-Of course, the problem might be that the branch or statement is infeasible and that
-the null pointer exception can't ever be executed; deciding that is beyond the ability of FindBugs.
-Due to the fact that this value had been previously tested for nullness, this is a definite possibility.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method call passes a null value for a nonnull method parameter.
- Either the parameter is annotated as a parameter that should
- always be nonnull, or analysis has shown that it will always be
- dereferenced.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- A possibly-null value is passed at a call site where all known
- target methods require the parameter to be nonnull.
- Either the parameter is annotated as a parameter that should
- always be nonnull, or analysis has shown that it will always be
- dereferenced.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- A possibly-null value is passed to a nonnull method parameter.
- Either the parameter is annotated as a parameter that should
- always be nonnull, or analysis has shown that it will always be
- dereferenced.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This parameter is always used in a way that requires it to be nonnull,
-but the parameter is explicitly annotated as being Nullable. Either the use
-of the parameter or the annotation is wrong.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> A value that could be null is stored into a field that has been annotated as NonNull. </p>
\ No newline at end of file
+++ /dev/null
-<p>Since the field is synchronized on, it seems not likely to be null.
-If it is null and then synchronized on a NullPointerException will be
-thrown and the check would be pointless. Better to synchronize on
-another field.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This toString method seems to return null in some circumstances. A liberal reading of the
- spec could be interpreted as allowing this, but it is probably a bad idea and could cause
- other code to break. Return the empty string or some other appropriate string rather than null.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>The program is dereferencing a field that does not seem to ever have a non-null value written to it. Dereferencing this value will generate a null pointer exception.</p>
\ No newline at end of file
+++ /dev/null
-<p>The program is dereferencing a public or protected field that does not seem to ever have a non-null
- value written to it. Unless the field is initialized via some mechanism not seen by the analysis,
- dereferencing this value will generate a null pointer exception.</p>
\ No newline at end of file
+++ /dev/null
-<p> This code seems to be using non-short-circuit logic (e.g., &
-or |)
-rather than short-circuit logic (&& or ||). In addition,
-it seem possible that, depending on the value of the left hand side, you might not
-want to evaluate the right hand side (because it would have side effects, could cause an exception
-or could be expensive.</p>
-<p>
-Non-short-circuit logic causes both sides of the expression
-to be evaluated even when the result can be inferred from
-knowing the left-hand side. This can be less efficient and
-can result in errors if the left-hand side guards cases
-when evaluating the right-hand side can generate an error.
-</p>
-
-<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
-Language Specification</a> for details
-
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This code seems to be using non-short-circuit logic (e.g., &
-or |)
-rather than short-circuit logic (&& or ||).
-Non-short-circuit logic causes both sides of the expression
-to be evaluated even when the result can be inferred from
-knowing the left-hand side. This can be less efficient and
-can result in errors if the left-hand side guards cases
-when evaluating the right-hand side can generate an error.
-
-<p>See <a href="http://java.sun.com/docs/books/jls/third_edition/html/expressions.html#15.22.2">the Java
-Language Specification</a> for details
-
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method may fail to clean up (close, dispose of) a stream,
- database object, or other
- resource requiring an explicit cleanup operation.
- </p>
- <p>
- In general, if a method opens a stream or other resource,
- the method should use a try/finally block to ensure that
- the stream or resource is cleaned up before the method
- returns.
- </p>
- <p>
- This bug pattern is essentially the same as the
- OS_OPEN_STREAM and ODR_OPEN_DATABASE_RESOURCE
- bug patterns, but is based on a different
- (and hopefully better) static analysis technique.
- We are interested is getting feedback about the
- usefulness of this bug pattern.
- To send feedback, either:
- </p>
- <ul>
- <li>send email to findbugs@cs.umd.edu</li>
- <li>file a bug report: <a href="http://findbugs.sourceforge.net/reportingBugs.html">http://findbugs.sourceforge.net/reportingBugs.html</a></li>
- </ul>
- <p>
- In particular,
- the false-positive suppression heuristics for this
- bug pattern have not been extensively tuned, so
- reports about false positives are helpful to us.
- </p>
- <p>
- See Weimer and Necula, <i>Finding and Preventing Run-Time Error Handling Mistakes</i>, for
- a description of the analysis technique.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>This method may fail to clean up (close, dispose of) a stream, database object, or other resource requiring an
-explicit cleanup operation.<br/>In general, if a method opens a stream or other resource, the method should use a try/finally block to ensure
-that the stream or resource is cleaned up before the method returns.<p/>
-<p>This bug pattern is essentially the same as the OS_OPEN_STREAM and ODR_OPEN_DATABASE_RESOURCE bug patterns, but is based on a different
-(and hopefully better) static analysis technique. See Weimer and Necula, Finding and Preventing Run-Time Error Handling Mistakes, for a
-description of the analysis technique. .</p>
\ No newline at end of file
+++ /dev/null
-<p> The method creates a database resource (such as a database connection
-or row set), does not assign it to any
-fields, pass it to other methods, or return it, and does not appear to close
-the object on all paths out of the method. Failure to
-close database resources on all paths out of a method may
-result in poor performance, and could cause the application to
-have problems communicating with the database.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The method creates a database resource (such as a database connection
-or row set), does not assign it to any
-fields, pass it to other methods, or return it, and does not appear to close
-the object on all exception paths out of the method. Failure to
-close database resources on all paths out of a method may
-result in poor performance, and could cause the application to
-have problems communicating with the database.</p>
\ No newline at end of file
+++ /dev/null
-<p> The method creates an IO stream object, does not assign it to any
-fields, pass it to other methods that might close it,
-or return it, and does not appear to close
-the stream on all paths out of the method. This may result in
-a file descriptor leak. It is generally a good
-idea to use a <code>finally</code> block to ensure that streams are
-closed.</p>
\ No newline at end of file
+++ /dev/null
-<p> The method creates an IO stream object, does not assign it to any
-fields, pass it to other methods, or return it, and does not appear to close
-it on all possible exception paths out of the method.
-This may result in a file descriptor leak. It is generally a good
-idea to use a <code>finally</code> block to ensure that streams are
-closed.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This class uses synchronization along with wait(), notify() or notifyAll() on itself (the this
- reference). Client classes that use this class, may, in addition, use an instance of this class
- as a synchronizing object. Because two classes are using the same object for synchronization,
- Multithread correctness is suspect. You should not synchronize nor call semaphore methods on
- a public reference. Consider using a internal private member variable to control synchronization.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
-The software uses an HTTP request parameter to construct a pathname that should be within a restricted directory,
-but it does not properly neutralize absolute path sequences such as "/abs/path" that can resolve to a location that is outside of that directory.
-
-See <a href="http://cwe.mitre.org/data/definitions/36.html">http://cwe.mitre.org/data/definitions/36.html</a> for more information.
-</p>
-
-<p>
-FindBugs looks only for the most blatant, obvious cases of absolute path traversal.
-If FindBugs found <em>any</em>, you <em>almost certainly</em> have more
-vulnerabilities that FindBugs doesn't report. If you are concerned about absolute path traversal, you should seriously
-consider using a commercial static analysis or pen-testing tool.
-</p>
+++ /dev/null
-<p>
-The software uses an HTTP request parameter to construct a pathname that should be within a restricted directory,
-but it does not properly neutralize sequences such as ".." that can resolve to a location that is outside of that directory.
-
-See <a href="http://cwe.mitre.org/data/definitions/23.html">http://cwe.mitre.org/data/definitions/23.html</a> for more information.</p>
-
-<p>
-FindBugs looks only for the most blatant, obvious cases of relative path traversal.
-If FindBugs found <em>any</em>, you <em>almost certainly</em> have more
-vulnerabilities that FindBugs doesn't report. If you are concerned about relative path traversal, you should seriously
-consider using a commercial static analysis or pen-testing tool.
-</p>
+++ /dev/null
-<p> It is often a better design to
-return a length zero array rather than a null reference to indicate that there
-are no results (i.e., an empty list of results).
-This way, no explicit check for null is needed by clients of the method.</p>
-
-<p>On the other hand, using null to indicate
-"there is no answer to this question" is probably appropriate.
-For example, <code>File.listFiles()</code> returns an empty list
-if given a directory containing no files, and returns null if the file
-is not a directory.</p>
\ No newline at end of file
+++ /dev/null
-<p>The entrySet() method is allowed to return a view of the underlying Map in which an <code>Iterator</code>
-and <code>Map.Entry</code>. This clever idea was used in several Map implementations, but introduces the possibility of
- nasty coding mistakes. If a map m returns such an iterator for an entrySet, then <code>c.addAll(m.entrySet())</code> will
- go badly wrong. All of the Map implementations in OpenJDK 1.7 have been rewritten to avoid this, you should to.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method assigns a literal boolean value (true or false) to a boolean variable inside
- an if or while expression. Most probably this was supposed to be a boolean comparison using
- ==, not an assignment using =.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>Are you sure this for loop is incrementing the correct variable?
- It appears that another variable is being initialized and checked
- by the for loop.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a reference known to be non-null with another reference
-known to be null.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a redundant comparison of two references known to
-both be definitely null.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a redundant check of a known non-null value against
-the constant null.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a redundant check of a known null value against
-the constant null.</p>
\ No newline at end of file
+++ /dev/null
-<p> A value is checked here to see whether it is null, but this value can't
-be null because it was previously dereferenced and if it were null a null pointer
-exception would have occurred at the earlier dereference.
-Essentially, this code and the previous dereference
-disagree as to whether this value is allowed to be null. Either the check is redundant
-or the previous dereference is erroneous.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method compares two reference values using the == or != operator,
-where the correct way to compare instances of this type is generally
-with the equals() method. Examples of classes which should generally
-not be compared by reference are java.lang.Integer, java.lang.Float, etc.</p>
\ No newline at end of file
+++ /dev/null
-This method compares a reference value to a constant using the == or != operator, where the correct way to compare instances of this type is generally with the equals() method. It is possible to create distinct instances that are equal but do not compare as == since they are different objects. Examples of classes which should generally not be compared by reference are java.lang.Integer, java.lang.Float, etc.
\ No newline at end of file
+++ /dev/null
-This method compares two Boolean values using the == or != operator. Normally, there are only two Boolean values (Boolean.TRUE and Boolean.FALSE), but it is possible to create other Boolean objects using the new Boolean(b) constructor. It is best to avoid such objects, but if they do exist, then checking Boolean objects for equality using == or != will give results than are different than you would get using .equals(...)
\ No newline at end of file
+++ /dev/null
-<p>
- This method uses a try-catch block that catches Exception objects, but Exception is not
- thrown within the try block, and RuntimeException is not explicitly caught. It is a common bug pattern to
- say try { ... } catch (Exception e) { something } as a shorthand for catching a number of types of exception
- each of whose catch blocks is identical, but this construct also accidentally catches RuntimeException as well,
- masking potential bugs.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code here uses a regular expression that is invalid according to the syntax
-for regular expressions. This statement will throw a PatternSyntaxException when
-executed.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The code here uses <code>File.separator</code>
-where a regular expression is required. This will fail on Windows
-platforms, where the <code>File.separator</code> is a backslash, which is interpreted in a
-regular expression as an escape character. Amoung other options, you can just use
-<code>File.separatorChar=='\\' & "\\\\" : File.separator</code> instead of
-<code>File.separator</code>
-
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-A String function is being invoked and "." is being passed
-to a parameter that takes a regular expression as an argument. Is this what you intended?
-For example
-s.replaceAll(".", "/") will return a String in which <em>every</em>
-character has been replaced by a / character.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This class declares that it implements an interface that is also implemented by a superclass.
- This is redundant because once a superclass implements an interface, all subclasses by default also
- implement this interface. It may point out that the inheritance hierarchy has changed since
- this class was created, and consideration should be given to the ownership of
- the interface's implementation.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This method ignores the return value of one of the variants of
- <code>java.io.InputStream.read()</code> which can return multiple bytes.
- If the return value is not checked, the caller will not be able to correctly
- handle the case where fewer bytes were read than the caller requested.
- This is a particularly insidious kind of bug, because in many programs,
- reads from input streams usually do read the full amount of data requested,
- causing the program to fail only sporadically.</p>
\ No newline at end of file
+++ /dev/null
-<p> This serializable class defines a <code>readObject()</code> which is
- synchronized. By definition, an object created by deserialization
- is only reachable by one thread, and thus there is no need for
- <code>readObject()</code> to be synchronized. If the <code>readObject()</code>
- method itself is causing the object to become visible to another thread,
- that is an example of very dubious coding style.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method explicitly invokes <code>run()</code> on an object.
- In general, classes implement the <code>Runnable</code> interface because
- they are going to have their <code>run()</code> method invoked in a new thread,
- in which case <code>Thread.start()</code> is the right method to call.</p>
\ No newline at end of file
+++ /dev/null
-<p>A random value from 0 to 1 is being coerced to the integer value 0. You probably
-want to multiple the random value by something else before coercing it to an integer, or use the <code>Random.nextInt(n)</code> method.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This code generates a hashcode and then computes
-the absolute value of that hashcode. If the hashcode
-is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
-<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This code generates a random signed integer and then computes
-the absolute value of that random integer. If the number returned by the random number
-generator is <code>Integer.MIN_VALUE</code>, then the result will be negative as well (since
-<code>Math.abs(Integer.MIN_VALUE) == Integer.MIN_VALUE</code>).
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code invoked a compareTo or compare method, and checks to see if the return value is a specific
-value, such as 1 or -1. When invoking these methods, you should only check the sign of the result, not
-for any specific non-zero value. While many or most compareTo and compare methods only return -1, 0 or 1,
-some of them will return other values.</p>
\ No newline at end of file
+++ /dev/null
-<p> The method invokes String.indexOf and checks to see if the result is positive or non-positive.
- It is much more typical to check to see if the result is negative or non-negative. It is
- positive only if the substring checked for occurs at some place other than at the beginning of
- the String.</p>
\ No newline at end of file
+++ /dev/null
-<p> The value returned by readLine is discarded after checking to see if the return
-value is non-null. In almost all situations, if the result is non-null, you will want
-to use that non-null value. Calling readLine again will give you a different line.</p>
\ No newline at end of file
+++ /dev/null
-<p> This code creates an exception (or error) object, but doesn't do anything with it. For example,
-something like </p>
-<blockquote>
-<pre>
-if (x < 0)
- new IllegalArgumentException("x must be nonnegative");
-</pre>
-</blockquote>
-<p>It was probably the intent of the programmer to throw the created exception:</p>
-<blockquote>
-<pre>
-if (x < 0)
- throw new IllegalArgumentException("x must be nonnegative");
-</pre>
-</blockquote>
\ No newline at end of file
+++ /dev/null
-<p>This code negatives the return value of a compareTo or compare method. This is a questionable or bad
-programming practice, since if the return value is Integer.MIN_VALUE, negating the return value won't
-negate the sign of the result. You can achieve the same intended result by reversing the order of the
-operands rather than by negating the results.</p>
\ No newline at end of file
+++ /dev/null
-<p> This code computes a hashCode, and then computes
-the remainder of that value modulo another value. Since the hashCode
-can be negative, the result of the remainder operation
-can also be negative. </p>
-<p> Assuming you want to ensure that the result of your computation is nonnegative,
-you may need to change your code.
-If you know the divisor is a power of 2,
-you can use a bitwise and operator instead (i.e., instead of
-using <code>x.hashCode()%n</code>, use <code>x.hashCode()&(n-1)</code>.
-This is probably faster than computing the remainder as well.
-If you don't know that the divisor is a power of 2, take the absolute
-value of the result of the remainder operation (i.e., use
-<code>Math.abs(x.hashCode()%n)</code>
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This code generates a random signed integer and then computes
-the remainder of that value modulo another value. Since the random
-number can be negative, the result of the remainder operation
-can also be negative. Be sure this is intended, and strongly
-consider using the Random.nextInt(int) method instead.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The return value of this method should be checked. One common
-cause of this warning is to invoke a method on an immutable object,
-thinking that it updates the object. For example, in the following code
-fragment,</p>
-<blockquote>
-<pre>
-String dateString = getHeaderField(name);
-dateString.trim();
-</pre>
-</blockquote>
-<p>the programmer seems to be thinking that the trim() method will update
-the String referenced by dateString. But since Strings are immutable, the trim()
-function returns a new String value, which is being ignored here. The code
-should be corrected to: </p>
-<blockquote>
-<pre>
-String dateString = getHeaderField(name);
-dateString = dateString.trim();
-</pre>
-</blockquote>
\ No newline at end of file
+++ /dev/null
-<p> The return value of this method should be checked. One common
-cause of this warning is to invoke a method on an immutable object,
-thinking that it updates the object. For example, in the following code
-fragment,</p>
-<blockquote>
-<pre>
-String dateString = getHeaderField(name);
-dateString.trim();
-</pre>
-</blockquote>
-<p>the programmer seems to be thinking that the trim() method will update
-the String referenced by dateString. But since Strings are immutable, the trim()
-function returns a new String value, which is being ignored here. The code
-should be corrected to: </p>
-<blockquote>
-<pre>
-String dateString = getHeaderField(name);
-dateString = dateString.trim();
-</pre>
-</blockquote>
\ No newline at end of file
+++ /dev/null
-<p> This method returns a value that is not checked. The return value should be checked
-since it can indicate an unusual or unexpected function execution. For
-example, the <code>File.delete()</code> method returns false
-if the file could not be successfully deleted (rather than
-throwing an Exception).
-If you don't check the result, you won't notice if the method invocation
-signals unexpected behavior by returning an atypical return value.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code calls a method and ignores the return value. The return value is the same type as the type the
-method is invoked on, and from our analysis it looks like the return value might be important (e.g., like
-ignoring the return value of <code>String.toLowerCase()</code>).
-</p>
-<p>We are guessing that ignoring the return value might be a bad idea just from a simple analysis of the
-body of the method. You can use a <code>@CheckReturnValue</code> annotation to instruct FindBugs as to whether
-ignoring the return value of this method is important or acceptable.<p>
-<p>Please investigate this closely to decide whether it is OK to ignore the return value. </p>
\ No newline at end of file
+++ /dev/null
-The putIfAbsent method is typically used to ensure that a single value is associated with a given key (the first value for which put if absent succeeds). If you ignore the return value and retain a reference to the value passed in, you run the risk of retaining a value that is not the one that is associated with the key in the map. If it matters which one you use and you use the one that isn't stored in the map, your program will behave incorrectly.
\ No newline at end of file
+++ /dev/null
-<p>The code contains a conditional test is performed twice, one right after the other
-(e.g., <code>x == 0 || x == 0</code>). Perhaps the second occurrence is intended to be something else
-(e.g., <code>x == 0 || y == 0</code>).
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a double assignment of a field; e.g.
-</p>
-<pre>
- int x,y;
- public void foo() {
- x = x = 17;
- }
-</pre>
-<p>Assigning to a field twice is useless, and may indicate a logic error or typo.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a self assignment of a field; e.g.
-</p>
-<pre>
- int x;
- public void foo() {
- x = x;
- }
-</pre>
-<p>Such assignments are useless, and may indicate a logic error or typo.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method compares a field with itself, and may indicate a typo or
-a logic error. Make sure that you are comparing the right things.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method performs a nonsensical computation of a field with another
-reference to the same field (e.g., x&x or x-x). Because of the nature
-of the computation, this operation doesn't seem to make sense,
-and may indicate a typo or
-a logic error. Double check the computation.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a double assignment of a local variable; e.g.
-</p>
-<pre>
- public void foo() {
- int x,y;
- x = x = 17;
- }
-</pre>
-<p>Assigning the same value to a variable twice is useless, and may indicate a logic error or typo.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a self assignment of a local variable; e.g.</p>
-<pre>
- public void foo() {
- int x = 3;
- x = x;
- }
-</pre>
-<p>
-Such assignments are useless, and may indicate a logic error or typo.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This method contains a self assignment of a local variable, and there is a field with an identical name.
-Assignment appears to have been ; e.g.
-<pre>
- int foo;
- public void setFoo(int foo) {
- foo = foo;
- }
-</pre>
-The assignment is useless. Did you mean to assign to the field instead?</p>
\ No newline at end of file
+++ /dev/null
-<p> This method compares a local variable with itself, and may indicate a typo or
-a logic error. Make sure that you are comparing the right things.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method performs a nonsensical computation of a local variable with another
-reference to the same variable (e.g., x&x or x-x). Because of the nature
-of the computation, this operation doesn't seem to make sense,
-and may indicate a typo or
-a logic error. Double check the computation.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The method seems to be building a String using concatenation in a loop.
-In each iteration, the String is converted to a StringBuffer/StringBuilder,
- appended to, and converted back to a String.
- This can lead to a cost quadratic in the number of iterations,
- as the growing string is recopied in each iteration. </p>
-
-<p>Better performance can be obtained by using
-a StringBuffer (or StringBuilder in Java 1.5) explicitly.</p>
-
-<p> For example:</p>
-<pre>
- // This is bad
- String s = "";
- for (int i = 0; i < field.length; ++i) {
- s = s + field[i];
- }
-
- // This is better
- StringBuffer buf = new StringBuffer();
- for (int i = 0; i < field.length; ++i) {
- buf.append(field[i]);
- }
- String s = buf.toString();
-</pre>
\ No newline at end of file
+++ /dev/null
-<p> The constructor starts a thread. This is likely to be wrong if
- the class is ever extended/subclassed, since the thread will be started
- before the subclass constructor is started.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This Serializable class defines a non-primitive instance field which is neither transient,
- Serializable, or <code>java.lang.Object</code>, and does not appear to implement the <code>Externalizable</code>
- interface or the <code>readObject()</code> and <code>writeObject()</code> methods.
- Objects of this class will not be deserialized correctly if a non-Serializable object is stored in this field.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This Serializable class is an inner class of a non-serializable class.
-Thus, attempts to serialize it will also attempt to associate instance of the outer
-class with which it is associated, leading to a runtime error.
-</p>
-<p>If possible, making the inner class a static inner class should solve the
-problem. Making the outer class serializable might also work, but that would
-mean serializing an instance of the inner class would always also serialize the instance
-of the outer class, which it often not what you really want.
\ No newline at end of file
+++ /dev/null
-<p> A non-serializable value is stored into a non-transient field
-of a serializable class.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class implements the <code>Comparator</code> interface. You
-should consider whether or not it should also implement the <code>Serializable</code>
-interface. If a comparator is used to construct an ordered collection
-such as a <code>TreeMap</code>, then the <code>TreeMap</code>
-will be serializable only if the comparator is also serializable.
-As most comparators have little or no state, making them serializable
-is generally easy and good defensive programming.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This Serializable class is an inner class. Any attempt to serialize
-it will also serialize the associated outer instance. The outer instance is serializable,
-so this won't fail, but it might serialize a lot more data than intended.
-If possible, making the inner class a static inner class (also known as a nested class) should solve the
-problem.
\ No newline at end of file
+++ /dev/null
-<p> This class implements the <code>Serializable</code> interface, and defines a method
- for custom serialization/deserialization. But since that method isn't declared private,
- it will be silently ignored by the serialization/deserialization API.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a <code>serialVersionUID</code> field that is not final.
- The field should be made final
- if it is intended to specify
- the version UID for purposes of serialization.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a <code>serialVersionUID</code> field that is not long.
- The field should be made long
- if it is intended to specify
- the version UID for purposes of serialization.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a <code>serialVersionUID</code> field that is not static.
- The field should be made static
- if it is intended to specify
- the version UID for purposes of serialization.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class implements the <code>Serializable</code> interface, but does
- not define a <code>serialVersionUID</code> field.
- A change as simple as adding a reference to a .class object
- will add synthetic fields to the class,
- which will unfortunately change the implicit
- serialVersionUID (e.g., adding a reference to <code>String.class</code>
- will generate a static field <code>class$java$lang$String</code>).
- Also, different source code to bytecode compilers may use different
- naming conventions for synthetic variables generated for
- references to class objects or inner classes.
- To ensure interoperability of Serializable across versions,
- consider adding an explicit serialVersionUID.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class implements the <code>Serializable</code> interface
- and its superclass does not. When such an object is deserialized,
- the fields of the superclass need to be initialized by
- invoking the void constructor of the superclass.
- Since the superclass does not have one,
- serialization and deserialization will fail at runtime.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class implements the <code>Externalizable</code> interface, but does
- not define a void constructor. When Externalizable objects are deserialized,
- they first need to be constructed by invoking the void
- constructor. Since this class does not have one,
- serialization and deserialization will fail at runtime.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class defines a private readResolve method. Since it is private, it won't be inherited by subclasses.
-This might be intentional and OK, but should be reviewed to ensure it is what is intended.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> In order for the readResolve method to be recognized by the serialization
-mechanism, it must not be declared as a static method.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> In order for the readResolve method to be recognized by the serialization
-mechanism, it must be declared to have a return type of Object.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class contains a field that is updated at multiple places in the class, thus it seems to be part of the state of the class. However, since the field is marked as transient and not set in readObject or readResolve, it will contain the default value in any
-deserialized instance of the class.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> The field is marked as transient, but the class isn't Serializable, so marking it as transient
-has absolutely no effect.
-This may be leftover marking from a previous version of the code in which the class was transient, or
-it may indicate a misunderstanding of how serialization works.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A value stored in the previous switch case is overwritten here due
- to a switch fall through. It is likely that you forgot to put a
- break or return at the end of the previous case.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- A value stored in the previous switch case is ignored here due to a switch fall through to a place where an exception is thrown.
- It is likely that you forgot to put a break or return at the end of the previous case.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method contains a switch statement where one case branch will fall
- through to the next case. Usually you need to end this case with a break or return.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method contains a switch statement where default case is missing.
- Usually you need to provide a default case.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This class is an inner class, but does not use its embedded reference
- to the object which created it. This reference makes the instances
- of the class larger, and may keep the reference to the creator object
- alive longer than necessary. If possible, the class should be
- made static.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This class is an inner class, but does not use its embedded reference
- to the object which created it. This reference makes the instances
- of the class larger, and may keep the reference to the creator object
- alive longer than necessary. If possible, the class should be
- made into a <em>static</em> inner class. Since anonymous inner
-classes cannot be marked as static, doing this will require refactoring
-the inner class so that it is a named inner class.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class is an inner class, but does not use its embedded reference
- to the object which created it except during construction of the
-inner object. This reference makes the instances
- of the class larger, and may keep the reference to the creator object
- alive longer than necessary. If possible, the class should be
- made into a <em>static</em> inner class. Since the reference to the
- outer object is required during construction of the inner instance,
- the inner class will need to be refactored so as to
- pass a reference to the outer instance to the constructor
- for the inner class.</p>
\ No newline at end of file
+++ /dev/null
-This class is an inner class, but should probably be a static inner class. As it is, there is a serious danger of a deadly embrace between the inner class and the thread local in the outer class. Because the inner class isn't static, it retains a reference to the outer class. If the thread local contains a reference to an instance of the inner class, the inner and outer instance will both be reachable and not eligible for garbage collection.
\ No newline at end of file
+++ /dev/null
-<p> Type check performed using the instanceof operator where it can be statically determined whether the object
-is of the type requested. </p>
\ No newline at end of file
+++ /dev/null
-<p> The class's static initializer creates an instance of the class
-before all of the static final fields are assigned.</p>
\ No newline at end of file
+++ /dev/null
-<p>This class is bigger than can be effectively handled, and was not fully analyzed for errors.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method spins in a loop which reads a field. The compiler
- may legally hoist the read out of the loop, turning the code into an
- infinite loop. The class should be changed so it uses proper
- synchronization (including wait and notify calls).</p>
\ No newline at end of file
+++ /dev/null
-<p> A call to a setXXX method of a prepared statement was made where the
-parameter index is 0. As parameter indexes start at index 1, this is always a mistake.</p>
\ No newline at end of file
+++ /dev/null
-<p> A call to getXXX or updateXXX methods of a result set was made where the
-field index is 0. As ResultSet fields start at index 1, this is always a mistake.</p>
\ No newline at end of file
+++ /dev/null
-<p>The method invokes the execute method on an SQL statement with a String that seems
-to be dynamically generated. Consider using
-a prepared statement instead. It is more efficient and less vulnerable to
-SQL injection attacks.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>The code creates an SQL prepared statement from a nonconstant String.
-If unchecked, tainted data from a user is used in building this String, SQL injection could
-be used to make the prepared statement do something unexpected and undesirable.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method ignores the return value of
- <code>java.io.InputStream.skip()</code> which can skip multiple bytes.
- If the return value is not checked, the caller will not be able to correctly
- handle the case where fewer bytes were skipped than the caller requested.
- This is a particularly insidious kind of bug, because in many programs,
- skips from input streams usually do skip the full amount of data requested,
- causing the program to fail only sporadically. With Buffered streams, however,
- skip() will only skip data in the buffer, and will routinely fail to skip the
- requested number of bytes.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class contains an instance final field that
- is initialized to a compile-time static value.
- Consider making the field static.</p>
\ No newline at end of file
+++ /dev/null
-<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
-The detector has found a call to an instance of Calendar that has been obtained via a static
-field. This looks suspicous.</p>
-<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
-and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
\ No newline at end of file
+++ /dev/null
-<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
-The detector has found a call to an instance of DateFormat that has been obtained via a static
-field. This looks suspicous.</p>
-<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
-and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
\ No newline at end of file
+++ /dev/null
-<p>Even though the JavaDoc does not contain a hint about it, Calendars are inherently unsafe for multihtreaded use.
-Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
-application. Under 1.4 problems seem to surface less often than under Java 5 where you will probably see
-random ArrayIndexOutOfBoundsExceptions or IndexOutOfBoundsExceptions in sun.util.calendar.BaseCalendar.getCalendarDateFromFixedDate().</p>
-<p>You may also experience serialization problems.</p>
-<p>Using an instance field is recommended.</p>
-<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
-and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
\ No newline at end of file
+++ /dev/null
-<p>As the JavaDoc states, DateFormats are inherently unsafe for multithreaded use.
-Sharing a single instance across thread boundaries without proper synchronization will result in erratic behavior of the
-application.</p>
-<p>You may also experience serialization problems.</p>
-<p>Using an instance field is recommended.</p>
-<p>For more information on this see <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6231579">Sun Bug #6231579</a>
-and <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6178997">Sun Bug #6178997</a>.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This method invokes the Thread.currentThread() call, just to call the interrupted() method. As interrupted() is a
-static method, is more simple and clear to use Thread.interrupted().
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This method invokes the Thread.interrupted() method on a Thread object that appears to be a Thread object that is
-not the current thread. As the interrupted() method is static, the interrupted method will be called on a different
-object than the one the author intended.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This instance method writes to a static field. This is tricky to get
-correct if multiple instances are being manipulated,
-and generally bad practice.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method calls Thread.sleep() with a lock held. This may result
- in very poor performance and scalability, or a deadlock, since other threads may
- be waiting to acquire the lock. It is a much better idea to call
- wait() on the lock, which releases the lock and allows other threads
- to run.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>(<a href="http://java.sun.com/developer/JDCTechTips/2003/tt1208.html#1">From JDC Tech Tip</a>): The Swing methods
-show(), setVisible(), and pack() will create the associated peer for the frame.
-With the creation of the peer, the system creates the event dispatch thread.
-This makes things problematic because the event dispatch thread could be notifying
-listeners while pack and validate are still processing. This situation could result in
-two threads going through the Swing component-based GUI -- it's a serious flaw that
-could result in deadlocks or other related threading issues. A pack call causes
-components to be realized. As they are being realized (that is, not necessarily
-visible), they could trigger listener notification on the event dispatch thread.</p>
\ No newline at end of file
+++ /dev/null
-<p> Waiting on a monitor while two locks are held may cause
- deadlock.
-
- Performing a wait only releases the lock on the object
- being waited on, not any other locks.
-
-This not necessarily a bug, but is worth examining
- closely.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A value specified as carrying a type qualifier annotation is
- consumed in a location or locations requiring that the value not
- carry that annotation.
- </p>
-
- <p>
- More precisely, a value annotated with a type qualifier specifying when=ALWAYS
- is guaranteed to reach a use or uses where the same type qualifier specifies when=NEVER.
- </p>
-
- <p>
- For example, say that @NonNegative is a nickname for
- the type qualifier annotation @Negative(when=When.NEVER).
- The following code will generate this warning because
- the return statement requires a @NonNegative value,
- but receives one that is marked as @Negative.
- </p>
- <blockquote>
-<pre>
-public @NonNegative Integer example(@Negative Integer value) {
- return value;
-}
-</pre>
- </blockquote>
\ No newline at end of file
+++ /dev/null
-<p>
-A value specified as carrying a type qualifier annotation is
-compared with a value that doesn't ever carry that qualifier.
-</p>
-
-<p>
-More precisely, a value annotated with a type qualifier specifying when=ALWAYS
-is compared with a value that where the same type qualifier specifies when=NEVER.
-</p>
-
-<p>
-For example, say that @NonNegative is a nickname for
-the type qualifier annotation @Negative(when=When.NEVER).
-The following code will generate this warning because
-the return statement requires a @NonNegative value,
-but receives one that is marked as @Negative.
-</p>
-<pre>
-public boolean example(@Negative Integer value1, @NonNegative Integer value2) {
- return value1.equals(value2);
-}
-</pre>
+++ /dev/null
-<p>
- A value is used in a way that requires it to be always be a value denoted by a type qualifier, but
- there is an explicit annotation stating that it is not known where the value is required to have that type qualifier.
- Either the usage or the annotation is incorrect.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- A value is used in a way that requires it to be never be a value denoted by a type qualifier, but
- there is an explicit annotation stating that it is not known where the value is prohibited from having that type qualifier.
- Either the usage or the annotation is incorrect.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- A value that is annotated as possibility not being an instance of
- the values denoted by the type qualifier, and the value is guaranteed to be used
- in a way that requires values denoted by that type qualifier.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- A value that is annotated as possibility being an instance of
- the values denoted by the type qualifier, and the value is guaranteed to be used
- in a way that prohibits values denoted by that type qualifier.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- A value specified as not carrying a type qualifier annotation is guaranteed
- to be consumed in a location or locations requiring that the value does
- carry that annotation.
- </p>
-
- <p>
- More precisely, a value annotated with a type qualifier specifying when=NEVER
- is guaranteed to reach a use or uses where the same type qualifier specifies when=ALWAYS.
- </p>
-
- <p>
- TODO: example
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a useless control flow statement, where
-control flow continues onto the same place regardless of whether or not
-the branch is taken. For example,
-this is caused by having an empty statement
-block for an <code>if</code> statement:</p>
-<pre>
- if (argv.length == 0) {
- // TODO: handle this case
- }
-</pre>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a useless control flow statement in which control
-flow follows to the same or following line regardless of whether or not
-the branch is taken.
-Often, this is caused by inadvertently using an empty statement as the
-body of an <code>if</code> statement, e.g.:</p>
-<pre>
- if (argv.length == 1);
- System.out.println("Hello, " + argv[0]);
-</pre>
\ No newline at end of file
+++ /dev/null
-<p> This class contains similarly-named get and set
- methods where the set method is synchronized and the get method is not.
- This may result in incorrect behavior at runtime, as callers of the get
- method will not necessarily see a consistent state for the object.
- The get method should be made synchronized.</p>
\ No newline at end of file
+++ /dev/null
-<p>Calling <code>this.getClass().getResource(...)</code> could give
-results other than expected if this class is extended by a class in
-another package.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
-but does not release it on all paths out of the method. In general, the correct idiom
-for using a JSR-166 lock is:
-</p>
-<pre>
- Lock l = ...;
- l.lock();
- try {
- // do something
- } finally {
- l.unlock();
- }
-</pre>
\ No newline at end of file
+++ /dev/null
-<p> This method acquires a JSR-166 (<code>java.util.concurrent</code>) lock,
-but does not release it on all exception paths out of the method. In general, the correct idiom
-for using a JSR-166 lock is:
-</p>
-<pre>
- Lock l = ...;
- l.lock();
- try {
- // do something
- } finally {
- l.unlock();
- }
-</pre>
\ No newline at end of file
+++ /dev/null
-<p> This anonymous class defined a method that is not directly invoked and does not override
-a method in a superclass. Since methods in other classes cannot directly invoke methods
-declared in an anonymous class, it seems that this method is uncallable. The method
-might simply be dead code, but it is also possible that the method is intended to
-override a method declared in a superclass, and due to an typo or other error the method does not,
-in fact, override the method it is intended to.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This method uses a static method from java.lang.Math on a constant value. This method's
-result in this case, can be determined statically, and is faster and sometimes more accurate to
-just use the constant. Methods detected are:
-</p>
-<table>
-<tr>
- <th>Method</th> <th>Parameter</th>
-</tr>
-<tr>
- <td>abs</td> <td>-any-</td>
-</tr>
-<tr>
- <td>acos</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>asin</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>atan</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>atan2</td> <td>0.0</td>
-</tr>
-<tr>
- <td>cbrt</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>ceil</td> <td>-any-</td>
-</tr>
-<tr>
- <td>cos</td> <td>0.0</td>
-</tr>
-<tr>
- <td>cosh</td> <td>0.0</td>
-</tr>
-<tr>
- <td>exp</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>expm1</td> <td>0.0</td>
-</tr>
-<tr>
- <td>floor</td> <td>-any-</td>
-</tr>
-<tr>
- <td>log</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>log10</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>rint</td> <td>-any-</td>
-</tr>
-<tr>
- <td>round</td> <td>-any-</td>
-</tr>
-<tr>
- <td>sin</td> <td>0.0</td>
-</tr>
-<tr>
- <td>sinh</td> <td>0.0</td>
-</tr>
-<tr>
- <td>sqrt</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>tan</td> <td>0.0</td>
-</tr>
-<tr>
- <td>tanh</td> <td>0.0</td>
-</tr>
-<tr>
- <td>toDegrees</td> <td>0.0 or 1.0</td>
-</tr>
-<tr>
- <td>toRadians</td> <td>0.0</td>
-</tr>
-</table>
\ No newline at end of file
+++ /dev/null
-<p>
- This method invokes the .equals(Object o) method on a final class that doesn't override the equals method
- in the Object class, effectively making the equals method test for sameness, like ==. It is good to use
- the .equals method, but you should consider adding an .equals method in this class.
- </p>
- <p>[Bill Pugh]: Sorry, but I strongly disagree that this should be a warning, and I think your code
- is just fine. Users of your code shouldn't care how you've implemented equals(), and they should never
- depend on == to compare instances, since that bypasses the libraries ability to control how objects
- are compared.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This private method is never called. Although it is
-possible that the method will be invoked through reflection,
-it is more likely that the method is never used, and should be
-removed.
-</p>
\ No newline at end of file
+++ /dev/null
-<p> This field is never read. Consider removing it from the class.</p>
\ No newline at end of file
+++ /dev/null
-<p>This field is never read. The field is public or protected, so perhaps it is intended to be
-used with classes not seen as part of the analysis. If not, consider removing it from the class.</p>
\ No newline at end of file
+++ /dev/null
-<p> This constructor reads a field which has not yet been assigned a value.
- This is often caused when the programmer mistakenly uses the field instead
- of one of the constructor's parameters.</p>
\ No newline at end of file
+++ /dev/null
-<p>This method is invoked in the constructor of of the superclass. At this point, the fields of the class have not yet initialized. To make this more concrete, consider the following classes:</p>
-<pre>
- abstract class A {
- int hashCode;
- abstract Object getValue();
- A() {
- hashCode = getValue().hashCode();
- }
- }
- class B extends A {
- Object value;
- B(Object v) {
- this.value = v;
- }
- Object getValue() {
- return value;
- }
- }
-</pre>
-<p>When a B is constructed, the constructor for the A class is invoked before the constructor for B sets value. Thus, when the constructor for A invokes getValue, an uninitialized value is read for value.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This abstract method is already defined in an interface that is implemented by this abstract
- class. This method can be removed, as it provides no additional value.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
- This derived method merely calls the same superclass method passing in the exact parameters
- received. This method can be removed, as it provides no additional value.
- </p>
\ No newline at end of file
+++ /dev/null
-<p> This field is never used. Consider removing it from the class.</p>
\ No newline at end of file
+++ /dev/null
-<p>This field is never used. The field is public or protected, so perhaps it is intended to be used
-with classes not seen as part of the analysis. If not, consider removing it from the class.</p>
\ No newline at end of file
+++ /dev/null
-<p>This field is never initialized within any constructor, and is therefore could be null after the object is constructed. This could be a either an error or a questionable design, since it means a null pointer exception will be generated if that field is dereferenced before being initialized.</p>
\ No newline at end of file
+++ /dev/null
-<p> All writes to this field are of the constant value null, and thus
-all reads of the field will return null.
-Check for errors, or remove it if it is useless.</p>
\ No newline at end of file
+++ /dev/null
-<p>This field is never written. All reads of it will return the default value. Check for errors (should it have been initialized?), or remove it if it is useless.</p>
\ No newline at end of file
+++ /dev/null
-<p>No writes were seen to this public/protected field. All reads of it will return the default value.
-Check for errors (should it have been initialized?), or remove it if it is useless.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a call to <code>java.lang.Object.wait()</code> which
- is not guarded by conditional control flow. The code should
- verify that condition it intends to wait for is not already satisfied
- before calling wait; any previous notifications will be ignored.
- </p>
\ No newline at end of file
+++ /dev/null
-<p>
-A format-string method with a variable number of arguments is called,
-but the number of arguments passed does not match with the number of
-% placeholders in the format string. This is probably not what the
-author intended.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The format string placeholder is incompatible with the corresponding
-argument. For example,
-<code>
- System.out.println("%d\n", "hello");
-</code>
-<p>The %d placeholder requires a numeric argument, but a string value is
-passed instead.
-A runtime exception will occur when
-this statement is executed.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-One of the arguments is uncompatible with the corresponding format string specifier.
-As a result, this will generate a runtime exception when executed.
-For example, <code>String.format("%d", "1")</code> will generate an exception, since
-the String "1" is incompatible with the format specifier %d.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-One of the arguments being formatted with a format string is an array. This will be formatted
-using a fairly useless format, such as [I@304282, which doesn't actually show the contents
-of the array.
-Consider wrapping the array using <code>Arrays.asList(...)</code> before handling it off to a formatted.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-An argument not of type Boolean is being formatted with a %b format specifier. This won't throw an
-exception; instead, it will print true for any nonnull value, and false for null.
-This feature of format strings is strange, and may not be what you intended.
-</p>
\ No newline at end of file
+++ /dev/null
-A method is called that expects a Java printf format string and a list of arguments. However, the format string doesn't contain any format specifiers (e.g., %s) but does contain message format elements (e.g., {0}). It is likely that the code is supplying a MessageFormat string when a printf-style format string is required. At runtime, all of the arguments will be ignored and the format string will be returned exactly as provided without any formatting.
\ No newline at end of file
+++ /dev/null
-<p>
-A format-string method with a variable number of arguments is called,
-but more arguments are passed than are actually used by the format string.
-This won't cause a runtime exception, but the code may be silently omitting
-information that was intended to be included in the formatted string.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The format string is syntactically invalid,
-and a runtime exception will occur when
-this statement is executed.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-Not enough arguments are passed to satisfy a placeholder in the format string.
-A runtime exception will occur when
-this statement is executed.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
-The format string specifies a relative index to request that the argument for the previous format specifier
-be reused. However, there is no previous argument.
-For example,
-</p>
-<p><code>formatter.format("%<s %s", "a", "b")</code>
-</p>
-<p>would throw a MissingFormatArgumentException when executed.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This format string include a newline character (\n). In format strings, it is generally preferable
-better to use %n, which will produce the platform-specific line separator.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-This code passes a primitive array to a function that takes a variable number of object arguments.
-This creates an array of length one to hold the primitive array and passes it to the function.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code increments a volatile field. Increments of volatile fields aren't atomic. If more
-than one thread is incrementing the field at the same time, increments could be lost. </p>
\ No newline at end of file
+++ /dev/null
-<p>This declares a volatile reference to an array, which might not be what
-you want. With a volatile reference to an array, reads and writes of
-the reference to the array are treated as volatile, but the array elements
-are non-volatile. To get volatile array elements, you will need to use
-one of the atomic array classes in java.util.concurrent (provided
-in Java 5.0).</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a call to <code>java.util.concurrent.await()</code>
- (or variants)
- which is not in a loop. If the object is used for multiple conditions,
- the condition the caller intended to wait for might not be the one
- that actually occurred.</p>
\ No newline at end of file
+++ /dev/null
-<p> This method contains a call to <code>java.lang.Object.wait()</code>
- which is not in a loop. If the monitor is used for multiple conditions,
- the condition the caller intended to wait for might not be the one
- that actually occurred.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This instance method synchronizes on <code>this.getClass()</code>. If this class is subclassed,
- subclasses will synchronize on the class object for the subclass, which isn't likely what was intended.
- For example, consider this code from java.awt.Label:
- <pre>
- private static final String base = "label";
- private static int nameCounter = 0;
- String constructComponentName() {
- synchronized (getClass()) {
- return base + nameCounter++;
- }
- }
- </pre></p>
- <p>Subclasses of <code>Label</code> won't synchronize on the same subclass, giving rise to a datarace.
- Instead, this code should be synchronizing on <code>Label.class</code>
- <pre>
- private static final String base = "label";
- private static int nameCounter = 0;
- String constructComponentName() {
- synchronized (Label.class) {
- return base + nameCounter++;
- }
- }
- </pre></p>
- <p>Bug pattern contributed by Jason Mehrens</p>
\ No newline at end of file
+++ /dev/null
-<p> This method accesses the value of a Map entry, using a key that was retrieved from
-a keySet iterator. It is more efficient to use an iterator on the entrySet of the map, to avoid the
-Map.get(key) lookup.</p>
\ No newline at end of file
+++ /dev/null
-<p> This class has a <code>writeObject()</code> method which is synchronized;
- however, no other method of the class is synchronized.</p>
\ No newline at end of file
+++ /dev/null
-<p>
- This method allocates a specific implementation of an xml interface. It is preferable to use
- the supplied factory classes to create these objects so that the implementation can be
- changed at runtime. See
- </p>
- <ul>
- <li>javax.xml.parsers.DocumentBuilderFactory</li>
- <li>javax.xml.parsers.SAXParserFactory</li>
- <li>javax.xml.transform.TransformerFactory</li>
- <li>org.w3c.dom.Document.create<i>XXXX</i></li>
- </ul>
- <p>for details.</p>
\ No newline at end of file
+++ /dev/null
-<p>This code directly writes an HTTP parameter to JSP output, which allows for a cross site scripting
-vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a>
-for more information.</p>
-<p>FindBugs looks only for the most blatant, obvious cases of cross site scripting.
-If FindBugs found <em>any</em>, you <em>almost certainly</em> have more cross site scripting
-vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously
-consider using a commercial static analysis or pen-testing tool.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code directly writes an HTTP parameter to a Server error page (using HttpServletResponse.sendError). Echoing this untrusted input allows
-for a reflected cross site scripting
-vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a>
-for more information.</p>
-<p>FindBugs looks only for the most blatant, obvious cases of cross site scripting.
-If FindBugs found <em>any</em>, you <em>almost certainly</em> have more cross site scripting
-vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously
-consider using a commercial static analysis or pen-testing tool.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>This code directly writes an HTTP parameter to Servlet output, which allows for a reflected cross site scripting
-vulnerability. See <a href="http://en.wikipedia.org/wiki/Cross-site_scripting">http://en.wikipedia.org/wiki/Cross-site_scripting</a>
-for more information.</p>
-<p>FindBugs looks only for the most blatant, obvious cases of cross site scripting.
-If FindBugs found <em>any</em>, you <em>almost certainly</em> have more cross site scripting
-vulnerabilities that FindBugs doesn't report. If you are concerned about cross site scripting, you should seriously
-consider using a commercial static analysis or pen-testing tool.
-</p>
\ No newline at end of file
noData=No data
newWindow=New window
-# dependencies viewer (tab)
-depsTab.afferentCouplings=Afferent (incoming) couplings
-depsTab.efferentCouplings=Efferent (outgoing) couplings
-depsTab.classes=Classes
-depsTab.dit=Depth in Tree
-depsTab.noc=Number of Children
-depsTab.rfc=Response for Class
-depsTab.lcom4=Lack of Cohesion of Methods
-
-
# Design page (DSM)
design.help=Help
design.legend.dependencies=Dependency
libs.expand=Expand all
libs.collapse=Collapse all
libs.noLibraries=No libraries
-libs.usageLink=Usages
-
-
-# Duplications viewer
-dupl.lines=Lines
-dupl.duplicated_lines=Duplicated lines
-dupl.duplicated_blocks=Duplicated blocks
-dupl.colSize=Nb lines
-dupl.colFromLine=From line
-dupl.colFile=File
-
-
-# Hotspots
-hotspot.titleMostViolatedRules=Most violated rules
-hotspot.titleMostViolatedResources=Most violated
-hotspot.titleLongestTests=Longest unit tests
-hotspot.titleMostComplexResources=Highest complexity
-hotspot.titleMostDuplicatedResources=Highest duplications
-hotspot.titleLessTested=Highest untested lines
-hotspot.titleMostComplexMethods=Highest average method complexity
-hotspot.titleMostUndocumentedAPI=Most undocumented APIs
-hotspot.noMeasures=No measures
-hotspot.anySeverity=Any severity
-hotspot.moreDetails=more
-hotspot.lcom4=Lack of Cohesion of Methods
-hotspot.rfc=Response for class
-hotspot.designTitle=Highest
-
-
-# LCOM4 viewer
-lcom4.metric=Lack of Cohesion of Methods
-
-
-# Unit tests viewer
-unittest.duration=Duration
-unittest.name=Unit test name
-unittest.skipped=skipped
-unittest.tests=Tests
-unittest.failures=Failures/Errors
\ No newline at end of file
+libs.usageLink=Usages
\ No newline at end of file
+++ /dev/null
-#
-# IMPORTANT: the bundle for the Java plugin (and the corresponding rule descriptions in the "java" fodler) are currently located here
-# because the sonar-java-plugin is currently a Core plugin. They should be moved out and placed inside the Java Plugin once
-# (or if one day) the plugin is pulled out of the Sonar Platform to be an independant plugin (like any other language plugin).
-#
-
-rule.common-java.InsufficientBranchCoverage.name=Insufficient branch coverage by unit tests
-rule.common-java.InsufficientBranchCoverage.param.minimumBranchCoverageRatio=The minimum required branch coverage ratio.
-
-rule.common-java.InsufficientCommentDensity.name=Insufficient comment density
-rule.common-java.InsufficientCommentDensity.param.minimumCommentDensity=The minimum required comment density.
-
-rule.common-java.DuplicatedBlocks.name=Duplicated blocks
-
-rule.common-java.InsufficientLineCoverage.name=Insufficient line coverage by unit tests
-rule.common-java.InsufficientLineCoverage.param.minimumLineCoverageRatio=The minimum required line coverage ratio.
+++ /dev/null
-<p>
- A violation is created on a file as soon as there is a block of duplicated code on this file.
- It gives the number of blocks in the file.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A violation is created on a file as soon as the branch coverage on this file is less than the required threshold.
- It gives the number of lines to be covered in order to reach the required threshold.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A violation is created on a file as soon as the comment density coverage on this file is less than the required threshold.
- It gives the number of comment lines to be written in order to reach the required threshold.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>
- A violation is created on a file as soon as the line coverage on this file is less than the required threshold.
- It gives the number of lines to be covered in order to reach the required threshold.
-</p>
\ No newline at end of file
+++ /dev/null
-rule.pmd.StringInstantiation.name=String Instantiation
-rule.pmd.RemoteInterfaceNamingConvention.name=Remote Interface Naming Convention
-rule.pmd.InefficientEmptyStringCheck.name=Inefficient Empty String Check
-rule.pmd.DoubleCheckedLocking.name=Double checked locking
-rule.pmd.EmptyStaticInitializer.name=Empty Static Initializer
-rule.pmd.DoNotThrowExceptionInFinally.name=Strict Exception - Do not throw exception in finally
-rule.pmd.SignatureDeclareThrowsException.name=Signature Declare Throws Exception
-rule.pmd.UseEqualsToCompareStrings.name=Use Equals To Compare Strings
-rule.pmd.VariableNamingConventions.name=Naming - Variable naming conventions
-rule.pmd.VariableNamingConventions.param.memberSuffix=A suffix for member variables
-rule.pmd.VariableNamingConventions.param.memberPrefix=A prefix for member variables
-rule.pmd.VariableNamingConventions.param.staticSuffix=A suffix for static variables
-rule.pmd.VariableNamingConventions.param.staticPrefix=A prefix for static variables
-rule.pmd.PositionLiteralsFirstInComparisons.name=Position Literals First In Comparisons
-rule.pmd.ConfusingTernary.name=Confusing Ternary
-rule.pmd.ShortMethodName.name=Naming - Short method name
-rule.pmd.UncommentedEmptyConstructor.name=Uncommented Empty Constructor
-rule.pmd.UncommentedEmptyConstructor.param.ignoreExplicitConstructorInvocation=Ignore explicit constructor invocation when deciding whether constructor is empty or not. Default is false.
-rule.pmd.UnusedFormalParameter.name=Unused formal parameter
-rule.pmd.ExcessiveParameterList.name=Excessive Parameter List
-rule.pmd.ExcessiveParameterList.param.minimum=The parameter count reporting threshold. Default is 10.
-rule.pmd.OnlyOneReturn.name=Only One Return
-rule.pmd.UseStringBufferForStringAppends.name=Use String Buffer For String Appends
-rule.pmd.BooleanInversion.name=Boolean Inversion
-rule.pmd.AvoidDollarSigns.name=Naming - Avoid dollar signs
-rule.pmd.AvoidUsingShortType.name=Avoid Using Short Type
-rule.pmd.NonCaseLabelInSwitchStatement.name=Non Case Label In Switch Statement
-rule.pmd.CyclomaticComplexity.name=Code size - cyclomatic complexity
-rule.pmd.CyclomaticComplexity.param.showMethodsComplexity=Indicate if method average violation should be added to the report. Default is true.
-rule.pmd.CyclomaticComplexity.param.showClassesComplexity=Indicate if class average violation should be added to the report. Default is true.
-rule.pmd.CyclomaticComplexity.param.reportLevel=The Cyclomatic Complexity reporting threshold. Default is 10.
-rule.pmd.AvoidEnumAsIdentifier.name=Avoid Enum As Identifier
-rule.pmd.AvoidFieldNameMatchingMethodName.name=Naming - Avoid field name matching method name
-rule.pmd.InstantiationToGetClass.name=Instantiation To Get Class
-rule.pmd.SuspiciousHashcodeMethodName.name=Naming - Suspicious Hashcode method name
-rule.pmd.MDBAndSessionBeanNamingConvention.name=Message Driven Bean And Session Bean Naming Convention
-rule.pmd.UselessOperationOnImmutable.name=Useless Operation On Immutable
-rule.pmd.ReturnEmptyArrayRatherThanNull.name=Return empty array rather than null
-rule.pmd.LongInstantiation.name=Java5 migration - Long instantiation
-rule.pmd.ExcessiveImports.name=Coupling - excessive imports
-rule.pmd.ExcessiveImports.param.minimum=The import count reporting threshold. Default is 30.
-rule.pmd.StringBufferInstantiationWithChar.name=String Buffer Instantiation With Char
-rule.pmd.StringToString.name=String To String
-rule.pmd.MissingSerialVersionUID.name=Missing Serial Version UID
-rule.pmd.UnconditionalIfStatement.name=Unconditional If Statement
-rule.pmd.AvoidArrayLoops.name=Avoid Array Loops
-rule.pmd.ShortVariable.name=Short Variable
-rule.pmd.UnusedLocalVariable.name=Unused local variable
-rule.pmd.SuspiciousConstantFieldName.name=Naming - Suspicious constant field name
-rule.pmd.UseArrayListInsteadOfVector.name=Use Array List Instead Of Vector
-rule.pmd.CallSuperLast.name=Android - call super last
-rule.pmd.SimplifyBooleanExpressions.name=Avoid unnecessary comparisons in boolean expressions
-rule.pmd.FinalizeOnlyCallsSuperFinalize.name=Finalize Only Calls Super Finalize
-rule.pmd.ImmutableField.name=Immutable Field
-rule.pmd.BooleanInstantiation.name=Boolean Instantiation
-rule.pmd.StaticEJBFieldShouldBeFinal.name=Static EJB Field Should Be Final
-rule.pmd.AvoidFieldNameMatchingTypeName.name=Naming - Avoid field name matching type name
-rule.pmd.OverrideBothEqualsAndHashcode.name=Override both equals and hashcode
-rule.pmd.BrokenNullCheck.name=Broken Null Check
-rule.pmd.NPathComplexity.name=NPath complexity
-rule.pmd.NPathComplexity.param.minimum=The npath reporting threshold. Default is 200.
-rule.pmd.CouplingBetweenObjects.name=Coupling between objects
-rule.pmd.CouplingBetweenObjects.param.threshold=The unique type reporting threshold. Default is 20.
-rule.pmd.IntegerInstantiation.name=Integer Instantiation
-rule.pmd.DoNotCallGarbageCollectionExplicitly.name=Do not call garbage collection explicitly
-rule.pmd.BeanMembersShouldSerialize.name=Bean Members Should Serialize
-rule.pmd.BeanMembersShouldSerialize.param.prefix=A variable prefix to skip, i.e., m_
-rule.pmd.IdempotentOperations.name=Idempotent Operations
-rule.pmd.NcssTypeCount.name=Ncss Type Count
-rule.pmd.NcssTypeCount.param.minimum=The type NCSS count reporting threshold. Default is 1500.
-rule.pmd.AvoidThrowingRawExceptionTypes.name=Avoid Throwing Raw Exception Types
-rule.pmd.ImportFromSamePackage.name=Import From Same Package
-rule.pmd.UnnecessaryLocalBeforeReturn.name=Unnecessary Local Before Return
-rule.pmd.IfElseStmtsMustUseBraces.name=If Else Stmts Must Use Braces
-rule.pmd.ForLoopsMustUseBraces.name=For Loops Must Use Braces
-rule.pmd.UseIndexOfChar.name=Use Index Of Char
-rule.pmd.EmptyMethodInAbstractClassShouldBeAbstract.name=Empty Method In Abstract Class Should Be Abstract
-rule.pmd.LongVariable.name=Long Variable
-rule.pmd.LongVariable.param.minimum=The variable length reporting threshold. Default is 17.
-rule.pmd.MissingBreakInSwitch.name=Missing Break In Switch
-rule.pmd.UnnecessaryParentheses.name=Unnecessary parentheses
-rule.pmd.MisleadingVariableName.name=Naming - Misleading variable name
-rule.pmd.AbstractClassWithoutAnyMethod.name=Abstract class without any methods
-rule.pmd.DoNotCallSystemExit.name=Do Not Call System Exit
-rule.pmd.AvoidThrowingNullPointerException.name=Avoid Throwing Null Pointer Exception
-rule.pmd.EmptySynchronizedBlock.name=Empty Synchronized Block
-rule.pmd.SwitchStmtsShouldHaveDefault.name=Switch statements should have default
-rule.pmd.UseNotifyAllInsteadOfNotify.name=Use Notify All Instead Of Notify
-rule.pmd.UnusedPrivateMethod.name=Unused private method
-rule.pmd.MoreThanOneLogger.name=More Than One Logger
-rule.pmd.EmptyTryBlock.name=Empty Try Block
-rule.pmd.AvoidDeeplyNestedIfStmts.name=Avoid Deeply Nested If Stmts
-rule.pmd.AvoidDeeplyNestedIfStmts.param.problemDepth=The if statement depth reporting threshold. Default is 3.
-rule.pmd.LocalHomeNamingConvention.name=Local Home Naming Convention
-rule.pmd.AvoidUsingNativeCode.name=Avoid Using Native Code
-rule.pmd.LooseCoupling.name=Loose coupling
-rule.pmd.FinalizeOverloaded.name=Finalize Overloaded
-rule.pmd.AvoidThreadGroup.name=Avoid Thread Group
-rule.pmd.UnnecessaryConstructor.name=Unnecessary constructor
-rule.pmd.LocalVariableCouldBeFinal.name=Local variable could be final
-rule.pmd.MethodArgumentCouldBeFinal.name=Method Argument Could Be Final
-rule.pmd.AvoidAssertAsIdentifier.name=Avoid Assert As Identifier
-rule.pmd.SuspiciousOctalEscape.name=Suspicious Octal Escape
-rule.pmd.ByteInstantiation.name=Java5 migration - Byte instantiation
-rule.pmd.AvoidConstantsInterface.name=Avoid Constants Interface
-rule.pmd.LocalInterfaceSessionNamingConvention.name=Local Interface Session Naming Convention
-rule.pmd.CloneMethodMustImplementCloneable.name=Clone method must implement Cloneable
-rule.pmd.MethodWithSameNameAsEnclosingClass.name=Naming - Method with same name as enclosing class
-rule.pmd.ConsecutiveLiteralAppends.name=Consecutive Literal Appends
-rule.pmd.ConsecutiveLiteralAppends.param.threshold=The report threshold. Default is 1.
-rule.pmd.CallSuperInConstructor.name=Call Super In Constructor
-rule.pmd.SimplifyConditional.name=Simplify Conditional
-rule.pmd.InefficientStringBuffering.name=Inefficient String Buffering
-rule.pmd.EmptyStatementNotInLoop.name=Empty Statement Not In Loop
-rule.pmd.AvoidSynchronizedAtMethodLevel.name=Avoid Synchronized At Method Level
-rule.pmd.NcssMethodCount.name=Ncss Method Count
-rule.pmd.NcssMethodCount.param.minimum=The method NCSS count reporting threshold. Default is 100.
-rule.pmd.AbstractClassWithoutAbstractMethod.name=Abstract Class Without Abstract Method
-rule.pmd.AbstractNaming.name=Abstract naming
-rule.pmd.DoNotExtendJavaLangError.name=Do Not Extend Java Lang Error
-rule.pmd.NoPackage.name=No package
-rule.pmd.ExcessiveMethodLength.name=Excessive Method Length
-rule.pmd.ExcessiveMethodLength.param.minimum=The method size reporting threshold. Default is 100.
-rule.pmd.SwitchDensity.name=Switch Density
-rule.pmd.SwitchDensity.param.minimum=The switch statement ratio reporting threshold. Default is 10.
-rule.pmd.UseLocaleWithCaseConversions.name=Use Locale With Case Conversions
-rule.pmd.DuplicateImports.name=Duplicate Imports
-rule.pmd.ProperLogger.name=Proper Logger
-rule.pmd.ProperLogger.param.staticLoggerName=Default is LOG
-rule.pmd.PreserveStackTrace.name=Preserve Stack Trace
-rule.pmd.FinalizeDoesNotCallSuperFinalize.name=Finalize Does Not Call Super Finalize
-rule.pmd.DontImportSun.name=Dont Import Sun
-rule.pmd.ReplaceVectorWithList.name=Replace Vector With List
-rule.pmd.ClassNamingConventions.name=Naming - Class naming conventions
-rule.pmd.UncommentedEmptyMethod.name=Uncommented Empty Method
-rule.pmd.AvoidAccessibilityAlteration.name=Avoid Accessibility Alteration
-rule.pmd.IfStmtsMustUseBraces.name=If Stmts Must Use Braces
-rule.pmd.AvoidReassigningParameters.name=Avoid Reassigning Parameters
-rule.pmd.OptimizableToArrayCall.name=Optimizable To Array Call
-rule.pmd.FinalizeShouldBeProtected.name=Finalize Should Be Protected
-rule.pmd.AddEmptyString.name=Add Empty String
-rule.pmd.EmptyFinallyBlock.name=Empty Finally Block
-rule.pmd.EqualsNull.name=Equals Null
-rule.pmd.SuspiciousEqualsMethodName.name=Naming - Suspicious equals method name
-rule.pmd.UnnecessaryWrapperObjectCreation.name=Unnecessary Wrapper Object Creation
-rule.pmd.AvoidStringBufferField.name=Avoid StringBuffer field
-rule.pmd.SimplifyBooleanReturns.name=Simplify boolean returns
-rule.pmd.DefaultLabelNotLastInSwitchStmt.name=Default label not last in switch statement
-rule.pmd.AvoidUsingOctalValues.name=Avoid Using Octal Values
-rule.pmd.AvoidCallingFinalize.name=Avoid Calling Finalize
-rule.pmd.ExcessiveClassLength.name=Excessive Class Length
-rule.pmd.ExcessiveClassLength.param.minimum=The class size reporting threshold. Default is 1000.
-rule.pmd.FinalFieldCouldBeStatic.name=Final Field Could Be Static
-rule.pmd.AvoidRethrowingException.name=Avoid Rethrowing Exception
-rule.pmd.AvoidUsingHardCodedIP.name=Avoid Using Hard Coded IP
-rule.pmd.AvoidUsingHardCodedIP.param.pattern=Regular Expression. Default is ^[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}$
-rule.pmd.ProtectLogD.name=Android - Protect LOGD
-rule.pmd.ProtectLogV.name=Android - Protect LOGV
-rule.pmd.MethodNamingConventions.name=Naming - Method naming conventions
-rule.pmd.NonStaticInitializer.name=Non Static Initializer
-rule.pmd.AvoidProtectedFieldInFinalClass.name=Avoid Protected Field In Final Class
-rule.pmd.CompareObjectsWithEquals.name=Compare Objects With Equals
-rule.pmd.SystemPrintln.name=System Println
-rule.pmd.XPathRule.name=XPath rule template
-rule.pmd.XPathRule.param.message=Message to display when a violation occurs.
-rule.pmd.XPathRule.param.xpath=XPath expressions.
-rule.pmd.DontImportJavaLang.name=Dont Import Java Lang
-rule.pmd.TooManyMethods.name=Too many methods
-rule.pmd.TooManyMethods.param.maxmethods=The method count reporting threshold. Default is 10.
-rule.pmd.CloneThrowsCloneNotSupportedException.name=Clone Throws Clone Not Supported Exception
-rule.pmd.EmptyCatchBlock.name=Empty Catch Block
-rule.pmd.EmptyCatchBlock.param.allowCommentedBlocks=Empty blocks containing comments will be skipped. Default is false.
-rule.pmd.CollapsibleIfStatements.name=Collapsible If Statements
-rule.pmd.ForLoopShouldBeWhileLoop.name=For Loop Should Be While Loop
-rule.pmd.UseCorrectExceptionLogging.name=Use Correct Exception Logging
-rule.pmd.ReplaceEnumerationWithIterator.name=Replace Enumeration With Iterator
-rule.pmd.EmptyWhileStmt.name=Empty While Stmt
-rule.pmd.ReplaceHashtableWithMap.name=Replace Hashtable With Map
-rule.pmd.AvoidMultipleUnaryOperators.name=Avoid Multiple Unary Operators
-rule.pmd.UselessOverridingMethod.name=Useless Overriding Method
-rule.pmd.UselessOverridingMethod.param.ignoreAnnotations=Ignore annotations. Default is false.
-rule.pmd.SimpleDateFormatNeedsLocale.name=Simple Date Format Needs Locale
-rule.pmd.UnnecessaryFinalModifier.name=Unnecessary Final Modifier
-rule.pmd.CallSuperFirst.name=Android - call super first
-rule.pmd.UseArraysAsList.name=Use Arrays As List
-rule.pmd.CloseResource.name=Close Resource
-rule.pmd.CloseResource.param.closeTargets=Methods which may close this resource. Default is 'close'.
-rule.pmd.CloseResource.param.types=Resources to check. Default value is 'Connection,Statement,ResultSet',
-rule.pmd.EmptySwitchStatements.name=Empty Switch Statements
-rule.pmd.AccessorClassGeneration.name=Accessor Class Generation
-rule.pmd.PackageCase.name=Package case
-rule.pmd.TooFewBranchesForASwitchStatement.name=Too few branches for a switch statement
-rule.pmd.TooFewBranchesForASwitchStatement.param.minimumNumberCaseForASwitch=Minimum number of branches for a switch. Default is 3.
-rule.pmd.TooManyStaticImports.name=Too Many Static Imports
-rule.pmd.TooManyStaticImports.param.maximumStaticImports=All static imports can be disallowed by setting this to 0. Default is 4.
-rule.pmd.EmptyIfStmt.name=Empty If Stmt
-rule.pmd.DataflowAnomalyAnalysis.name=Dataflow Anomaly Analysis
-rule.pmd.DataflowAnomalyAnalysis.param.maxviolations=The maximum number of violations per class. Default is 100.
-rule.pmd.DataflowAnomalyAnalysis.param.maxpaths=The maximum number of checked paths per method. A lower value will increase the performance of the rule but may decrease the number of found anomalies. Default is 1000.
-rule.pmd.NonThreadSafeSingleton.name=Non Thread Safe Singleton
-rule.pmd.NonThreadSafeSingleton.param.checkNonStaticFields=Do not set this to true and checkNonStaticMethods to false. Default is false.
-rule.pmd.NonThreadSafeSingleton.param.checkNonStaticMethods=Do not set this to false and checkNonStaticFields to true. Default is true.
-rule.pmd.WhileLoopsMustUseBraces.name=While Loops Must Use Braces
-rule.pmd.UnusedModifier.name=Unused Modifier
-rule.pmd.ClassCastExceptionWithToArray.name=Class Cast Exception With To Array
-rule.pmd.EmptyInitializer.name=Basic - Empty Initializer
-rule.pmd.DoNotUseThreads.name=Do Not Use Threads
-rule.pmd.InsufficientStringBufferDeclaration.name=Insufficient String Buffer Declaration
-rule.pmd.AvoidUsingVolatile.name=Avoid Using Volatile
-rule.pmd.UseStringBufferLength.name=Use String Buffer Length
-rule.pmd.AvoidInstantiatingObjectsInLoops.name=Avoid instantiating objects in loops
-rule.pmd.UnsynchronizedStaticDateFormatter.name=Unsynchronized Static Date Formatter
-rule.pmd.MissingStaticMethodInNonInstantiatableClass.name=Missing Static Method In Non Instantiatable Class
-rule.pmd.EmptyFinalizer.name=Empty Finalizer
-rule.pmd.ShortInstantiation.name=Java5 migration - Short instantiation
-rule.pmd.ConstructorCallsOverridableMethod.name=Constructor Calls Overridable Method
-rule.pmd.DefaultPackage.name=Default Package
-rule.pmd.NcssConstructorCount.name=Ncss Constructor Count
-rule.pmd.NcssConstructorCount.param.minimum=The constructor NCSS count reporting threshold. Default is 100.
-rule.pmd.AvoidCatchingThrowable.name=Avoid Catching Throwable
-rule.pmd.AvoidDecimalLiteralsInBigDecimalConstructor.name=Avoid Decimal Literals In Big Decimal Constructor
-rule.pmd.AvoidDuplicateLiterals.name=Avoid Duplicate Literals
-rule.pmd.AvoidDuplicateLiterals.param.separator=Separator used in the exceptionlist. Default is ,
-rule.pmd.AvoidDuplicateLiterals.param.skipAnnotations=Skip literals within Annotations. Default is false.
-rule.pmd.AvoidDuplicateLiterals.param.exceptionfile=File containing strings to skip (one string per line), only used if exceptionlist is not set.
-rule.pmd.AvoidDuplicateLiterals.param.threshold=The number of duplicate literals reporting threshold. Default is 4.
-rule.pmd.AvoidDuplicateLiterals.param.exceptionlist=Strings in that list are skipped.
-rule.pmd.ExcessivePublicCount.name=Excessive Public Count
-rule.pmd.ExcessivePublicCount.param.minimum=The public item reporting threshold. Default is 45.
-rule.pmd.ClassWithOnlyPrivateConstructorsShouldBeFinal.name=Class with only private constructors should be final
-rule.pmd.NullAssignment.name=Null Assignment
-rule.pmd.MisplacedNullCheck.name=Misplaced Null Check
-rule.pmd.SingularField.name=Singular Field
-rule.pmd.UnusedImports.name=Unused imports
-rule.pmd.UselessStringValueOf.name=Useless String Value Of
-rule.pmd.UnusedNullCheckInEquals.name=Unused Null Check In Equals
-rule.pmd.AvoidCatchingNPE.name=Avoid Catching NPE
-rule.pmd.DontNestJsfInJstlIteration.name=Dont Nest Jsf In Jstl Iteration
-rule.pmd.CheckResultSet.name=Check ResultSet
-rule.pmd.ReturnFromFinallyBlock.name=Return From Finally Block
-rule.pmd.UseProperClassLoader.name=Use Proper Class Loader
-rule.pmd.UseSingleton.name=Use Singleton
-rule.pmd.ProperCloneImplementation.name=Proper clone implementation
-rule.pmd.UseCollectionIsEmpty.name=Use Collection Is Empty
-rule.pmd.AvoidThrowingNewInstanceOfSameException.name=Strict Exception - Avoid throwing new instance of same exception
-rule.pmd.SimplifyStartsWith.name=Simplify Starts With
-rule.pmd.AvoidFinalLocalVariable.name=Avoid Final Local Variable
-rule.pmd.TooManyFields.name=Too Many Fields
-rule.pmd.TooManyFields.param.maxfields=The field count reporting threshold. Default is 15.
-rule.pmd.MethodReturnsInternalArray.name=Security - Method returns internal array
-rule.pmd.AvoidInstanceofChecksInCatchClause.name=Avoid Instanceof Checks In Catch Clause
-rule.pmd.LoggerIsNotStaticFinal.name=Logger Is Not Static Final
-rule.pmd.BigIntegerInstantiation.name=Big Integer Instantiation
-rule.pmd.AssignmentInOperand.name=Assignment In Operand
-rule.pmd.BadComparison.name=Bad Comparison
-rule.pmd.UnnecessaryReturn.name=Unnecessary Return
-rule.pmd.AssignmentToNonFinalStatic.name=Assignment To Non Final Static
-rule.pmd.UnnecessaryConversionTemporary.name=Unnecessary Conversion Temporary
-rule.pmd.JumbledIncrementer.name=Jumbled Incrementer
-rule.pmd.BooleanGetMethodName.name=Boolean Get Method Name
-rule.pmd.BooleanGetMethodName.param.checkParameterizedMethods=Check parameterized methods. Default is false.
-rule.pmd.AvoidPrintStackTrace.name=Avoid Print Stack Trace
-rule.pmd.RemoteSessionInterfaceNamingConvention.name=Remote Session Interface Naming Convention
-rule.pmd.UnnecessaryCaseChange.name=Unnecessary Case Change
-rule.pmd.ArrayIsStoredDirectly.name=Security - Array is stored directly
-rule.pmd.ExceptionAsFlowControl.name=Exception As Flow Control
-rule.pmd.UnusedPrivateField.name=Unused Private Field
-rule.pmd.AtLeastOneConstructor.name=At Least One Constructor
-rule.pmd.AppendCharacterWithChar.name=Append Character With Char
-rule.pmd.GenericsNaming.name=Generics Naming
-rule.pmd.AvoidCatchingGenericException.name=Avoid Catching Generic Exception
-rule.pmd.AvoidLosingExceptionInformation.name=Avoid Losing Exception Information
-rule.pmd.AvoidLiteralsInIfCondition.name=Avoid Literals In If Condition
-rule.pmd.UseConcurrentHashMap.name=Use ConcurrentHashMap
-rule.pmd.DoNotHardCodeSDCard.name=Android - Do Not Hard Code SD Card
-rule.pmd.DontCallThreadRun.name=Dont Call Thread Run
-rule.pmd.GuardDebugLogging.name=Guard Debug Logging
-rule.pmd-unit-tests.JUnitStaticSuite.name=JUnit static suite
-rule.pmd-unit-tests.JUnitSpelling.name= JUnit spelling
-rule.pmd-unit-tests.JUnitAssertionsShouldIncludeMessage.name=JUnit assertions should include a message
-rule.pmd-unit-tests.JUnitTestsShouldIncludeAssert.name=JUnit tests should include an assert
-rule.pmd-unit-tests.TestClassWithoutTestCases.name=Test class without test cases (JUnit 3.x only)
-rule.pmd-unit-tests.UnnecessaryBooleanAssertion.name=Unnecessary boolean assertion
-rule.pmd-unit-tests.UseAssertEqualsInsteadOfAssertTrue.name=Use assertEquals instead of assertTrue
-rule.pmd-unit-tests.UseAssertSameInsteadOfAssertTrue.name=Use assertSame instead of assertTrue
-rule.pmd-unit-tests.UseAssertNullInsteadOfAssertTrue.name=Use assertNull instead of assertTrue
-rule.pmd-unit-tests.SimplifyBooleanAssertion.name=Simplify boolean assertion
+++ /dev/null
-JUnit assertions should include a message - i.e., use the three argument version of assertEquals(), not the two argument version.
-<pre>
-public class Foo extends TestCase {
- public void testSomething() {
- assertEquals("foo", "bar"); // violation, should be assertEquals("Foo does not equals bar", "foo", "bar");
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Some JUnit framework methods are easy to misspell.
-<pre>
-import junit.framework.*;
-
-public class Foo extends TestCase {
- public void setup() {} // violation, should be setUp()
- public void TearDown() {} // violation, should be tearDown()
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-The suite() method in a JUnit test needs to be both public and static.
-<pre>
-import junit.framework.*;
-
-public class Foo extends TestCase {
- public void suite() {} // violation, should be static
- private static void suite() {} // violation, should be public
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-JUnit tests should include at least one assertion. This makes the tests more robust, and using assert with messages provide the developer a clearer idea of what the test does.
-<pre>
-public class Foo extends TestCase {
- public void testSomething() {
- Bar b = findBar();
- b.work();
- // violation, we could use assertNotNull("bar not found", b);
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Avoid negation in an assertTrue or assertFalse test. For example, rephrase: assertTrue(!expr); as: assertFalse(expr);
-<pre>
-public class SimpleTest extends TestCase {
- public void testX() {
- assertTrue("not empty", !r.isEmpty()); // violation, replace with assertFalse("not empty", r.isEmpty())
- assertFalse(!r.isEmpty()); // violation, replace with assertTrue("empty", r.isEmpty())
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Test classes end with the suffix Test. Having a non-test class with that name is not a good practice, since most people will assume it is a test case. Test classes have test methods named testXXX.
-Beware: This rule doesn't support JUnit 4.x's @Test annotation.
-<pre>
-public class CarTest { // violation, consider changing the name of the class if it is not a test
- // consider adding test methods if it is a test
- public static void main(String[] args) {
- // do something
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-A JUnit test assertion with a boolean literal is unnecessary since it always will eval to the same thing. Consider using flow control (in case of assertTrue(false) or similar) or simply removing statements like assertTrue(true) and assertFalse(false). If you just want a test to halt, use the fail method.
-<pre>
-public class SimpleTest extends TestCase {
- public void testX() {
- assertTrue(true); // violation
- }
-}</pre>
\ No newline at end of file
+++ /dev/null
-This rule detects JUnit assertions in object equality. These assertions should be made by more specific methods, like assertEquals.
-<pre>
-public class FooTest extends TestCase {
- void testCode() {
- Object a, b;
-
- assertTrue(a.equals(b)); // violation
- assertEquals("a should equals b", a, b); // good usage
- }
-}</pre>
\ No newline at end of file
+++ /dev/null
-This rule detects JUnit assertions in object references equality. These assertions should be made by more specific methods, like assertNull, assertNotNull.
-<pre>
-public class FooTest extends TestCase {
- void testCode() {
- Object a = doSomething();
-
- assertTrue(a==null); // violation
- assertNull(a); // good usage
- assertTrue(a != null); // violation
- assertNotNull(a); // good usage
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-This rule detects JUnit assertions in object references equality. These assertions should be made by more specific methods, like assertSame, assertNotSame.
-<pre>
-public class FooTest extends TestCase {
- void testCode() {
- Object a, b;
-
- assertTrue(a==b); // violation
- assertSame(a, b); // good usage
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-The abstract class does not contain any abstract methods. An abstract class suggests an incomplete implementation, which is to be completed by subclasses implementing the abstract methods. If the class is intended to be used as a base class only (not to be instantiated direcly) a protected constructor can be provided prevent direct instantiation.
\ No newline at end of file
+++ /dev/null
-If the abstract class does not provides any methods, it may be just a data container that is not to be instantiated. In this case, it's probably better to use a private or a protected constructor in order to prevent instantiation than make the class misleadingly abstract. Example :
-<pre>
-public class abstract Example {
- String field;
- int otherField;
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Abstract classes should be named 'AbstractXXX'. Example :
- <pre>
-public abstract class Foo { // should be AbstractFoo
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-Instantiation by way of private constructors from outside of the constructor's class often causes the generation of an accessor. A factory method, or non-privitization of the constructor can eliminate this situation. The generated class file is actually an interface. It gives the accessing class the ability to invoke a new hidden package scope constructor that takes the interface as a supplementary parameter. This turns a private constructor effectively into one with package scope, and is challenging to discern.
\ No newline at end of file
+++ /dev/null
-Finds empty string literals which are being added. This is an inefficient way to convert any type to a String.
\ No newline at end of file
+++ /dev/null
-Avoid concatenating characters as strings in StringBuffer.append.
\ No newline at end of file
+++ /dev/null
-Constructors and methods receiving arrays should clone objects and store the copy. This prevents that future changes from the user affect the internal functionality.
\ No newline at end of file
+++ /dev/null
-Avoid assignments in operands; this can make code more complicated and harder to read.
\ No newline at end of file
+++ /dev/null
-Identifies a possible unsafe usage of a static field.
\ No newline at end of file
+++ /dev/null
-Each class should declare at least one constructor.
\ No newline at end of file
+++ /dev/null
-Methods such as getDeclaredConstructors(), getDeclaredConstructor(Class[]) and setAccessible(), as the interface PrivilegedAction, allow to alter, at runtime, the visilibilty of variable, classes, or methods, even if they are private. Obviously, no one should do so, as such behavior is against everything encapsulation principal stands for.
\ No newline at end of file
+++ /dev/null
-Instead of copying data between two arrays, use System.arrayCopy method
\ No newline at end of file
+++ /dev/null
-Finds all places 'assert' is used as an identifier is used.
\ No newline at end of file
+++ /dev/null
-Object.finalize() is called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
\ No newline at end of file
+++ /dev/null
-Avoid catching generic exceptions such as NullPointerException, RuntimeException, Exception in try-catch block.
+++ /dev/null
-Code should never throw NPE under normal circumstances. A catch block may hide the original error, causing other more subtle errors in its wake.
\ No newline at end of file
+++ /dev/null
-This is dangerous because it casts too wide a net; it can catch things like OutOfMemoryError.
\ No newline at end of file
+++ /dev/null
-An interface should be used only to model a behaviour of a class: using an interface as a container of constants is a poor usage pattern.
\ No newline at end of file
+++ /dev/null
-One might assume that new BigDecimal(.1) is exactly equal to .1, but it is actually equal to .1000000000000000055511151231257827021181583404541015625. This is so because .1 cannot be represented exactly as a double (or, for that matter, as a binary fraction of any finite length). Thus, the long value that is being passed in to the constructor is not exactly equal to .1, appearances notwithstanding. The (String) constructor, on the other hand, is perfectly predictable: 'new BigDecimal(.1)' is exactly equal to .1, as one would expect. Therefore, it is generally recommended that the (String) constructor be used in preference to this one.
\ No newline at end of file
+++ /dev/null
-Deeply nested if..then statements are hard to read.
\ No newline at end of file
+++ /dev/null
-Avoid using dollar signs in variable/method/class/interface names.
\ No newline at end of file
+++ /dev/null
-Code containing duplicate String literals can usually be improved by declaring the String as a constant field. Example :
-<pre>
-public class Foo {
- private void bar() {
- buz("Howdy");
- buz("Howdy");
- buz("Howdy");
- buz("Howdy");
- }
- private void buz(String x) {}
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Finds all places 'enum' is used as an identifier is used.
\ No newline at end of file
+++ /dev/null
-It is somewhat confusing to have a field name with the same name as a method. While this is totally legal, having information (field) and actions (method) is not clear naming. Example :
-<pre>
-public class Foo {
- Object bar;
- // bar is data or an action or both?
- void bar() {
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-It is somewhat confusing to have a field name matching the declaring class name. This probably means that type and or field names could be more precise. Example :
-<pre>
-public class Foo extends Bar {
- // There's probably a better name for foo
- int foo;
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Avoid using final local variables, turn them into fields. Example :
-<pre>
-public class MyClass {
- public void foo() {
- final String finalLocalVariable;
- }
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-Each caught exception type should be handled in its own catch clause.
\ No newline at end of file
+++ /dev/null
-Detects when a new object is created inside a loop
\ No newline at end of file
+++ /dev/null
-Avoid using hard coded literals in conditional statements, declare those as static variables or private members.
+++ /dev/null
-Statements in a catch block that invoke accessors on the exception without using the information only add to code size. Either remove the invocation, or use the return result.
+++ /dev/null
-Using multiple unary operators may be a bug, and/or is confusing. Check the usage is not a bug, or consider simplifying the expression. Example :
-<pre>
-// These are typo bugs, or at best needlessly complex and confusing:
-int i = - -1;
-int j = + - +1;
-int z = ~~2;
-boolean b = !!true;
-boolean c = !!!true;
-
-// These are better:
-int i = 1;
-int j = -1;
-int z = 2;
-boolean b = true;
-boolean c = false;
-
-// And these just make your brain hurt:
-int i = ~-2;
-int j = -~7;
-</pre>
\ No newline at end of file
+++ /dev/null
-Avoid printStackTrace(); use a logger call instead.
\ No newline at end of file
+++ /dev/null
-Do not use protected fields in final classes since they cannot be subclassed. Clarify your intent by using private or package access modifiers instead.
\ No newline at end of file
+++ /dev/null
-Reassigning values to parameters is a questionable practice. Use a temporary local variable instead.
\ No newline at end of file
+++ /dev/null
-Catch blocks that merely rethrow a caught exception only add to code size and runtime complexity.
\ No newline at end of file
+++ /dev/null
-StringBuffers can grow quite a lot, and so may become a source of memory leak (if the owning class has a long life time). Example :
-<pre>
-class Foo {
- private StringBuffer memoryLeak;
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Method level synchronization can backfire when new code is added to the method. Block-level synchronization helps to ensure that only the code that needs synchronization gets it.
\ No newline at end of file
+++ /dev/null
-Avoid using ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread safe.
\ No newline at end of file
+++ /dev/null
-Catch blocks that merely rethrow a caught exception wrapped inside a new instance of the same type only add to code size and runtime complexity. Example :
-<pre>
-public class Foo {
- void bar() {
- try {
- // do something
- } catch (SomeException se) {
- // harmless comment
- throw new SomeException(se);
- }
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Avoid throwing a NullPointerException - it's confusing because most people will assume that the virtual machine threw it. Consider using an IllegalArgumentException instead; this will be clearly seen as a programmer-initiated exception.
\ No newline at end of file
+++ /dev/null
-Avoid throwing certain exception types. Rather than throw a raw RuntimeException, Throwable, Exception, or Error, use a subclassed exception or error instead.
\ No newline at end of file
+++ /dev/null
-An application with hard coded IP may become impossible to deploy in some case. It never hurts to externalize IP adresses.
\ No newline at end of file
+++ /dev/null
-As JVM and Java language offer already many help in creating application, it should be very rare to have to rely on non-java code. Even though, it is rare to actually have to use Java Native Interface (JNI). As the use of JNI make application less portable, and harder to maintain, it is not recommended.
\ No newline at end of file
+++ /dev/null
-Integer literals should not start with zero. Zero means that the rest of literal will be interpreted as an octal value.
\ No newline at end of file
+++ /dev/null
-Java uses the short type to reduce memory usage, not to optimize calculation. On the contrary, the jvm does not has an arithmetic capabilities with the type short. So, the P-code must convert the short into int, then do the proper caculation and then again, convert int to short. So, use of the "short" type may have a great effect on memory usage.
\ No newline at end of file
+++ /dev/null
-Use of the keyword "volatile" is general used to fine tune a Java application, and therefore, requires a good expertise of the Java Memory Model. Morover, its range of action is somewhat misknown. Therefore, the volatile keyword should not be used for maintenance purpose and portability.
\ No newline at end of file
+++ /dev/null
-Avoid equality comparisons with Double.NaN - these are likely to be logic errors.
\ No newline at end of file
+++ /dev/null
-If a class is a bean, or is referenced by a bean directly or indirectly it needs to be serializable. Member variables need to be marked as transient, static, or have accessor methods in the class. Marking variables as transient is the safest and easiest modification. Accessor methods should follow the Java naming conventions, i.e.if you have a variable foo, you should provide getFoo and setFoo methods.
\ No newline at end of file
+++ /dev/null
-Don't create instances of already existing BigInteger (BigInteger.ZERO, BigInteger.ONE) and for 1.5 on, BigInteger.TEN and BigDecimal (BigDecimal.ZERO, BigDecimal.ONE, BigDecimal.TEN)
\ No newline at end of file
+++ /dev/null
-Looks for methods named "getX()" with "boolean" as the return type. The convention is to name these methods "isX()".
\ No newline at end of file
+++ /dev/null
-Avoid instantiating Boolean objects; you can reference Boolean.TRUE, Boolean.FALSE, or call Boolean.valueOf() instead.
\ No newline at end of file
+++ /dev/null
-Use bitwise inversion to invert boolean values - it's the fastest way to do this. See http://www.javaspecialists.co.za/archive/newsletter.do?issue=042&locale=en_US for specific details
\ No newline at end of file
+++ /dev/null
-The null check is broken since it will throw a Nullpointer itself. The reason is that a method is called on the object when it is null. It is likely that you used || instead of && or vice versa.
\ No newline at end of file
+++ /dev/null
-In JDK 1.5, calling new Byte() causes memory allocation. Byte.valueOf() is more memory friendly. Example :
-<pre>
-public class Foo {
-private Byte i = new Byte(0); // change to Byte i =
-Byte.valueOf(0);
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Super should be called at the start of the method. Example :
-<pre>
-public class DummyActivity extends Activity {
- public void onCreate(Bundle bundle) {
- // missing call to super.onCreate(bundle)
- foo();
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-It is a good practice to call super() in a constructor. If super() is not called but another constructor (such as an overloaded constructor) is called, this rule will not report it.
\ No newline at end of file
+++ /dev/null
-Super should be called at the end of the method. Example :
-<pre>
-public class DummyActivity extends Activity {
- public void onPause() {
- foo();
- // missing call to super.onPause()
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Always check the return of one of the navigation method (next,previous,first,last) of a ResultSet. Indeed, if the value return is "false", the developer should deal with it !
\ No newline at end of file
+++ /dev/null
-if you need to get an array of a class from your Collection, you should pass an array of the desidered class as the parameter of the toArray method. Otherwise you will get a ClassCastException.
\ No newline at end of file
+++ /dev/null
-Class names should always begin with an upper case character.
\ No newline at end of file
+++ /dev/null
-A class with only private constructors should be final, unless the private constructor is called by a inner class. Example :
- <pre>
-public class Foo { //Should be final
- private Foo() { }
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-The method clone() should only be implemented if the class implements the Cloneable interface with the exception of a final method that only throws CloneNotSupportedException. This version uses PMD's type resolution facilities, and can detect if the class implements or extends a Cloneable class
\ No newline at end of file
+++ /dev/null
-The method clone() should throw a CloneNotSupportedException.
\ No newline at end of file
+++ /dev/null
-Ensure that resources (like Connection, Statement, and ResultSet objects) are always closed after use. It does this by looking for code patterned like :
-<pre>
-Connection c = openConnection();
-try {
- // do stuff, and maybe catch something
-} finally {
- c.close();
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Sometimes two 'if' statements can be consolidated by separating their conditions with a boolean short-circuit operator.
\ No newline at end of file
+++ /dev/null
-Use equals() to compare object references; avoid comparing them with ==.
\ No newline at end of file
+++ /dev/null
-In an if expression with an else clause, avoid negation in the test. For example, rephrase: if (x != y) diff(); else same(); as: if (x == y) same(); else diff(); Most if (x != y) cases without an else are often return cases, so consistent use of this rule makes the code easier to read. Also, this resolves trivial ordering problems, such as does the error case go first? or does the common case go first?.
\ No newline at end of file
+++ /dev/null
-Consecutively calling StringBuffer.append with String literals
\ No newline at end of file
+++ /dev/null
-Calling overridable methods during construction poses a risk of invoking methods on an incompletely constructed object
- and can be difficult to discern. It may leave the sub-class unable to construct its superclass or forced to replicate
- the construction process completely within itself, losing the ability to call super().
- If the default constructor contains a call to an overridable method, the subclass may be completely uninstantiable.
- Note that this includes method calls throughout the control flow graph - i.e., if a constructor Foo() calls
- a private method bar() that calls a public method buz(), this denotes a problem.
- <br/>Example :
-<pre>
-public class SeniorClass {
- public SeniorClass(){
- toString(); //may throw NullPointerException if overridden
- }
- public String toString(){
- return "IAmSeniorClass";
- }
-}
-public class JuniorClass extends SeniorClass {
- private String name;
- public JuniorClass(){
- super(); //Automatic call leads to NullPointerException
- name = "JuniorClass";
- }
- public String toString(){
- return name.toUpperCase();
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-This rule counts unique attributes, local variables and return types within an object. A number higher than specified threshold can indicate a high degree of coupling.
\ No newline at end of file
+++ /dev/null
-Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.
\ No newline at end of file
+++ /dev/null
-The dataflow analysis tracks local definitions, undefinitions and references to variables on different paths on the data flow. From those informations there can be found various problems. 1. UR - Anomaly: There is a reference to a variable that was not defined before. This is a bug and leads to an error. 2. DU - Anomaly: A recently defined variable is undefined. These anomalies may appear in normal source text. 3. DD - Anomaly: A recently defined variable is redefined. This is ominous but don't have to be a bug.
\ No newline at end of file
+++ /dev/null
-Switch statements should have a default label. Example :
- <pre>
-public class Foo {
- void bar(int a) {
- switch (a) {
- case 1: // do something
- break;
- default: // the default case should be last, by convention
- break;
- case 2:
- break;
- }
- }
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-Use explicit scoping instead of the default package private level.
\ No newline at end of file
+++ /dev/null
-Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover, "modern" jvms do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks develop within an application, it should be dealt with JVM options rather than within the code itself. Example :
-<pre>
- public class GCCall
-{
- public GCCall()
- {
- // Explicit gc call !
- System.gc();
- }
- public void doSomething()
- {
- // Explicit gc call !
- Runtime.getRuntime().gc();
- }
-
- public explicitGCcall() { // Explicit gc call ! System.gc(); }
-
- public void doSomething() { // Explicit gc call ! Runtime.getRuntime().gc(); }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Web applications should not call System.exit(), since only the web container or the application server should stop the JVM.
\ No newline at end of file
+++ /dev/null
-Errors are system exceptions. Do not extend them.
\ No newline at end of file
+++ /dev/null
-Use Environment.getExternalStorageDirectory() instead of "/sdcard".
+++ /dev/null
-Throwing exception in a finally block is confusing. It may mask exception or a defect of the code, it also render code cleanup uninstable. Example :
-<pre>
-public class Foo
-{
- public void bar()
- {
- try {
- // Here do some stuff
- }
- catch( Exception e) {
- // Handling the issue
- }
- finally
- {
- // is this really a good idea ?
- throw new Exception();
- }
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-The J2EE specification explicitly forbid use of threads.
\ No newline at end of file
+++ /dev/null
-Explicitly calling Thread.run() method will execute in the caller's thread of control. Instead, call Thread.start() for the intended behavior.
+++ /dev/null
-Avoid importing anything from the package 'java.lang'. These classes are automatically imported (JLS 7.5.3).
\ No newline at end of file
+++ /dev/null
-Avoid importing anything from the 'sun.*' packages. These packages are not portable and are likely to change.
\ No newline at end of file
+++ /dev/null
-Do not nest JSF component custom actions inside a custom action that iterates over its body.
\ No newline at end of file
+++ /dev/null
-Partially created objects can be returned by the Double Checked Locking pattern when used in Java. An optimizing JRE may assign a reference to the baz variable before it creates the object the reference is intended to point to. <a href="http://www.javaworld.com/javaworld/jw-02-2001/jw-0209-double.html">More details</a>. Example :
-<pre>
-public class Foo {
- Object baz;
- Object bar() {
- if(baz == null) { //baz may be non-null yet not fully created
- synchronized(this){
- if(baz == null){
- baz = new Object();
- }
- }
- }
- return baz;
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Avoid duplicate import statements.
\ No newline at end of file
+++ /dev/null
-Empty Catch Block finds instances where an exception is caught, but nothing is done. In most circumstances, this swallows an exception which should either be acted on or reported.
\ No newline at end of file
+++ /dev/null
-If the finalize() method is empty, then it does not need to exist.
\ No newline at end of file
+++ /dev/null
-Avoid empty finally blocks - these can be deleted.
\ No newline at end of file
+++ /dev/null
-Empty If Statement finds instances where a condition is checked but nothing is done about it.
\ No newline at end of file
+++ /dev/null
-An empty initializer was found. Example :
-<pre>
-public class Foo {
-
- static {} // Why ?
-
- {} // Again, why ?
-
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-An empty method in an abstract class should be abstract instead, as developer may rely on this empty implementation rather than code the appropriate one.
- <pre>
-public abstract class ShouldBeAbstract
-{
- public Object couldBeAbstract()
- {
- // Should be abstract method ?
- return null;
- }
-
- public void couldBeAbstract()
- {
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-An empty statement (aka a semicolon by itself) that is not used as the sole body of a for loop or while loop is probably a bug. It could also be a double semicolon, which is useless and should be removed.
\ No newline at end of file
+++ /dev/null
-An empty static initializer was found.
\ No newline at end of file
+++ /dev/null
-Avoid empty switch statements.
\ No newline at end of file
+++ /dev/null
-Avoid empty synchronized blocks - they're useless.
\ No newline at end of file
+++ /dev/null
-Avoid empty try blocks - what's the point?
\ No newline at end of file
+++ /dev/null
-Empty While Statement finds all instances where a while statement does nothing. If it is a timing loop, then you should use Thread.sleep() for it; if it's a while loop that does a lot in the exit expression, rewrite it to make it clearer.
\ No newline at end of file
+++ /dev/null
-Inexperienced programmers sometimes confuse comparison concepts and use equals() to compare to null.
\ No newline at end of file
+++ /dev/null
-Using Exceptions as flow control leads to GOTOish code and obscures true exceptions when debugging.
\ No newline at end of file
+++ /dev/null
-Long Class files are indications that the class may be trying to do too much. Try to break it down, and reduce the size to something manageable.
\ No newline at end of file
+++ /dev/null
-A high number of imports can indicate a high degree of coupling within an object. Rule counts the number of unique imports and reports a violation if the count is above the user defined threshold.
\ No newline at end of file
+++ /dev/null
-Violations of this rule usually indicate that the method is doing too much. Try to reduce the method size by creating helper methods and removing any copy/pasted code.
\ No newline at end of file
+++ /dev/null
-Long parameter lists can indicate that a new object should be created to wrap the numerous parameters. Basically, try to group the parameters together.
\ No newline at end of file
+++ /dev/null
-A large number of public methods and attributes declared in a class can indicate the class may need to be broken up as increased effort will be required to thoroughly test it.
\ No newline at end of file
+++ /dev/null
-If a final field is assigned to a compile-time constant, it could be made static, thus saving overhead in each object at runtime.
\ No newline at end of file
+++ /dev/null
-If the finalize() is implemented, its last action should be to call super.finalize.
\ No newline at end of file
+++ /dev/null
-If the finalize() is implemented, it should do something besides just calling super.finalize().
\ No newline at end of file
+++ /dev/null
-Methods named finalize() should not have parameters. It is confusing and probably a bug to overload finalize(). It will not be called by the VM.
\ No newline at end of file
+++ /dev/null
-If you override finalize(), make it protected. If you make it public, other classes may call it.
\ No newline at end of file
+++ /dev/null
-Some for loops can be simplified to while loops - this makes them more concise.
\ No newline at end of file
+++ /dev/null
-Avoid using 'for' statements without using curly braces, like <code>for (int i=0; i<42;i++) foo();</code>
\ No newline at end of file
+++ /dev/null
-Generics names should be a one letter long and upper case.
+++ /dev/null
-When log messages are composed by concatenating strings, the whole section should be guarded by a isDebugEnabled() check to avoid performance and memory issues.
+++ /dev/null
-Avoid idempotent operations - they are have no effect. Example : <br/><code>int x = 2;<br/> x = x;</code>
\ No newline at end of file
+++ /dev/null
-Avoid using if..else statements without using curly braces.
\ No newline at end of file
+++ /dev/null
-Avoid using if statements without using curly braces.
\ No newline at end of file
+++ /dev/null
-Identifies private fields whose values never change once they are initialized either in the declaration of the field or by a constructor. This aids in converting existing classes to immutable classes.
\ No newline at end of file
+++ /dev/null
-No need to import a type that lives in the same package.
\ No newline at end of file
+++ /dev/null
-String.trim().length() is an inefficient way to check if a String is really empty, as it creates a new String object just to check its size. Consider creating a static function that loops through a string, checking Character.isWhitespace() on each character and returning false if a non-whitespace character is found.
\ No newline at end of file
+++ /dev/null
-Avoid concatenating non literals in a StringBuffer constructor or append().
\ No newline at end of file
+++ /dev/null
-Avoid instantiating an object just to call getClass() on it; use the .class public member instead. Example : replace <code>Class c = new String().getClass();</code> with <code>Class c = String.class;</code>
\ No newline at end of file
+++ /dev/null
-Failing to pre-size a StringBuffer properly could cause it to re-size many times during runtime. This rule checks the characters that are actually passed into StringBuffer.append(), but represents a best guess worst case scenario. An empty StringBuffer constructor initializes the object to 16 characters. This default is assumed if the length of the constructor can not be determined.
\ No newline at end of file
+++ /dev/null
-In JDK 1.5, calling new Integer() causes memory allocation. Integer.valueOf() is more memory friendly.
\ No newline at end of file
+++ /dev/null
-Avoid jumbled loop incrementers - it's usually a mistake, and it's confusing even if it's what's intended.
- <br>Example :
- <pre>
-public class JumbledIncrementerRule1 {
- public void foo() {
- for (int i = 0; i < 10; i++) {
- for (int k = 0; k < 20; i++) {
- System.out.println("Hello");
- }
- }
- }
-}</pre>
\ No newline at end of file
+++ /dev/null
-The Local Home interface of a Session EJB should be suffixed by "LocalHome".
\ No newline at end of file
+++ /dev/null
-The Local Interface of a Session EJB should be suffixed by "Local".
\ No newline at end of file
+++ /dev/null
-A local variable assigned only once can be declared final. Example :
- <pre>
-public class Bar {
- public void foo () {
- String a = "a"; //if a will not be assigned again it is better to do this:
- final String b = "b";
- }
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-In most cases, the Logger can be declared static and final.
\ No newline at end of file
+++ /dev/null
-In JDK 1.5, calling new Long() causes memory allocation. Long.valueOf() is more memory friendly. Example :
- <pre>
-public class Foo {
-private Long i = new Long(0); // change to Long i =
-Long.valueOf(0);
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-Detects when a field, formal or local variable is declared with a long name.
\ No newline at end of file
+++ /dev/null
-Avoid using implementation types (i.e., HashSet); use the interface (i.e, Set) instead
\ No newline at end of file
+++ /dev/null
-The EJB Specification state that any MessageDrivenBean or SessionBean should be suffixed by Bean.
\ No newline at end of file
+++ /dev/null
-A method argument that is never assigned can be declared final.
\ No newline at end of file
+++ /dev/null
-Method names should always begin with a lower case character, and should not contain underscores. Example :
-<pre>
-public class Foo {
- public void fooStuff() {
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Exposing internal arrays directly allows the user to modify some code that could be critical. It is safer to return a copy of the array.
\ No newline at end of file
+++ /dev/null
-Non-constructor methods should not have the same name as the enclosing class. Example :
-<pre>
-public class MyClass {
- // this is bad because it is a method
- public void MyClass() {}
- // this is OK because it is a constructor
- public MyClass() {}
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Detects when a non-field has a name starting with 'm_'. This usually indicates a field and thus is confusing. Example :
-<pre>
-public class Foo {
- private int m_foo; // OK
- public void bar(String m_baz) { // Bad
- int m_boz = 42; // Bad
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-The null check here is misplaced. if the variable is null you'll get a NullPointerException.
- Either the check is useless (the variable will never be null) or it's incorrect.
- <br>Example :
- <pre>
-if (object1!=null && object2.equals(object1)) {
- ...
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-A switch statement without an enclosed break statement may be a bug.
\ No newline at end of file
+++ /dev/null
-Classes that are serializable should provide a serialVersionUID field.
\ No newline at end of file
+++ /dev/null
-A class that has private constructors and does not have any static methods or fields cannot be used.
\ No newline at end of file
+++ /dev/null
-Normally only one logger is used in each class.
\ No newline at end of file
+++ /dev/null
-The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity. Example :
-<pre>
-public class Foo {
- void bar() {
- // lots of complicated code
- }
- }
-</pre>
\ No newline at end of file
+++ /dev/null
-This rule uses the NCSS (Non Commenting Source Statements) algorithm to determine the number of lines of code for a given constructor. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one.
\ No newline at end of file
+++ /dev/null
-This rule uses the NCSS (Non Commenting Source Statements) algorithm to determine the number of lines of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one.
\ No newline at end of file
+++ /dev/null
-This rule uses the NCSS (Non Commenting Source Statements) algorithm to determine the number of lines of code for a given type. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one.
\ No newline at end of file
+++ /dev/null
-Detects when a class or interface does not have a package definition. Example :
- <pre>
-// no package declaration
-public class ClassInDefaultPackage {
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-A non-case label (e.g. a named break/continue label) was present in a switch statement. This legal, but confusing. It is easy to mix up the case labels and the non-case labels.
\ No newline at end of file
+++ /dev/null
-A nonstatic initializer block will be called any time a constructor is invoked (just prior to invoking the constructor). While this is a valid language construct, it is rarely used and is confusing. Example :<br/><code>public class MyClass {<br/>// this block gets run before any call to a constructor {<br/>System.out.println("I am about to construct myself");<br/>}<br/>}</code>
\ No newline at end of file
+++ /dev/null
-Non-thread safe singletons can result in bad state changes. Eliminate static singletons if possible by instantiating the object directly. Static singletons are usually not needed as only a single instance exists anyway. Other possible fixes are to synchronize the entire method or to use an initialize-on-demand holder class (do not use the double-check idiom). See Effective Java, item 48.
\ No newline at end of file
+++ /dev/null
-Assigning a null to a variable (outside of its declaration) is usually bad form. Some times, the assignment is an indication that the programmer doesn't completely understand what is going on in the code. NOTE: This sort of assignment may in rare cases be useful to encourage garbage collection. If that's what you're using it for, by all means, disregard this rule :-)
\ No newline at end of file
+++ /dev/null
-A method should have only one exit point, and that should be the last statement in the method.
\ No newline at end of file
+++ /dev/null
-A call to Collection.toArray can use the Collection's size vs an empty Array of the desired type.
\ No newline at end of file
+++ /dev/null
-Override both public boolean Object.equals(Object other), and public int Object.hashCode(), or override neither. Even if you are inheriting a hashCode() from a parent class, consider implementing hashCode and explicitly delegating to your superclass. Example :
-<pre>
-// this is bad
-public class Bar {
- public boolean equals(Object o) {
- // do some comparison
- }
-}
-
-// and so is this
-public class Baz {
- public int hashCode() {
- // return some hash value
- }
-}
-
-// this is OK
-public class Foo {
- public boolean equals(Object other) {
- // do some comparison
- }
- public int hashCode() {
- // return some hash value
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Detects when a package definition contains upper case characters. Example :
-<pre>
-package com.MyCompany; // <- should be lower case name
-public class SomeClass {
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Position literals first in String comparisons - that way if the String is null you won't get a NullPointerException, it'll just return false.
\ No newline at end of file
+++ /dev/null
-Throwing a new exception from a catch block without passing the original exception into the new Exception will cause the true stack trace to be lost, and can make it difficult to debug effectively.
\ No newline at end of file
+++ /dev/null
-Object clone() should be implemented with super.clone(). Example :
- <pre>
-class Foo{
- public Object clone(){
- return new Foo(); // This is bad
- }
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-Logger should normally be defined private static final and have the correct class. Private final Log log; is also allowed for rare cases when loggers need to be passed around, but the logger needs to be passed into the constructor.
\ No newline at end of file
+++ /dev/null
-Log.d calls should be protected by checking Config.LOGD first. Example :
-<pre>
-public class DummyActivity extends Activity {
- public void foo() {
- Log.d("TAG", "msg1"); // Bad
-
- bar();
-
- if (Config.LOGD) Log.d("TAG", "msg1"); // Good
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Log.v calls should be protected by checking Config.LOGV first. Example :
-<pre>
-public class DummyActivity extends Activity {
- public void foo() {
- Log.v("TAG", "msg1"); // Bad
- bar();
- if (Config.LOGV) Log.v("TAG", "msg1"); // Good
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Remote Interface of a Session EJB should NOT be suffixed.
\ No newline at end of file
+++ /dev/null
-Remote Home interface of a Session EJB should be suffixed by "Home".
\ No newline at end of file
+++ /dev/null
-Consider replacing this Enumeration with the newer java.util.Iterator
\ No newline at end of file
+++ /dev/null
-Consider replacing this Hashtable with the newer java.util.Map
\ No newline at end of file
+++ /dev/null
-Consider replacing Vector usages with the newer java.util.ArrayList if expensive threadsafe operation is not required.
\ No newline at end of file
+++ /dev/null
-For any method that returns an array, it's a better behavior to return an empty array rather than a null reference. Example :
-<pre>
-public class Example
-{
- // Not a good idea...
- public int []badBehavior()
- {
- // ...
- return null;
- }
-
- // Good behavior
- public String[] bonnePratique()
- {
- //...
- return new String[0];
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Avoid returning from a finally block - this can discard exceptions.
\ No newline at end of file
+++ /dev/null
-In JDK 1.5, calling new Short() causes memory allocation. Short.valueOf() is more memory friendly. Example :
- <pre>
-public class Foo {
-private Short i = new Short(0); // change to Short i =
-Short.valueOf(0);
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-Detects when very short method names are used. Example :
-<pre>
-public class ShortMethod {
- public void a( int i ) { // Violation
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Detects when a field, local, or parameter has a very short name.
\ No newline at end of file
+++ /dev/null
-It is unclear which exceptions that can be thrown from the methods. It might be difficult to document and understand the vague interfaces. Use either a class derived from RuntimeException or a checked exception.
\ No newline at end of file
+++ /dev/null
-Be sure to specify a Locale when creating a new instance of SimpleDateFormat.
\ No newline at end of file
+++ /dev/null
-Avoid unnecessary comparisons in boolean expressions - this complicates simple code. Example :
-<pre>
-public class Bar {
- // can be simplified to
- // bar = isFoo();
- private boolean bar = (isFoo() == true);
-
- public isFoo() { return false;}
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Avoid unnecessary if..then..else statements when returning a boolean. Example :
-<pre>
-public class Foo {
- private int bar =2;
- public boolean isBarEqualsTo(int x) {
- // this bit of code
- if (bar == x) {
- return true;
- } else {
- return false;
- }
- // can be replaced with a simple
- // return bar == x;
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-No need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
\ No newline at end of file
+++ /dev/null
-Since it passes in a literal of length 1, this call to String.startsWith can be rewritten using String.charAt(0) to save some time.
\ No newline at end of file
+++ /dev/null
-A field that's only used by one method could perhaps be replaced by a local variable.
\ No newline at end of file
+++ /dev/null
-According to the J2EE specification (p.494), an EJB should not have any static fields with write access. However, static read only fields are allowed. This ensures proper behavior especially when instances are distributed by the container on several JREs.
\ No newline at end of file
+++ /dev/null
-StringBuffer sb = new StringBuffer('c'); The char will be converted into int to intialize StringBuffer size.
\ No newline at end of file
+++ /dev/null
-Avoid instantiating String objects; this is usually unnecessary.
\ No newline at end of file
+++ /dev/null
-Avoid calling toString() on String objects; this is unnecessary.
\ No newline at end of file
+++ /dev/null
-A field name is all in uppercase characters, which in Sun's Java naming conventions indicate a constant. However, the field is not final. Example :
-<pre>
-public class Foo {
- // this is bad, since someone could accidentally
- // do PI = 2.71828; which is actualy e
- // final double PI = 3.16; is ok
- double PI = 3.16;
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-The method name and parameter number are suspiciously close to equals(Object), which may mean you are intending to override the equals(Object) method. Example :
-<pre>
-public class Foo {
- public int equals(Object o) {
- // oops, this probably was supposed to be boolean equals
- }
- public boolean equals(String s) {
- // oops, this probably was supposed to be equals(Object)
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-The method name and return type are suspiciously close to hashCode(), which may mean you are intending to override the hashCode() method. Example :
-<pre>
-public class Foo {
- public int hashcode() {
- // oops, this probably was supposed to be hashCode
- }
-}</pre>
\ No newline at end of file
+++ /dev/null
-A suspicious octal escape sequence was found inside a String literal. The Java language specification (section 3.10.6) says an octal escape sequence inside a literal String shall consist of a backslash followed by: OctalDigit | OctalDigit OctalDigit | ZeroToThree OctalDigit OctalDigit Any octal escape sequence followed by non-octal digits can be confusing, e.g. "\038" is interpreted as the octal escape sequence "\03" followed by the literal character 8.
\ No newline at end of file
+++ /dev/null
-A high ratio of statements to labels in a switch statement implies that the switch statement is doing too much work. Consider moving the statements into new methods, or creating subclasses based on the switch variable.
\ No newline at end of file
+++ /dev/null
-Switch statements should have a default label. Example :
-<pre>
-public class Foo {
- public void bar() {
- int x = 2;
- switch (x) {
- case 2: int j = 8;
- }
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-System.(out|err).print is used, consider using a logger.
\ No newline at end of file
+++ /dev/null
-Swith are designed complex branches, and allow branches to share treatement. Using a switch for only a few branches is ill advised, as switches are not as easy to understand as if. In this case, it's most likely is a good idea to use a if statement instead, at least to increase code readability. Example :
-<pre>
-// With a minimumNumberCaseForASwitch of 3
-public class Foo {
- public void bar() {
- switch (condition) {
- case ONE:
- instruction;
- break;
- default:
- break; // not enough for a 'switch' stmt,
- // a simple 'if' stmt would have been more appropriate
- }
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.
\ No newline at end of file
+++ /dev/null
-A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
\ No newline at end of file
+++ /dev/null
-If you overuse the static import feature, it can make your program unreadable and unmaintainable, polluting its namespace with all the static members you import. Readers of your code (including you, a few months after you wrote it) will not know which class a static member comes from (Sun 1.5 Language Guide).
\ No newline at end of file
+++ /dev/null
-Uncommented Empty Constructor finds instances where a constructor does not contain statements, but there is no comment. By explicitly commenting empty constructors it is easier to distinguish between intentional (commented) and unintentional empty constructors.
\ No newline at end of file
+++ /dev/null
-Uncommented Empty Method finds instances where a method does not contain statements, but there is no comment. By explicitly commenting empty methods it is easier to distinguish between intentional (commented) and unintentional empty methods.
\ No newline at end of file
+++ /dev/null
-Do not use if statements that are always true or always false.
\ No newline at end of file
+++ /dev/null
-Using equalsIgnoreCase() is faster than using toUpperCase/toLowerCase().equals()
\ No newline at end of file
+++ /dev/null
-This rule detects when a constructor is not necessary; i.e., when there's only one constructor, it's public, has an empty body, and takes no arguments.
\ No newline at end of file
+++ /dev/null
-Avoid unnecessary temporaries when converting primitives to Strings
\ No newline at end of file
+++ /dev/null
-When a class has the final modifier, all the methods are automatically final.
\ No newline at end of file
+++ /dev/null
-Avoid unnecessarily creating local variables
\ No newline at end of file
+++ /dev/null
-Sometimes expressions are wrapped in unnecessary parentheses, making them look like a function call. Example :
-<pre>
-public class Foo {
- boolean bar() {
- return (true);
- }
-}
- </pre>
\ No newline at end of file
+++ /dev/null
-Avoid unnecessary return statements
\ No newline at end of file
+++ /dev/null
-Parsing method should be called directy instead.
\ No newline at end of file
+++ /dev/null
-SimpleDateFormat is not synchronized. Sun recomends separate format instances for each thread. If multiple threads must access a static formatter, the formatter must be synchronized either on method or block level.
\ No newline at end of file
+++ /dev/null
-Avoid passing parameters to methods or constructors and then not using those parameters.
\ No newline at end of file
+++ /dev/null
-Avoid unused import statements. Example :
- <pre>
-// this is bad
-import java.io.File;
-public class Foo {}
- </pre>
\ No newline at end of file
+++ /dev/null
-Detects when a local variable is declared and/or assigned, but not used.
\ No newline at end of file
+++ /dev/null
-Fields in interfaces are automatically public static final, and methods are public abstract. Classes or interfaces nested in an interface are automatically public and static (all nested interfaces are automatically static). For historical reasons, modifiers which are implied by the context are accepted by the compiler, but are superfluous.
\ No newline at end of file
+++ /dev/null
-After checking an object reference for null, you should invoke equals() on that object rather than passing it to another object's equals() method.
\ No newline at end of file
+++ /dev/null
-Detects when a private field is declared and/or assigned a value, but not used.
\ No newline at end of file
+++ /dev/null
-Unused Private Method detects when a private method is declared but is unused. This PMD rule should be switched off and replaced by its equivalent from Squid that is more effective : it generates less false-positives and detects more dead code.
\ No newline at end of file
+++ /dev/null
-ArrayList is a much better Collection implementation than Vector.
\ No newline at end of file
+++ /dev/null
-The class java.util.Arrays has a asList method that should be use when you want to create a new List from an array of objects. It is faster than executing a loop to cpy all the elements of the array one by one
\ No newline at end of file
+++ /dev/null
-The isEmpty() method on java.util.Collection is provided to see if a collection has any elements. Comparing the value of size() to 0 merely duplicates existing behavior.
\ No newline at end of file
+++ /dev/null
-Since Java5 brought a new implementation of the Map interface, specially designed for concurrent application.
+++ /dev/null
-To make sure the full stacktrace is printed out, use the logging statement with 2 arguments: a String and a Throwable.
\ No newline at end of file
+++ /dev/null
-Using "==" or "!=" to compare strings only works if intern version is used on both sides.
\ No newline at end of file
+++ /dev/null
-Use String.indexOf(char) when checking for the index of a single character; it executes faster.
\ No newline at end of file
+++ /dev/null
-When doing a String.toLowerCase()/toUpperCase() call, use a Locale. This avoids problems with certain locales, i.e. Turkish.
\ No newline at end of file
+++ /dev/null
-Thread.notify() awakens a thread monitoring the object. If more than one thread is monitoring, then only one is chosen. The thread chosen is arbitrary; thus it's usually safer to call notifyAll() instead.
\ No newline at end of file
+++ /dev/null
-In J2EE getClassLoader() might not work as expected. Use Thread.currentThread().getContextClassLoader() instead.
\ No newline at end of file
+++ /dev/null
-If you have a class that has nothing but static methods, consider making it a Singleton. Note that this doesn't apply to abstract classes, since their subclasses may well include non-static methods. Also, if you want this class to be a Singleton, remember to add a private constructor to prevent instantiation.
\ No newline at end of file
+++ /dev/null
-Finds usages of += for appending strings.
\ No newline at end of file
+++ /dev/null
-Use StringBuffer.length() to determine StringBuffer length rather than using StringBuffer.toString().equals() or StringBuffer.toString().length() ==.
\ No newline at end of file
+++ /dev/null
-An operation on an Immutable object (BigDecimal or BigInteger) won't change the object itself. The result of the operation is a new object. Therefore, ignoring the operation result is an error.
\ No newline at end of file
+++ /dev/null
-The overriding method merely calls the same method defined in a superclass
\ No newline at end of file
+++ /dev/null
-No need to call String.valueOf to append to a string; just use the valueOf() argument directly.
\ No newline at end of file
+++ /dev/null
-A variable naming conventions rule - customize this to your liking. Currently, it checks for final variables that should be fully capitalized and non-final variables that should not include underscores.
\ No newline at end of file
+++ /dev/null
-Avoid using 'while' statements without using curly braces.
\ No newline at end of file
+++ /dev/null
-PMD provides a very handy method for creating new rules by writing an XPath query. When the XPath query finds a match, a violation is created.
-Let's take a simple example: assume we have a Factory class that must be always declared final.
-We'd like to report a violation each time a declaration of Factory is not declared final. Consider the following class:
-<pre>
-public class a {
- Factory f1;
-
- void myMethod() {
- Factory f2;
- int a;
- }
-}
-</pre>
-The following expression does the magic we need:
-<pre>
-//VariableDeclarator
- [../Type/ReferenceType/ClassOrInterfaceType
- [@Image = 'Factory'] and ..[@Final='false']]
-</pre>
-See the <a href="http://pmd.sourceforge.net/xpathruletutorial.html" target="_blank">XPath rule tutorial</a> for more information.
+++ /dev/null
-rule.squid.ArchitecturalConstraint.name=Architectural constraint
-rule.squid.ArchitecturalConstraint.param.fromClasses=Optional. If this property is not defined, all classes should adhere to this constraint. Ex : **.web.**
-rule.squid.ArchitecturalConstraint.param.toClasses=Mandatory. Ex : java.util.Vector, java.util.Hashtable, java.util.Enumeration
-
-rule.squid.AvoidBreakOutsideSwitch.name=Avoid using 'break' branching statement outside a 'switch' statement
-
-rule.squid.AvoidContinueStatement.name=Avoid using 'continue' branching statement
-
-rule.squid.CallToDeprecatedMethod.name=Avoid use of deprecated method
-
-rule.squid.ClassCyclomaticComplexity.name=Avoid too complex class
-rule.squid.ClassCyclomaticComplexity.param.max=Maximum complexity allowed.
-
-rule.squid.EmptyFile.name=Empty file
-
-rule.squid.MaximumInheritanceDepth.name=Avoid too deep inheritance tree
-rule.squid.MaximumInheritanceDepth.param.max=Maximum depth of the inheritance tree.
-
-rule.squid.MethodCyclomaticComplexity.name=Avoid too complex method
-rule.squid.MethodCyclomaticComplexity.param.max=Maximum complexity allowed.
-
-rule.squid.NoSonar.name=Avoid use of //NOSONAR marker
-
-rule.squid.UndocumentedApi.name=Undocumented API
-rule.squid.UndocumentedApi.param.forClasses=Optional. If this property is not defined, all classes should adhere to this constraint. Ex : **.api.**
-
-rule.squid.UnusedPrivateMethod.name=Unused private method
-
-rule.squid.UnusedProtectedMethod.name=Unused protected method
-
-rule.squid.CommentedOutCodeLine.name=Avoid commented-out lines of code
-
-rule.squid.CycleBetweenPackages.name=Avoid cycle between java packages
-
-rule.squid.ParsingError.name=Java parser failure
-
-rule.squid.MaximumLackOfCohesionOfMethods.name=Avoid too high LCOM4
-rule.squid.MaximumLackOfCohesionOfMethods.param.max=Maximum LCOM4 allowed.
+++ /dev/null
-<p>A source code comply to an architectural model when it fully
- adheres to a set of architectural constraints. A constraint allows to
- deny references between classes by pattern.</p>
-<p>You can for instance use this rule to :</p>
-<ul>
- <li>forbid access to **.web.** from **.dao.** classes</li>
- <li>forbid access to java.util.Vector, java.util.Hashtable and
- java.util.Enumeration from any classes</li>
- <li>forbid access to java.sql.** from **.ui.** and **.web.**
- classes</li>
-</ul>
\ No newline at end of file
+++ /dev/null
-<p>The use of the 'break' branching statement increases the
- essential complexity of the source code and so prevents any refactoring
- of this source code to replace all well structured control structures
- with a single statement.</p>
-<p>For instance, with the following java program fragment, it's not
- possible to apply the 'extract method' refactoring pattern :</p>
-<pre>
-mylabel : for (int i = 0 ; i< 3; i++) {
- for (int j = 0; j < 4 ; j++) {
- doSomething();
- if (checkSomething()) {
- break mylabel;
- }
- }
-}
-</pre>
-<p>The use of the 'break' branching statement is only authorized
- inside a 'switch' statement.</p>
\ No newline at end of file
+++ /dev/null
-<p>The use of the 'continue' branching statement increase the
- essential complexity of the source code and so prevent any refactoring
- of this source code to replace all well structured control structures
- with a single statement.</p>
-<p>For instance, in the following java program fragment, it's not
- possible to apply the 'extract method' refactoring pattern :</p>
-<pre>
-mylabel : for(int i = 0 ; i< 3; i++) {
- for (int j = 0; j < 4 ; j++) {
- doSomething();
- if (checkSomething()) {
- continue mylabel;
- }
- }
-}
-</pre>
\ No newline at end of file
+++ /dev/null
-<p>Once deprecated, a method should no longer be used as it means
- that the method might be removed sooner or later.</p>
\ No newline at end of file
+++ /dev/null
-<p>The Cyclomatic Complexity is measured by the number of (&&, ||)
- operators and (if, while, do, for, ?:, catch, switch, case, return,
- throw) statements in the body of a class plus one for each constructor,
- method (but not getter/setter), static initializer, or instance
- initializer in the class. The last return stament in method, if exists,
- is not taken into account.</p>
-<p>
- Even when the Cyclomatic Complexity of a class is very high, this
- complexity might be well distributed among all methods. Nevertheless,
- most of the time, a very complex class is a class which breaks the <a
- href='http://en.wikipedia.org/wiki/Single_responsibility_principle'>Single
- Responsibility Principle</a> and which should be re-factored to be split
- in several classes.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>Here are the main reasons why commented code is a code smell :</p>
-<ul>
- <li>It always raises more questions than it gives answers</li>
- <li>Everybody will forget very quickly how relevant the commented code is</li>
- <li>This is distraction when going down the code as it stops the flow of eyes</li>
- <li>It is a bad SCM engine : Subversion, CVS and Git are really more trustworthy !</li>
- <li>The simple fact of understanding why code was commented out in the first place can take a lot of time</li>
-</ul>
+++ /dev/null
-<p>
-When several packages are involved in a cycle (package A > package B > package C > package A where ">" means "depends upon"),
-that means that those packages are highly coupled and that there is no way to reuse/extract one of those packages without importing all the other packages.
-Such cycle could quickly increase the effort required to maintain an application and to embrace business change.
-Sonar not only detect cycles between packages but also determines what is the minimum effort to break those cycles.
-This rule log a violation on each source file having an outgoing dependency to be but in order to break a cycle.
-</p>
+++ /dev/null
-<p>Detect empty files, which do not have any lines of code.</p>
-<p>Example:</p>
-<pre>
-//package org.foo;
-//
-//public class Bar {}
-</pre>
\ No newline at end of file
+++ /dev/null
-<p>Inheritance is certainly one of the most valuable concept of
- object-oriented programming. It's a way to compartmentalize and reuse
- code by creating collections of attributes and behaviors called classes
- which can be based on previously created classes. But abusing of this
- concept by creating a deep inheritance tree can lead to very complex
- and unmaintainable source code.</p>
-<p>Most of the time a too deep inheritance tree is due to bad object
- oriented design which has led to systematically use 'inheritance' when
- 'composition' would suit better.</p>
\ No newline at end of file
+++ /dev/null
-<p>
-Detects classes that should be reviewed because of a high LCOM4 metric.
-They possibly violate the Single Responsibility Principle.
-</p>
+++ /dev/null
-<p>The Cyclomatic Complexity is measured by the number of
- (&&, ||) operators and (if, while, do, for, ?:, catch, switch,
- case, return, throw) statements in the body of a class plus one for
- each constructor, method (but not getter/setter), static initializer,
- or instance initializer in the class. The last return stament in
- method, if exists, is not taken into account.</p>
-<p>
- Even when the Cyclomatic Complexity of a class is very high, this
- complexity might be well distributed among all methods. Nevertheless,
- most of the time, a very complex class is a class which breaks the <a
- href="http://en.wikipedia.org/wiki/Single_responsibility_principle">Single
- Responsibility Principle</a> and which should be re-factored to be split
- in several classes.
-</p>
\ No newline at end of file
+++ /dev/null
-<p>Any violation to quality rule can be deactivated with the
- //NOSONAR marker. This marker is pretty useful to exclude
- false-positive results but sometimes it can abusively be used to hide
- real quality flaws.</p>
-<p>This rule allows to track and/or forbid use of this marker</p>
\ No newline at end of file
+++ /dev/null
-<p>
-When the Java parser fails, it is possible to record the failure as a violation on the file.
-This way, not only it is possible to track the number of files that do not parse but also to easily find out why they do not parse.
-</p>
+++ /dev/null
-<p>Check that each public class, interface, method and constructor
- has a Javadoc comment. The following public methods/constructors are
- not concerned by this rule :</p>
-<ul>
- <li>Getter / Setter</li>
- <li>Method with @Override annotation</li>
- <li>Empty constructor</li>
-</ul>
\ No newline at end of file
+++ /dev/null
-<p>Private methods that are never executed are dead code. Dead code
- means unnecessary, inoperative code that should be removed. This helps
- in maintenance by decreasing the maintained code size, making it easier
- to understand the program and preventing bugs from being introduced.</p>
-<p>In the following two cases, private methods are not considered as
- dead code by Sonar :</p>
-<ul>
- <li>Private empty constructors that are intentionally used to
- prevent any direct instantiation of a class.</li>
- <li>Private methods : readObject(...), writeObject(...),
- writeReplace(...), readResolve(...) which can contractually be used
- when implementing the Serializable interface.</li>
-</ul>
\ No newline at end of file
+++ /dev/null
-<p>Protected methods that are never used by any classes in the same
- project are strongly suspected to be dead code. Dead code means
- unnecessary, inoperative code that should be removed. This helps in
- maintenance by decreasing the maintained code size, making it easier to
- understand the program and preventing bugs from being introduced.</p>
-<p>In the following case, unused protected methods are not
- considered as dead code by Sonar :</p>
-<ul>
- <li>Protected methods which override a method from a parent class.</li>
- <li>Protected methods of an abstract class.</li>
-</ul>
\ No newline at end of file
<configuration>
<rules>
<requireFilesSize>
- <maxsize>1500000</maxsize>
- <minsize>1000000</minsize>
+ <maxsize>1600000</maxsize>
+ <minsize>1400000</minsize>
<files>
<file>${project.build.directory}/${project.build.finalName}.jar</file>
</files>
--- /dev/null
+rule.pmd.StringInstantiation.name=String Instantiation
+rule.pmd.RemoteInterfaceNamingConvention.name=Remote Interface Naming Convention
+rule.pmd.InefficientEmptyStringCheck.name=Inefficient Empty String Check
+rule.pmd.DoubleCheckedLocking.name=Double checked locking
+rule.pmd.EmptyStaticInitializer.name=Empty Static Initializer
+rule.pmd.DoNotThrowExceptionInFinally.name=Strict Exception - Do not throw exception in finally
+rule.pmd.SignatureDeclareThrowsException.name=Signature Declare Throws Exception
+rule.pmd.UseEqualsToCompareStrings.name=Use Equals To Compare Strings
+rule.pmd.VariableNamingConventions.name=Naming - Variable naming conventions
+rule.pmd.VariableNamingConventions.param.memberSuffix=A suffix for member variables
+rule.pmd.VariableNamingConventions.param.memberPrefix=A prefix for member variables
+rule.pmd.VariableNamingConventions.param.staticSuffix=A suffix for static variables
+rule.pmd.VariableNamingConventions.param.staticPrefix=A prefix for static variables
+rule.pmd.PositionLiteralsFirstInComparisons.name=Position Literals First In Comparisons
+rule.pmd.ConfusingTernary.name=Confusing Ternary
+rule.pmd.ShortMethodName.name=Naming - Short method name
+rule.pmd.UncommentedEmptyConstructor.name=Uncommented Empty Constructor
+rule.pmd.UncommentedEmptyConstructor.param.ignoreExplicitConstructorInvocation=Ignore explicit constructor invocation when deciding whether constructor is empty or not. Default is false.
+rule.pmd.UnusedFormalParameter.name=Unused formal parameter
+rule.pmd.ExcessiveParameterList.name=Excessive Parameter List
+rule.pmd.ExcessiveParameterList.param.minimum=The parameter count reporting threshold. Default is 10.
+rule.pmd.OnlyOneReturn.name=Only One Return
+rule.pmd.UseStringBufferForStringAppends.name=Use String Buffer For String Appends
+rule.pmd.BooleanInversion.name=Boolean Inversion
+rule.pmd.AvoidDollarSigns.name=Naming - Avoid dollar signs
+rule.pmd.AvoidUsingShortType.name=Avoid Using Short Type
+rule.pmd.NonCaseLabelInSwitchStatement.name=Non Case Label In Switch Statement
+rule.pmd.CyclomaticComplexity.name=Code size - cyclomatic complexity
+rule.pmd.CyclomaticComplexity.param.showMethodsComplexity=Indicate if method average violation should be added to the report. Default is true.
+rule.pmd.CyclomaticComplexity.param.showClassesComplexity=Indicate if class average violation should be added to the report. Default is true.
+rule.pmd.CyclomaticComplexity.param.reportLevel=The Cyclomatic Complexity reporting threshold. Default is 10.
+rule.pmd.AvoidEnumAsIdentifier.name=Avoid Enum As Identifier
+rule.pmd.AvoidFieldNameMatchingMethodName.name=Naming - Avoid field name matching method name
+rule.pmd.InstantiationToGetClass.name=Instantiation To Get Class
+rule.pmd.SuspiciousHashcodeMethodName.name=Naming - Suspicious Hashcode method name
+rule.pmd.MDBAndSessionBeanNamingConvention.name=Message Driven Bean And Session Bean Naming Convention
+rule.pmd.UselessOperationOnImmutable.name=Useless Operation On Immutable
+rule.pmd.ReturnEmptyArrayRatherThanNull.name=Return empty array rather than null
+rule.pmd.LongInstantiation.name=Java5 migration - Long instantiation
+rule.pmd.ExcessiveImports.name=Coupling - excessive imports
+rule.pmd.ExcessiveImports.param.minimum=The import count reporting threshold. Default is 30.
+rule.pmd.StringBufferInstantiationWithChar.name=String Buffer Instantiation With Char
+rule.pmd.StringToString.name=String To String
+rule.pmd.MissingSerialVersionUID.name=Missing Serial Version UID
+rule.pmd.UnconditionalIfStatement.name=Unconditional If Statement
+rule.pmd.AvoidArrayLoops.name=Avoid Array Loops
+rule.pmd.ShortVariable.name=Short Variable
+rule.pmd.UnusedLocalVariable.name=Unused local variable
+rule.pmd.SuspiciousConstantFieldName.name=Naming - Suspicious constant field name
+rule.pmd.UseArrayListInsteadOfVector.name=Use Array List Instead Of Vector
+rule.pmd.CallSuperLast.name=Android - call super last
+rule.pmd.SimplifyBooleanExpressions.name=Avoid unnecessary comparisons in boolean expressions
+rule.pmd.FinalizeOnlyCallsSuperFinalize.name=Finalize Only Calls Super Finalize
+rule.pmd.ImmutableField.name=Immutable Field
+rule.pmd.BooleanInstantiation.name=Boolean Instantiation
+rule.pmd.StaticEJBFieldShouldBeFinal.name=Static EJB Field Should Be Final
+rule.pmd.AvoidFieldNameMatchingTypeName.name=Naming - Avoid field name matching type name
+rule.pmd.OverrideBothEqualsAndHashcode.name=Override both equals and hashcode
+rule.pmd.BrokenNullCheck.name=Broken Null Check
+rule.pmd.NPathComplexity.name=NPath complexity
+rule.pmd.NPathComplexity.param.minimum=The npath reporting threshold. Default is 200.
+rule.pmd.CouplingBetweenObjects.name=Coupling between objects
+rule.pmd.CouplingBetweenObjects.param.threshold=The unique type reporting threshold. Default is 20.
+rule.pmd.IntegerInstantiation.name=Integer Instantiation
+rule.pmd.DoNotCallGarbageCollectionExplicitly.name=Do not call garbage collection explicitly
+rule.pmd.BeanMembersShouldSerialize.name=Bean Members Should Serialize
+rule.pmd.BeanMembersShouldSerialize.param.prefix=A variable prefix to skip, i.e., m_
+rule.pmd.IdempotentOperations.name=Idempotent Operations
+rule.pmd.NcssTypeCount.name=Ncss Type Count
+rule.pmd.NcssTypeCount.param.minimum=The type NCSS count reporting threshold. Default is 1500.
+rule.pmd.AvoidThrowingRawExceptionTypes.name=Avoid Throwing Raw Exception Types
+rule.pmd.ImportFromSamePackage.name=Import From Same Package
+rule.pmd.UnnecessaryLocalBeforeReturn.name=Unnecessary Local Before Return
+rule.pmd.IfElseStmtsMustUseBraces.name=If Else Stmts Must Use Braces
+rule.pmd.ForLoopsMustUseBraces.name=For Loops Must Use Braces
+rule.pmd.UseIndexOfChar.name=Use Index Of Char
+rule.pmd.EmptyMethodInAbstractClassShouldBeAbstract.name=Empty Method In Abstract Class Should Be Abstract
+rule.pmd.LongVariable.name=Long Variable
+rule.pmd.LongVariable.param.minimum=The variable length reporting threshold. Default is 17.
+rule.pmd.MissingBreakInSwitch.name=Missing Break In Switch
+rule.pmd.UnnecessaryParentheses.name=Unnecessary parentheses
+rule.pmd.MisleadingVariableName.name=Naming - Misleading variable name
+rule.pmd.AbstractClassWithoutAnyMethod.name=Abstract class without any methods
+rule.pmd.DoNotCallSystemExit.name=Do Not Call System Exit
+rule.pmd.AvoidThrowingNullPointerException.name=Avoid Throwing Null Pointer Exception
+rule.pmd.EmptySynchronizedBlock.name=Empty Synchronized Block
+rule.pmd.SwitchStmtsShouldHaveDefault.name=Switch statements should have default
+rule.pmd.UseNotifyAllInsteadOfNotify.name=Use Notify All Instead Of Notify
+rule.pmd.UnusedPrivateMethod.name=Unused private method
+rule.pmd.MoreThanOneLogger.name=More Than One Logger
+rule.pmd.EmptyTryBlock.name=Empty Try Block
+rule.pmd.AvoidDeeplyNestedIfStmts.name=Avoid Deeply Nested If Stmts
+rule.pmd.AvoidDeeplyNestedIfStmts.param.problemDepth=The if statement depth reporting threshold. Default is 3.
+rule.pmd.LocalHomeNamingConvention.name=Local Home Naming Convention
+rule.pmd.AvoidUsingNativeCode.name=Avoid Using Native Code
+rule.pmd.LooseCoupling.name=Loose coupling
+rule.pmd.FinalizeOverloaded.name=Finalize Overloaded
+rule.pmd.AvoidThreadGroup.name=Avoid Thread Group
+rule.pmd.UnnecessaryConstructor.name=Unnecessary constructor
+rule.pmd.LocalVariableCouldBeFinal.name=Local variable could be final
+rule.pmd.MethodArgumentCouldBeFinal.name=Method Argument Could Be Final
+rule.pmd.AvoidAssertAsIdentifier.name=Avoid Assert As Identifier
+rule.pmd.SuspiciousOctalEscape.name=Suspicious Octal Escape
+rule.pmd.ByteInstantiation.name=Java5 migration - Byte instantiation
+rule.pmd.AvoidConstantsInterface.name=Avoid Constants Interface
+rule.pmd.LocalInterfaceSessionNamingConvention.name=Local Interface Session Naming Convention
+rule.pmd.CloneMethodMustImplementCloneable.name=Clone method must implement Cloneable
+rule.pmd.MethodWithSameNameAsEnclosingClass.name=Naming - Method with same name as enclosing class
+rule.pmd.ConsecutiveLiteralAppends.name=Consecutive Literal Appends
+rule.pmd.ConsecutiveLiteralAppends.param.threshold=The report threshold. Default is 1.
+rule.pmd.CallSuperInConstructor.name=Call Super In Constructor
+rule.pmd.SimplifyConditional.name=Simplify Conditional
+rule.pmd.InefficientStringBuffering.name=Inefficient String Buffering
+rule.pmd.EmptyStatementNotInLoop.name=Empty Statement Not In Loop
+rule.pmd.AvoidSynchronizedAtMethodLevel.name=Avoid Synchronized At Method Level
+rule.pmd.NcssMethodCount.name=Ncss Method Count
+rule.pmd.NcssMethodCount.param.minimum=The method NCSS count reporting threshold. Default is 100.
+rule.pmd.AbstractClassWithoutAbstractMethod.name=Abstract Class Without Abstract Method
+rule.pmd.AbstractNaming.name=Abstract naming
+rule.pmd.DoNotExtendJavaLangError.name=Do Not Extend Java Lang Error
+rule.pmd.NoPackage.name=No package
+rule.pmd.ExcessiveMethodLength.name=Excessive Method Length
+rule.pmd.ExcessiveMethodLength.param.minimum=The method size reporting threshold. Default is 100.
+rule.pmd.SwitchDensity.name=Switch Density
+rule.pmd.SwitchDensity.param.minimum=The switch statement ratio reporting threshold. Default is 10.
+rule.pmd.UseLocaleWithCaseConversions.name=Use Locale With Case Conversions
+rule.pmd.DuplicateImports.name=Duplicate Imports
+rule.pmd.ProperLogger.name=Proper Logger
+rule.pmd.ProperLogger.param.staticLoggerName=Default is LOG
+rule.pmd.PreserveStackTrace.name=Preserve Stack Trace
+rule.pmd.FinalizeDoesNotCallSuperFinalize.name=Finalize Does Not Call Super Finalize
+rule.pmd.DontImportSun.name=Dont Import Sun
+rule.pmd.ReplaceVectorWithList.name=Replace Vector With List
+rule.pmd.ClassNamingConventions.name=Naming - Class naming conventions
+rule.pmd.UncommentedEmptyMethod.name=Uncommented Empty Method
+rule.pmd.AvoidAccessibilityAlteration.name=Avoid Accessibility Alteration
+rule.pmd.IfStmtsMustUseBraces.name=If Stmts Must Use Braces
+rule.pmd.AvoidReassigningParameters.name=Avoid Reassigning Parameters
+rule.pmd.OptimizableToArrayCall.name=Optimizable To Array Call
+rule.pmd.FinalizeShouldBeProtected.name=Finalize Should Be Protected
+rule.pmd.AddEmptyString.name=Add Empty String
+rule.pmd.EmptyFinallyBlock.name=Empty Finally Block
+rule.pmd.EqualsNull.name=Equals Null
+rule.pmd.SuspiciousEqualsMethodName.name=Naming - Suspicious equals method name
+rule.pmd.UnnecessaryWrapperObjectCreation.name=Unnecessary Wrapper Object Creation
+rule.pmd.AvoidStringBufferField.name=Avoid StringBuffer field
+rule.pmd.SimplifyBooleanReturns.name=Simplify boolean returns
+rule.pmd.DefaultLabelNotLastInSwitchStmt.name=Default label not last in switch statement
+rule.pmd.AvoidUsingOctalValues.name=Avoid Using Octal Values
+rule.pmd.AvoidCallingFinalize.name=Avoid Calling Finalize
+rule.pmd.ExcessiveClassLength.name=Excessive Class Length
+rule.pmd.ExcessiveClassLength.param.minimum=The class size reporting threshold. Default is 1000.
+rule.pmd.FinalFieldCouldBeStatic.name=Final Field Could Be Static
+rule.pmd.AvoidRethrowingException.name=Avoid Rethrowing Exception
+rule.pmd.AvoidUsingHardCodedIP.name=Avoid Using Hard Coded IP
+rule.pmd.AvoidUsingHardCodedIP.param.pattern=Regular Expression. Default is ^[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}$
+rule.pmd.ProtectLogD.name=Android - Protect LOGD
+rule.pmd.ProtectLogV.name=Android - Protect LOGV
+rule.pmd.MethodNamingConventions.name=Naming - Method naming conventions
+rule.pmd.NonStaticInitializer.name=Non Static Initializer
+rule.pmd.AvoidProtectedFieldInFinalClass.name=Avoid Protected Field In Final Class
+rule.pmd.CompareObjectsWithEquals.name=Compare Objects With Equals
+rule.pmd.SystemPrintln.name=System Println
+rule.pmd.XPathRule.name=XPath rule template
+rule.pmd.XPathRule.param.message=Message to display when a violation occurs.
+rule.pmd.XPathRule.param.xpath=XPath expressions.
+rule.pmd.DontImportJavaLang.name=Dont Import Java Lang
+rule.pmd.TooManyMethods.name=Too many methods
+rule.pmd.TooManyMethods.param.maxmethods=The method count reporting threshold. Default is 10.
+rule.pmd.CloneThrowsCloneNotSupportedException.name=Clone Throws Clone Not Supported Exception
+rule.pmd.EmptyCatchBlock.name=Empty Catch Block
+rule.pmd.EmptyCatchBlock.param.allowCommentedBlocks=Empty blocks containing comments will be skipped. Default is false.
+rule.pmd.CollapsibleIfStatements.name=Collapsible If Statements
+rule.pmd.ForLoopShouldBeWhileLoop.name=For Loop Should Be While Loop
+rule.pmd.UseCorrectExceptionLogging.name=Use Correct Exception Logging
+rule.pmd.ReplaceEnumerationWithIterator.name=Replace Enumeration With Iterator
+rule.pmd.EmptyWhileStmt.name=Empty While Stmt
+rule.pmd.ReplaceHashtableWithMap.name=Replace Hashtable With Map
+rule.pmd.AvoidMultipleUnaryOperators.name=Avoid Multiple Unary Operators
+rule.pmd.UselessOverridingMethod.name=Useless Overriding Method
+rule.pmd.UselessOverridingMethod.param.ignoreAnnotations=Ignore annotations. Default is false.
+rule.pmd.SimpleDateFormatNeedsLocale.name=Simple Date Format Needs Locale
+rule.pmd.UnnecessaryFinalModifier.name=Unnecessary Final Modifier
+rule.pmd.CallSuperFirst.name=Android - call super first
+rule.pmd.UseArraysAsList.name=Use Arrays As List
+rule.pmd.CloseResource.name=Close Resource
+rule.pmd.CloseResource.param.closeTargets=Methods which may close this resource. Default is 'close'.
+rule.pmd.CloseResource.param.types=Resources to check. Default value is 'Connection,Statement,ResultSet',
+rule.pmd.EmptySwitchStatements.name=Empty Switch Statements
+rule.pmd.AccessorClassGeneration.name=Accessor Class Generation
+rule.pmd.PackageCase.name=Package case
+rule.pmd.TooFewBranchesForASwitchStatement.name=Too few branches for a switch statement
+rule.pmd.TooFewBranchesForASwitchStatement.param.minimumNumberCaseForASwitch=Minimum number of branches for a switch. Default is 3.
+rule.pmd.TooManyStaticImports.name=Too Many Static Imports
+rule.pmd.TooManyStaticImports.param.maximumStaticImports=All static imports can be disallowed by setting this to 0. Default is 4.
+rule.pmd.EmptyIfStmt.name=Empty If Stmt
+rule.pmd.DataflowAnomalyAnalysis.name=Dataflow Anomaly Analysis
+rule.pmd.DataflowAnomalyAnalysis.param.maxviolations=The maximum number of violations per class. Default is 100.
+rule.pmd.DataflowAnomalyAnalysis.param.maxpaths=The maximum number of checked paths per method. A lower value will increase the performance of the rule but may decrease the number of found anomalies. Default is 1000.
+rule.pmd.NonThreadSafeSingleton.name=Non Thread Safe Singleton
+rule.pmd.NonThreadSafeSingleton.param.checkNonStaticFields=Do not set this to true and checkNonStaticMethods to false. Default is false.
+rule.pmd.NonThreadSafeSingleton.param.checkNonStaticMethods=Do not set this to false and checkNonStaticFields to true. Default is true.
+rule.pmd.WhileLoopsMustUseBraces.name=While Loops Must Use Braces
+rule.pmd.UnusedModifier.name=Unused Modifier
+rule.pmd.ClassCastExceptionWithToArray.name=Class Cast Exception With To Array
+rule.pmd.EmptyInitializer.name=Basic - Empty Initializer
+rule.pmd.DoNotUseThreads.name=Do Not Use Threads
+rule.pmd.InsufficientStringBufferDeclaration.name=Insufficient String Buffer Declaration
+rule.pmd.AvoidUsingVolatile.name=Avoid Using Volatile
+rule.pmd.UseStringBufferLength.name=Use String Buffer Length
+rule.pmd.AvoidInstantiatingObjectsInLoops.name=Avoid instantiating objects in loops
+rule.pmd.UnsynchronizedStaticDateFormatter.name=Unsynchronized Static Date Formatter
+rule.pmd.MissingStaticMethodInNonInstantiatableClass.name=Missing Static Method In Non Instantiatable Class
+rule.pmd.EmptyFinalizer.name=Empty Finalizer
+rule.pmd.ShortInstantiation.name=Java5 migration - Short instantiation
+rule.pmd.ConstructorCallsOverridableMethod.name=Constructor Calls Overridable Method
+rule.pmd.DefaultPackage.name=Default Package
+rule.pmd.NcssConstructorCount.name=Ncss Constructor Count
+rule.pmd.NcssConstructorCount.param.minimum=The constructor NCSS count reporting threshold. Default is 100.
+rule.pmd.AvoidCatchingThrowable.name=Avoid Catching Throwable
+rule.pmd.AvoidDecimalLiteralsInBigDecimalConstructor.name=Avoid Decimal Literals In Big Decimal Constructor
+rule.pmd.AvoidDuplicateLiterals.name=Avoid Duplicate Literals
+rule.pmd.AvoidDuplicateLiterals.param.separator=Separator used in the exceptionlist. Default is ,
+rule.pmd.AvoidDuplicateLiterals.param.skipAnnotations=Skip literals within Annotations. Default is false.
+rule.pmd.AvoidDuplicateLiterals.param.exceptionfile=File containing strings to skip (one string per line), only used if exceptionlist is not set.
+rule.pmd.AvoidDuplicateLiterals.param.threshold=The number of duplicate literals reporting threshold. Default is 4.
+rule.pmd.AvoidDuplicateLiterals.param.exceptionlist=Strings in that list are skipped.
+rule.pmd.ExcessivePublicCount.name=Excessive Public Count
+rule.pmd.ExcessivePublicCount.param.minimum=The public item reporting threshold. Default is 45.
+rule.pmd.ClassWithOnlyPrivateConstructorsShouldBeFinal.name=Class with only private constructors should be final
+rule.pmd.NullAssignment.name=Null Assignment
+rule.pmd.MisplacedNullCheck.name=Misplaced Null Check
+rule.pmd.SingularField.name=Singular Field
+rule.pmd.UnusedImports.name=Unused imports
+rule.pmd.UselessStringValueOf.name=Useless String Value Of
+rule.pmd.UnusedNullCheckInEquals.name=Unused Null Check In Equals
+rule.pmd.AvoidCatchingNPE.name=Avoid Catching NPE
+rule.pmd.DontNestJsfInJstlIteration.name=Dont Nest Jsf In Jstl Iteration
+rule.pmd.CheckResultSet.name=Check ResultSet
+rule.pmd.ReturnFromFinallyBlock.name=Return From Finally Block
+rule.pmd.UseProperClassLoader.name=Use Proper Class Loader
+rule.pmd.UseSingleton.name=Use Singleton
+rule.pmd.ProperCloneImplementation.name=Proper clone implementation
+rule.pmd.UseCollectionIsEmpty.name=Use Collection Is Empty
+rule.pmd.AvoidThrowingNewInstanceOfSameException.name=Strict Exception - Avoid throwing new instance of same exception
+rule.pmd.SimplifyStartsWith.name=Simplify Starts With
+rule.pmd.AvoidFinalLocalVariable.name=Avoid Final Local Variable
+rule.pmd.TooManyFields.name=Too Many Fields
+rule.pmd.TooManyFields.param.maxfields=The field count reporting threshold. Default is 15.
+rule.pmd.MethodReturnsInternalArray.name=Security - Method returns internal array
+rule.pmd.AvoidInstanceofChecksInCatchClause.name=Avoid Instanceof Checks In Catch Clause
+rule.pmd.LoggerIsNotStaticFinal.name=Logger Is Not Static Final
+rule.pmd.BigIntegerInstantiation.name=Big Integer Instantiation
+rule.pmd.AssignmentInOperand.name=Assignment In Operand
+rule.pmd.BadComparison.name=Bad Comparison
+rule.pmd.UnnecessaryReturn.name=Unnecessary Return
+rule.pmd.AssignmentToNonFinalStatic.name=Assignment To Non Final Static
+rule.pmd.UnnecessaryConversionTemporary.name=Unnecessary Conversion Temporary
+rule.pmd.JumbledIncrementer.name=Jumbled Incrementer
+rule.pmd.BooleanGetMethodName.name=Boolean Get Method Name
+rule.pmd.BooleanGetMethodName.param.checkParameterizedMethods=Check parameterized methods. Default is false.
+rule.pmd.AvoidPrintStackTrace.name=Avoid Print Stack Trace
+rule.pmd.RemoteSessionInterfaceNamingConvention.name=Remote Session Interface Naming Convention
+rule.pmd.UnnecessaryCaseChange.name=Unnecessary Case Change
+rule.pmd.ArrayIsStoredDirectly.name=Security - Array is stored directly
+rule.pmd.ExceptionAsFlowControl.name=Exception As Flow Control
+rule.pmd.UnusedPrivateField.name=Unused Private Field
+rule.pmd.AtLeastOneConstructor.name=At Least One Constructor
+rule.pmd.AppendCharacterWithChar.name=Append Character With Char
+rule.pmd.GenericsNaming.name=Generics Naming
+rule.pmd.AvoidCatchingGenericException.name=Avoid Catching Generic Exception
+rule.pmd.AvoidLosingExceptionInformation.name=Avoid Losing Exception Information
+rule.pmd.AvoidLiteralsInIfCondition.name=Avoid Literals In If Condition
+rule.pmd.UseConcurrentHashMap.name=Use ConcurrentHashMap
+rule.pmd.DoNotHardCodeSDCard.name=Android - Do Not Hard Code SD Card
+rule.pmd.DontCallThreadRun.name=Dont Call Thread Run
+rule.pmd.GuardDebugLogging.name=Guard Debug Logging
+rule.pmd-unit-tests.JUnitStaticSuite.name=JUnit static suite
+rule.pmd-unit-tests.JUnitSpelling.name= JUnit spelling
+rule.pmd-unit-tests.JUnitAssertionsShouldIncludeMessage.name=JUnit assertions should include a message
+rule.pmd-unit-tests.JUnitTestsShouldIncludeAssert.name=JUnit tests should include an assert
+rule.pmd-unit-tests.TestClassWithoutTestCases.name=Test class without test cases (JUnit 3.x only)
+rule.pmd-unit-tests.UnnecessaryBooleanAssertion.name=Unnecessary boolean assertion
+rule.pmd-unit-tests.UseAssertEqualsInsteadOfAssertTrue.name=Use assertEquals instead of assertTrue
+rule.pmd-unit-tests.UseAssertSameInsteadOfAssertTrue.name=Use assertSame instead of assertTrue
+rule.pmd-unit-tests.UseAssertNullInsteadOfAssertTrue.name=Use assertNull instead of assertTrue
+rule.pmd-unit-tests.SimplifyBooleanAssertion.name=Simplify boolean assertion
--- /dev/null
+JUnit assertions should include a message - i.e., use the three argument version of assertEquals(), not the two argument version.
+<pre>
+public class Foo extends TestCase {
+ public void testSomething() {
+ assertEquals("foo", "bar"); // violation, should be assertEquals("Foo does not equals bar", "foo", "bar");
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Some JUnit framework methods are easy to misspell.
+<pre>
+import junit.framework.*;
+
+public class Foo extends TestCase {
+ public void setup() {} // violation, should be setUp()
+ public void TearDown() {} // violation, should be tearDown()
+}
+</pre>
\ No newline at end of file
--- /dev/null
+The suite() method in a JUnit test needs to be both public and static.
+<pre>
+import junit.framework.*;
+
+public class Foo extends TestCase {
+ public void suite() {} // violation, should be static
+ private static void suite() {} // violation, should be public
+}
+</pre>
\ No newline at end of file
--- /dev/null
+JUnit tests should include at least one assertion. This makes the tests more robust, and using assert with messages provide the developer a clearer idea of what the test does.
+<pre>
+public class Foo extends TestCase {
+ public void testSomething() {
+ Bar b = findBar();
+ b.work();
+ // violation, we could use assertNotNull("bar not found", b);
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Avoid negation in an assertTrue or assertFalse test. For example, rephrase: assertTrue(!expr); as: assertFalse(expr);
+<pre>
+public class SimpleTest extends TestCase {
+ public void testX() {
+ assertTrue("not empty", !r.isEmpty()); // violation, replace with assertFalse("not empty", r.isEmpty())
+ assertFalse(!r.isEmpty()); // violation, replace with assertTrue("empty", r.isEmpty())
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Test classes end with the suffix Test. Having a non-test class with that name is not a good practice, since most people will assume it is a test case. Test classes have test methods named testXXX.
+Beware: This rule doesn't support JUnit 4.x's @Test annotation.
+<pre>
+public class CarTest { // violation, consider changing the name of the class if it is not a test
+ // consider adding test methods if it is a test
+ public static void main(String[] args) {
+ // do something
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+A JUnit test assertion with a boolean literal is unnecessary since it always will eval to the same thing. Consider using flow control (in case of assertTrue(false) or similar) or simply removing statements like assertTrue(true) and assertFalse(false). If you just want a test to halt, use the fail method.
+<pre>
+public class SimpleTest extends TestCase {
+ public void testX() {
+ assertTrue(true); // violation
+ }
+}</pre>
\ No newline at end of file
--- /dev/null
+This rule detects JUnit assertions in object equality. These assertions should be made by more specific methods, like assertEquals.
+<pre>
+public class FooTest extends TestCase {
+ void testCode() {
+ Object a, b;
+
+ assertTrue(a.equals(b)); // violation
+ assertEquals("a should equals b", a, b); // good usage
+ }
+}</pre>
\ No newline at end of file
--- /dev/null
+This rule detects JUnit assertions in object references equality. These assertions should be made by more specific methods, like assertNull, assertNotNull.
+<pre>
+public class FooTest extends TestCase {
+ void testCode() {
+ Object a = doSomething();
+
+ assertTrue(a==null); // violation
+ assertNull(a); // good usage
+ assertTrue(a != null); // violation
+ assertNotNull(a); // good usage
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+This rule detects JUnit assertions in object references equality. These assertions should be made by more specific methods, like assertSame, assertNotSame.
+<pre>
+public class FooTest extends TestCase {
+ void testCode() {
+ Object a, b;
+
+ assertTrue(a==b); // violation
+ assertSame(a, b); // good usage
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+The abstract class does not contain any abstract methods. An abstract class suggests an incomplete implementation, which is to be completed by subclasses implementing the abstract methods. If the class is intended to be used as a base class only (not to be instantiated direcly) a protected constructor can be provided prevent direct instantiation.
\ No newline at end of file
--- /dev/null
+If the abstract class does not provides any methods, it may be just a data container that is not to be instantiated. In this case, it's probably better to use a private or a protected constructor in order to prevent instantiation than make the class misleadingly abstract. Example :
+<pre>
+public class abstract Example {
+ String field;
+ int otherField;
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Abstract classes should be named 'AbstractXXX'. Example :
+ <pre>
+public abstract class Foo { // should be AbstractFoo
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+Instantiation by way of private constructors from outside of the constructor's class often causes the generation of an accessor. A factory method, or non-privitization of the constructor can eliminate this situation. The generated class file is actually an interface. It gives the accessing class the ability to invoke a new hidden package scope constructor that takes the interface as a supplementary parameter. This turns a private constructor effectively into one with package scope, and is challenging to discern.
\ No newline at end of file
--- /dev/null
+Finds empty string literals which are being added. This is an inefficient way to convert any type to a String.
\ No newline at end of file
--- /dev/null
+Avoid concatenating characters as strings in StringBuffer.append.
\ No newline at end of file
--- /dev/null
+Constructors and methods receiving arrays should clone objects and store the copy. This prevents that future changes from the user affect the internal functionality.
\ No newline at end of file
--- /dev/null
+Avoid assignments in operands; this can make code more complicated and harder to read.
\ No newline at end of file
--- /dev/null
+Identifies a possible unsafe usage of a static field.
\ No newline at end of file
--- /dev/null
+Each class should declare at least one constructor.
\ No newline at end of file
--- /dev/null
+Methods such as getDeclaredConstructors(), getDeclaredConstructor(Class[]) and setAccessible(), as the interface PrivilegedAction, allow to alter, at runtime, the visilibilty of variable, classes, or methods, even if they are private. Obviously, no one should do so, as such behavior is against everything encapsulation principal stands for.
\ No newline at end of file
--- /dev/null
+Instead of copying data between two arrays, use System.arrayCopy method
\ No newline at end of file
--- /dev/null
+Finds all places 'assert' is used as an identifier is used.
\ No newline at end of file
--- /dev/null
+Object.finalize() is called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
\ No newline at end of file
--- /dev/null
+Avoid catching generic exceptions such as NullPointerException, RuntimeException, Exception in try-catch block.
--- /dev/null
+Code should never throw NPE under normal circumstances. A catch block may hide the original error, causing other more subtle errors in its wake.
\ No newline at end of file
--- /dev/null
+This is dangerous because it casts too wide a net; it can catch things like OutOfMemoryError.
\ No newline at end of file
--- /dev/null
+An interface should be used only to model a behaviour of a class: using an interface as a container of constants is a poor usage pattern.
\ No newline at end of file
--- /dev/null
+One might assume that new BigDecimal(.1) is exactly equal to .1, but it is actually equal to .1000000000000000055511151231257827021181583404541015625. This is so because .1 cannot be represented exactly as a double (or, for that matter, as a binary fraction of any finite length). Thus, the long value that is being passed in to the constructor is not exactly equal to .1, appearances notwithstanding. The (String) constructor, on the other hand, is perfectly predictable: 'new BigDecimal(.1)' is exactly equal to .1, as one would expect. Therefore, it is generally recommended that the (String) constructor be used in preference to this one.
\ No newline at end of file
--- /dev/null
+Deeply nested if..then statements are hard to read.
\ No newline at end of file
--- /dev/null
+Avoid using dollar signs in variable/method/class/interface names.
\ No newline at end of file
--- /dev/null
+Code containing duplicate String literals can usually be improved by declaring the String as a constant field. Example :
+<pre>
+public class Foo {
+ private void bar() {
+ buz("Howdy");
+ buz("Howdy");
+ buz("Howdy");
+ buz("Howdy");
+ }
+ private void buz(String x) {}
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Finds all places 'enum' is used as an identifier is used.
\ No newline at end of file
--- /dev/null
+It is somewhat confusing to have a field name with the same name as a method. While this is totally legal, having information (field) and actions (method) is not clear naming. Example :
+<pre>
+public class Foo {
+ Object bar;
+ // bar is data or an action or both?
+ void bar() {
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+It is somewhat confusing to have a field name matching the declaring class name. This probably means that type and or field names could be more precise. Example :
+<pre>
+public class Foo extends Bar {
+ // There's probably a better name for foo
+ int foo;
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Avoid using final local variables, turn them into fields. Example :
+<pre>
+public class MyClass {
+ public void foo() {
+ final String finalLocalVariable;
+ }
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+Each caught exception type should be handled in its own catch clause.
\ No newline at end of file
--- /dev/null
+Detects when a new object is created inside a loop
\ No newline at end of file
--- /dev/null
+Avoid using hard coded literals in conditional statements, declare those as static variables or private members.
--- /dev/null
+Statements in a catch block that invoke accessors on the exception without using the information only add to code size. Either remove the invocation, or use the return result.
--- /dev/null
+Using multiple unary operators may be a bug, and/or is confusing. Check the usage is not a bug, or consider simplifying the expression. Example :
+<pre>
+// These are typo bugs, or at best needlessly complex and confusing:
+int i = - -1;
+int j = + - +1;
+int z = ~~2;
+boolean b = !!true;
+boolean c = !!!true;
+
+// These are better:
+int i = 1;
+int j = -1;
+int z = 2;
+boolean b = true;
+boolean c = false;
+
+// And these just make your brain hurt:
+int i = ~-2;
+int j = -~7;
+</pre>
\ No newline at end of file
--- /dev/null
+Avoid printStackTrace(); use a logger call instead.
\ No newline at end of file
--- /dev/null
+Do not use protected fields in final classes since they cannot be subclassed. Clarify your intent by using private or package access modifiers instead.
\ No newline at end of file
--- /dev/null
+Reassigning values to parameters is a questionable practice. Use a temporary local variable instead.
\ No newline at end of file
--- /dev/null
+Catch blocks that merely rethrow a caught exception only add to code size and runtime complexity.
\ No newline at end of file
--- /dev/null
+StringBuffers can grow quite a lot, and so may become a source of memory leak (if the owning class has a long life time). Example :
+<pre>
+class Foo {
+ private StringBuffer memoryLeak;
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Method level synchronization can backfire when new code is added to the method. Block-level synchronization helps to ensure that only the code that needs synchronization gets it.
\ No newline at end of file
--- /dev/null
+Avoid using ThreadGroup; although it is intended to be used in a threaded environment it contains methods that are not thread safe.
\ No newline at end of file
--- /dev/null
+Catch blocks that merely rethrow a caught exception wrapped inside a new instance of the same type only add to code size and runtime complexity. Example :
+<pre>
+public class Foo {
+ void bar() {
+ try {
+ // do something
+ } catch (SomeException se) {
+ // harmless comment
+ throw new SomeException(se);
+ }
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Avoid throwing a NullPointerException - it's confusing because most people will assume that the virtual machine threw it. Consider using an IllegalArgumentException instead; this will be clearly seen as a programmer-initiated exception.
\ No newline at end of file
--- /dev/null
+Avoid throwing certain exception types. Rather than throw a raw RuntimeException, Throwable, Exception, or Error, use a subclassed exception or error instead.
\ No newline at end of file
--- /dev/null
+An application with hard coded IP may become impossible to deploy in some case. It never hurts to externalize IP adresses.
\ No newline at end of file
--- /dev/null
+As JVM and Java language offer already many help in creating application, it should be very rare to have to rely on non-java code. Even though, it is rare to actually have to use Java Native Interface (JNI). As the use of JNI make application less portable, and harder to maintain, it is not recommended.
\ No newline at end of file
--- /dev/null
+Integer literals should not start with zero. Zero means that the rest of literal will be interpreted as an octal value.
\ No newline at end of file
--- /dev/null
+Java uses the short type to reduce memory usage, not to optimize calculation. On the contrary, the jvm does not has an arithmetic capabilities with the type short. So, the P-code must convert the short into int, then do the proper caculation and then again, convert int to short. So, use of the "short" type may have a great effect on memory usage.
\ No newline at end of file
--- /dev/null
+Use of the keyword "volatile" is general used to fine tune a Java application, and therefore, requires a good expertise of the Java Memory Model. Morover, its range of action is somewhat misknown. Therefore, the volatile keyword should not be used for maintenance purpose and portability.
\ No newline at end of file
--- /dev/null
+Avoid equality comparisons with Double.NaN - these are likely to be logic errors.
\ No newline at end of file
--- /dev/null
+If a class is a bean, or is referenced by a bean directly or indirectly it needs to be serializable. Member variables need to be marked as transient, static, or have accessor methods in the class. Marking variables as transient is the safest and easiest modification. Accessor methods should follow the Java naming conventions, i.e.if you have a variable foo, you should provide getFoo and setFoo methods.
\ No newline at end of file
--- /dev/null
+Don't create instances of already existing BigInteger (BigInteger.ZERO, BigInteger.ONE) and for 1.5 on, BigInteger.TEN and BigDecimal (BigDecimal.ZERO, BigDecimal.ONE, BigDecimal.TEN)
\ No newline at end of file
--- /dev/null
+Looks for methods named "getX()" with "boolean" as the return type. The convention is to name these methods "isX()".
\ No newline at end of file
--- /dev/null
+Avoid instantiating Boolean objects; you can reference Boolean.TRUE, Boolean.FALSE, or call Boolean.valueOf() instead.
\ No newline at end of file
--- /dev/null
+Use bitwise inversion to invert boolean values - it's the fastest way to do this. See http://www.javaspecialists.co.za/archive/newsletter.do?issue=042&locale=en_US for specific details
\ No newline at end of file
--- /dev/null
+The null check is broken since it will throw a Nullpointer itself. The reason is that a method is called on the object when it is null. It is likely that you used || instead of && or vice versa.
\ No newline at end of file
--- /dev/null
+In JDK 1.5, calling new Byte() causes memory allocation. Byte.valueOf() is more memory friendly. Example :
+<pre>
+public class Foo {
+private Byte i = new Byte(0); // change to Byte i =
+Byte.valueOf(0);
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Super should be called at the start of the method. Example :
+<pre>
+public class DummyActivity extends Activity {
+ public void onCreate(Bundle bundle) {
+ // missing call to super.onCreate(bundle)
+ foo();
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+It is a good practice to call super() in a constructor. If super() is not called but another constructor (such as an overloaded constructor) is called, this rule will not report it.
\ No newline at end of file
--- /dev/null
+Super should be called at the end of the method. Example :
+<pre>
+public class DummyActivity extends Activity {
+ public void onPause() {
+ foo();
+ // missing call to super.onPause()
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Always check the return of one of the navigation method (next,previous,first,last) of a ResultSet. Indeed, if the value return is "false", the developer should deal with it !
\ No newline at end of file
--- /dev/null
+if you need to get an array of a class from your Collection, you should pass an array of the desidered class as the parameter of the toArray method. Otherwise you will get a ClassCastException.
\ No newline at end of file
--- /dev/null
+Class names should always begin with an upper case character.
\ No newline at end of file
--- /dev/null
+A class with only private constructors should be final, unless the private constructor is called by a inner class. Example :
+ <pre>
+public class Foo { //Should be final
+ private Foo() { }
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+The method clone() should only be implemented if the class implements the Cloneable interface with the exception of a final method that only throws CloneNotSupportedException. This version uses PMD's type resolution facilities, and can detect if the class implements or extends a Cloneable class
\ No newline at end of file
--- /dev/null
+The method clone() should throw a CloneNotSupportedException.
\ No newline at end of file
--- /dev/null
+Ensure that resources (like Connection, Statement, and ResultSet objects) are always closed after use. It does this by looking for code patterned like :
+<pre>
+Connection c = openConnection();
+try {
+ // do stuff, and maybe catch something
+} finally {
+ c.close();
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Sometimes two 'if' statements can be consolidated by separating their conditions with a boolean short-circuit operator.
\ No newline at end of file
--- /dev/null
+Use equals() to compare object references; avoid comparing them with ==.
\ No newline at end of file
--- /dev/null
+In an if expression with an else clause, avoid negation in the test. For example, rephrase: if (x != y) diff(); else same(); as: if (x == y) same(); else diff(); Most if (x != y) cases without an else are often return cases, so consistent use of this rule makes the code easier to read. Also, this resolves trivial ordering problems, such as does the error case go first? or does the common case go first?.
\ No newline at end of file
--- /dev/null
+Consecutively calling StringBuffer.append with String literals
\ No newline at end of file
--- /dev/null
+Calling overridable methods during construction poses a risk of invoking methods on an incompletely constructed object
+ and can be difficult to discern. It may leave the sub-class unable to construct its superclass or forced to replicate
+ the construction process completely within itself, losing the ability to call super().
+ If the default constructor contains a call to an overridable method, the subclass may be completely uninstantiable.
+ Note that this includes method calls throughout the control flow graph - i.e., if a constructor Foo() calls
+ a private method bar() that calls a public method buz(), this denotes a problem.
+ <br/>Example :
+<pre>
+public class SeniorClass {
+ public SeniorClass(){
+ toString(); //may throw NullPointerException if overridden
+ }
+ public String toString(){
+ return "IAmSeniorClass";
+ }
+}
+public class JuniorClass extends SeniorClass {
+ private String name;
+ public JuniorClass(){
+ super(); //Automatic call leads to NullPointerException
+ name = "JuniorClass";
+ }
+ public String toString(){
+ return name.toUpperCase();
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+This rule counts unique attributes, local variables and return types within an object. A number higher than specified threshold can indicate a high degree of coupling.
\ No newline at end of file
--- /dev/null
+Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.
\ No newline at end of file
--- /dev/null
+The dataflow analysis tracks local definitions, undefinitions and references to variables on different paths on the data flow. From those informations there can be found various problems. 1. UR - Anomaly: There is a reference to a variable that was not defined before. This is a bug and leads to an error. 2. DU - Anomaly: A recently defined variable is undefined. These anomalies may appear in normal source text. 3. DD - Anomaly: A recently defined variable is redefined. This is ominous but don't have to be a bug.
\ No newline at end of file
--- /dev/null
+Switch statements should have a default label. Example :
+ <pre>
+public class Foo {
+ void bar(int a) {
+ switch (a) {
+ case 1: // do something
+ break;
+ default: // the default case should be last, by convention
+ break;
+ case 2:
+ break;
+ }
+ }
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+Use explicit scoping instead of the default package private level.
\ No newline at end of file
--- /dev/null
+Calls to System.gc(), Runtime.getRuntime().gc(), and System.runFinalization() are not advised. Code should have the same behavior whether the garbage collection is disabled using the option -Xdisableexplicitgc or not. Moreover, "modern" jvms do a very good job handling garbage collections. If memory usage issues unrelated to memory leaks develop within an application, it should be dealt with JVM options rather than within the code itself. Example :
+<pre>
+ public class GCCall
+{
+ public GCCall()
+ {
+ // Explicit gc call !
+ System.gc();
+ }
+ public void doSomething()
+ {
+ // Explicit gc call !
+ Runtime.getRuntime().gc();
+ }
+
+ public explicitGCcall() { // Explicit gc call ! System.gc(); }
+
+ public void doSomething() { // Explicit gc call ! Runtime.getRuntime().gc(); }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Web applications should not call System.exit(), since only the web container or the application server should stop the JVM.
\ No newline at end of file
--- /dev/null
+Errors are system exceptions. Do not extend them.
\ No newline at end of file
--- /dev/null
+Use Environment.getExternalStorageDirectory() instead of "/sdcard".
--- /dev/null
+Throwing exception in a finally block is confusing. It may mask exception or a defect of the code, it also render code cleanup uninstable. Example :
+<pre>
+public class Foo
+{
+ public void bar()
+ {
+ try {
+ // Here do some stuff
+ }
+ catch( Exception e) {
+ // Handling the issue
+ }
+ finally
+ {
+ // is this really a good idea ?
+ throw new Exception();
+ }
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+The J2EE specification explicitly forbid use of threads.
\ No newline at end of file
--- /dev/null
+Explicitly calling Thread.run() method will execute in the caller's thread of control. Instead, call Thread.start() for the intended behavior.
--- /dev/null
+Avoid importing anything from the package 'java.lang'. These classes are automatically imported (JLS 7.5.3).
\ No newline at end of file
--- /dev/null
+Avoid importing anything from the 'sun.*' packages. These packages are not portable and are likely to change.
\ No newline at end of file
--- /dev/null
+Do not nest JSF component custom actions inside a custom action that iterates over its body.
\ No newline at end of file
--- /dev/null
+Partially created objects can be returned by the Double Checked Locking pattern when used in Java. An optimizing JRE may assign a reference to the baz variable before it creates the object the reference is intended to point to. <a href="http://www.javaworld.com/javaworld/jw-02-2001/jw-0209-double.html">More details</a>. Example :
+<pre>
+public class Foo {
+ Object baz;
+ Object bar() {
+ if(baz == null) { //baz may be non-null yet not fully created
+ synchronized(this){
+ if(baz == null){
+ baz = new Object();
+ }
+ }
+ }
+ return baz;
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Avoid duplicate import statements.
\ No newline at end of file
--- /dev/null
+Empty Catch Block finds instances where an exception is caught, but nothing is done. In most circumstances, this swallows an exception which should either be acted on or reported.
\ No newline at end of file
--- /dev/null
+If the finalize() method is empty, then it does not need to exist.
\ No newline at end of file
--- /dev/null
+Avoid empty finally blocks - these can be deleted.
\ No newline at end of file
--- /dev/null
+Empty If Statement finds instances where a condition is checked but nothing is done about it.
\ No newline at end of file
--- /dev/null
+An empty initializer was found. Example :
+<pre>
+public class Foo {
+
+ static {} // Why ?
+
+ {} // Again, why ?
+
+}
+</pre>
\ No newline at end of file
--- /dev/null
+An empty method in an abstract class should be abstract instead, as developer may rely on this empty implementation rather than code the appropriate one.
+ <pre>
+public abstract class ShouldBeAbstract
+{
+ public Object couldBeAbstract()
+ {
+ // Should be abstract method ?
+ return null;
+ }
+
+ public void couldBeAbstract()
+ {
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+An empty statement (aka a semicolon by itself) that is not used as the sole body of a for loop or while loop is probably a bug. It could also be a double semicolon, which is useless and should be removed.
\ No newline at end of file
--- /dev/null
+An empty static initializer was found.
\ No newline at end of file
--- /dev/null
+Avoid empty switch statements.
\ No newline at end of file
--- /dev/null
+Avoid empty synchronized blocks - they're useless.
\ No newline at end of file
--- /dev/null
+Avoid empty try blocks - what's the point?
\ No newline at end of file
--- /dev/null
+Empty While Statement finds all instances where a while statement does nothing. If it is a timing loop, then you should use Thread.sleep() for it; if it's a while loop that does a lot in the exit expression, rewrite it to make it clearer.
\ No newline at end of file
--- /dev/null
+Inexperienced programmers sometimes confuse comparison concepts and use equals() to compare to null.
\ No newline at end of file
--- /dev/null
+Using Exceptions as flow control leads to GOTOish code and obscures true exceptions when debugging.
\ No newline at end of file
--- /dev/null
+Long Class files are indications that the class may be trying to do too much. Try to break it down, and reduce the size to something manageable.
\ No newline at end of file
--- /dev/null
+A high number of imports can indicate a high degree of coupling within an object. Rule counts the number of unique imports and reports a violation if the count is above the user defined threshold.
\ No newline at end of file
--- /dev/null
+Violations of this rule usually indicate that the method is doing too much. Try to reduce the method size by creating helper methods and removing any copy/pasted code.
\ No newline at end of file
--- /dev/null
+Long parameter lists can indicate that a new object should be created to wrap the numerous parameters. Basically, try to group the parameters together.
\ No newline at end of file
--- /dev/null
+A large number of public methods and attributes declared in a class can indicate the class may need to be broken up as increased effort will be required to thoroughly test it.
\ No newline at end of file
--- /dev/null
+If a final field is assigned to a compile-time constant, it could be made static, thus saving overhead in each object at runtime.
\ No newline at end of file
--- /dev/null
+If the finalize() is implemented, its last action should be to call super.finalize.
\ No newline at end of file
--- /dev/null
+If the finalize() is implemented, it should do something besides just calling super.finalize().
\ No newline at end of file
--- /dev/null
+Methods named finalize() should not have parameters. It is confusing and probably a bug to overload finalize(). It will not be called by the VM.
\ No newline at end of file
--- /dev/null
+If you override finalize(), make it protected. If you make it public, other classes may call it.
\ No newline at end of file
--- /dev/null
+Some for loops can be simplified to while loops - this makes them more concise.
\ No newline at end of file
--- /dev/null
+Avoid using 'for' statements without using curly braces, like <code>for (int i=0; i<42;i++) foo();</code>
\ No newline at end of file
--- /dev/null
+Generics names should be a one letter long and upper case.
--- /dev/null
+When log messages are composed by concatenating strings, the whole section should be guarded by a isDebugEnabled() check to avoid performance and memory issues.
--- /dev/null
+Avoid idempotent operations - they are have no effect. Example : <br/><code>int x = 2;<br/> x = x;</code>
\ No newline at end of file
--- /dev/null
+Avoid using if..else statements without using curly braces.
\ No newline at end of file
--- /dev/null
+Avoid using if statements without using curly braces.
\ No newline at end of file
--- /dev/null
+Identifies private fields whose values never change once they are initialized either in the declaration of the field or by a constructor. This aids in converting existing classes to immutable classes.
\ No newline at end of file
--- /dev/null
+No need to import a type that lives in the same package.
\ No newline at end of file
--- /dev/null
+String.trim().length() is an inefficient way to check if a String is really empty, as it creates a new String object just to check its size. Consider creating a static function that loops through a string, checking Character.isWhitespace() on each character and returning false if a non-whitespace character is found.
\ No newline at end of file
--- /dev/null
+Avoid concatenating non literals in a StringBuffer constructor or append().
\ No newline at end of file
--- /dev/null
+Avoid instantiating an object just to call getClass() on it; use the .class public member instead. Example : replace <code>Class c = new String().getClass();</code> with <code>Class c = String.class;</code>
\ No newline at end of file
--- /dev/null
+Failing to pre-size a StringBuffer properly could cause it to re-size many times during runtime. This rule checks the characters that are actually passed into StringBuffer.append(), but represents a best guess worst case scenario. An empty StringBuffer constructor initializes the object to 16 characters. This default is assumed if the length of the constructor can not be determined.
\ No newline at end of file
--- /dev/null
+In JDK 1.5, calling new Integer() causes memory allocation. Integer.valueOf() is more memory friendly.
\ No newline at end of file
--- /dev/null
+Avoid jumbled loop incrementers - it's usually a mistake, and it's confusing even if it's what's intended.
+ <br>Example :
+ <pre>
+public class JumbledIncrementerRule1 {
+ public void foo() {
+ for (int i = 0; i < 10; i++) {
+ for (int k = 0; k < 20; i++) {
+ System.out.println("Hello");
+ }
+ }
+ }
+}</pre>
\ No newline at end of file
--- /dev/null
+The Local Home interface of a Session EJB should be suffixed by "LocalHome".
\ No newline at end of file
--- /dev/null
+The Local Interface of a Session EJB should be suffixed by "Local".
\ No newline at end of file
--- /dev/null
+A local variable assigned only once can be declared final. Example :
+ <pre>
+public class Bar {
+ public void foo () {
+ String a = "a"; //if a will not be assigned again it is better to do this:
+ final String b = "b";
+ }
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+In most cases, the Logger can be declared static and final.
\ No newline at end of file
--- /dev/null
+In JDK 1.5, calling new Long() causes memory allocation. Long.valueOf() is more memory friendly. Example :
+ <pre>
+public class Foo {
+private Long i = new Long(0); // change to Long i =
+Long.valueOf(0);
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+Detects when a field, formal or local variable is declared with a long name.
\ No newline at end of file
--- /dev/null
+Avoid using implementation types (i.e., HashSet); use the interface (i.e, Set) instead
\ No newline at end of file
--- /dev/null
+The EJB Specification state that any MessageDrivenBean or SessionBean should be suffixed by Bean.
\ No newline at end of file
--- /dev/null
+A method argument that is never assigned can be declared final.
\ No newline at end of file
--- /dev/null
+Method names should always begin with a lower case character, and should not contain underscores. Example :
+<pre>
+public class Foo {
+ public void fooStuff() {
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Exposing internal arrays directly allows the user to modify some code that could be critical. It is safer to return a copy of the array.
\ No newline at end of file
--- /dev/null
+Non-constructor methods should not have the same name as the enclosing class. Example :
+<pre>
+public class MyClass {
+ // this is bad because it is a method
+ public void MyClass() {}
+ // this is OK because it is a constructor
+ public MyClass() {}
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Detects when a non-field has a name starting with 'm_'. This usually indicates a field and thus is confusing. Example :
+<pre>
+public class Foo {
+ private int m_foo; // OK
+ public void bar(String m_baz) { // Bad
+ int m_boz = 42; // Bad
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+The null check here is misplaced. if the variable is null you'll get a NullPointerException.
+ Either the check is useless (the variable will never be null) or it's incorrect.
+ <br>Example :
+ <pre>
+if (object1!=null && object2.equals(object1)) {
+ ...
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+A switch statement without an enclosed break statement may be a bug.
\ No newline at end of file
--- /dev/null
+Classes that are serializable should provide a serialVersionUID field.
\ No newline at end of file
--- /dev/null
+A class that has private constructors and does not have any static methods or fields cannot be used.
\ No newline at end of file
--- /dev/null
+Normally only one logger is used in each class.
\ No newline at end of file
--- /dev/null
+The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity. Example :
+<pre>
+public class Foo {
+ void bar() {
+ // lots of complicated code
+ }
+ }
+</pre>
\ No newline at end of file
--- /dev/null
+This rule uses the NCSS (Non Commenting Source Statements) algorithm to determine the number of lines of code for a given constructor. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one.
\ No newline at end of file
--- /dev/null
+This rule uses the NCSS (Non Commenting Source Statements) algorithm to determine the number of lines of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one.
\ No newline at end of file
--- /dev/null
+This rule uses the NCSS (Non Commenting Source Statements) algorithm to determine the number of lines of code for a given type. NCSS ignores comments, and counts actual statements. Using this algorithm, lines of code that are split are counted as one.
\ No newline at end of file
--- /dev/null
+Detects when a class or interface does not have a package definition. Example :
+ <pre>
+// no package declaration
+public class ClassInDefaultPackage {
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+A non-case label (e.g. a named break/continue label) was present in a switch statement. This legal, but confusing. It is easy to mix up the case labels and the non-case labels.
\ No newline at end of file
--- /dev/null
+A nonstatic initializer block will be called any time a constructor is invoked (just prior to invoking the constructor). While this is a valid language construct, it is rarely used and is confusing. Example :<br/><code>public class MyClass {<br/>// this block gets run before any call to a constructor {<br/>System.out.println("I am about to construct myself");<br/>}<br/>}</code>
\ No newline at end of file
--- /dev/null
+Non-thread safe singletons can result in bad state changes. Eliminate static singletons if possible by instantiating the object directly. Static singletons are usually not needed as only a single instance exists anyway. Other possible fixes are to synchronize the entire method or to use an initialize-on-demand holder class (do not use the double-check idiom). See Effective Java, item 48.
\ No newline at end of file
--- /dev/null
+Assigning a null to a variable (outside of its declaration) is usually bad form. Some times, the assignment is an indication that the programmer doesn't completely understand what is going on in the code. NOTE: This sort of assignment may in rare cases be useful to encourage garbage collection. If that's what you're using it for, by all means, disregard this rule :-)
\ No newline at end of file
--- /dev/null
+A method should have only one exit point, and that should be the last statement in the method.
\ No newline at end of file
--- /dev/null
+A call to Collection.toArray can use the Collection's size vs an empty Array of the desired type.
\ No newline at end of file
--- /dev/null
+Override both public boolean Object.equals(Object other), and public int Object.hashCode(), or override neither. Even if you are inheriting a hashCode() from a parent class, consider implementing hashCode and explicitly delegating to your superclass. Example :
+<pre>
+// this is bad
+public class Bar {
+ public boolean equals(Object o) {
+ // do some comparison
+ }
+}
+
+// and so is this
+public class Baz {
+ public int hashCode() {
+ // return some hash value
+ }
+}
+
+// this is OK
+public class Foo {
+ public boolean equals(Object other) {
+ // do some comparison
+ }
+ public int hashCode() {
+ // return some hash value
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Detects when a package definition contains upper case characters. Example :
+<pre>
+package com.MyCompany; // <- should be lower case name
+public class SomeClass {
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Position literals first in String comparisons - that way if the String is null you won't get a NullPointerException, it'll just return false.
\ No newline at end of file
--- /dev/null
+Throwing a new exception from a catch block without passing the original exception into the new Exception will cause the true stack trace to be lost, and can make it difficult to debug effectively.
\ No newline at end of file
--- /dev/null
+Object clone() should be implemented with super.clone(). Example :
+ <pre>
+class Foo{
+ public Object clone(){
+ return new Foo(); // This is bad
+ }
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+Logger should normally be defined private static final and have the correct class. Private final Log log; is also allowed for rare cases when loggers need to be passed around, but the logger needs to be passed into the constructor.
\ No newline at end of file
--- /dev/null
+Log.d calls should be protected by checking Config.LOGD first. Example :
+<pre>
+public class DummyActivity extends Activity {
+ public void foo() {
+ Log.d("TAG", "msg1"); // Bad
+
+ bar();
+
+ if (Config.LOGD) Log.d("TAG", "msg1"); // Good
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Log.v calls should be protected by checking Config.LOGV first. Example :
+<pre>
+public class DummyActivity extends Activity {
+ public void foo() {
+ Log.v("TAG", "msg1"); // Bad
+ bar();
+ if (Config.LOGV) Log.v("TAG", "msg1"); // Good
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Remote Interface of a Session EJB should NOT be suffixed.
\ No newline at end of file
--- /dev/null
+Remote Home interface of a Session EJB should be suffixed by "Home".
\ No newline at end of file
--- /dev/null
+Consider replacing this Enumeration with the newer java.util.Iterator
\ No newline at end of file
--- /dev/null
+Consider replacing this Hashtable with the newer java.util.Map
\ No newline at end of file
--- /dev/null
+Consider replacing Vector usages with the newer java.util.ArrayList if expensive threadsafe operation is not required.
\ No newline at end of file
--- /dev/null
+For any method that returns an array, it's a better behavior to return an empty array rather than a null reference. Example :
+<pre>
+public class Example
+{
+ // Not a good idea...
+ public int []badBehavior()
+ {
+ // ...
+ return null;
+ }
+
+ // Good behavior
+ public String[] bonnePratique()
+ {
+ //...
+ return new String[0];
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Avoid returning from a finally block - this can discard exceptions.
\ No newline at end of file
--- /dev/null
+In JDK 1.5, calling new Short() causes memory allocation. Short.valueOf() is more memory friendly. Example :
+ <pre>
+public class Foo {
+private Short i = new Short(0); // change to Short i =
+Short.valueOf(0);
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+Detects when very short method names are used. Example :
+<pre>
+public class ShortMethod {
+ public void a( int i ) { // Violation
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Detects when a field, local, or parameter has a very short name.
\ No newline at end of file
--- /dev/null
+It is unclear which exceptions that can be thrown from the methods. It might be difficult to document and understand the vague interfaces. Use either a class derived from RuntimeException or a checked exception.
\ No newline at end of file
--- /dev/null
+Be sure to specify a Locale when creating a new instance of SimpleDateFormat.
\ No newline at end of file
--- /dev/null
+Avoid unnecessary comparisons in boolean expressions - this complicates simple code. Example :
+<pre>
+public class Bar {
+ // can be simplified to
+ // bar = isFoo();
+ private boolean bar = (isFoo() == true);
+
+ public isFoo() { return false;}
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Avoid unnecessary if..then..else statements when returning a boolean. Example :
+<pre>
+public class Foo {
+ private int bar =2;
+ public boolean isBarEqualsTo(int x) {
+ // this bit of code
+ if (bar == x) {
+ return true;
+ } else {
+ return false;
+ }
+ // can be replaced with a simple
+ // return bar == x;
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+No need to check for null before an instanceof; the instanceof keyword returns false when given a null argument.
\ No newline at end of file
--- /dev/null
+Since it passes in a literal of length 1, this call to String.startsWith can be rewritten using String.charAt(0) to save some time.
\ No newline at end of file
--- /dev/null
+A field that's only used by one method could perhaps be replaced by a local variable.
\ No newline at end of file
--- /dev/null
+According to the J2EE specification (p.494), an EJB should not have any static fields with write access. However, static read only fields are allowed. This ensures proper behavior especially when instances are distributed by the container on several JREs.
\ No newline at end of file
--- /dev/null
+StringBuffer sb = new StringBuffer('c'); The char will be converted into int to intialize StringBuffer size.
\ No newline at end of file
--- /dev/null
+Avoid instantiating String objects; this is usually unnecessary.
\ No newline at end of file
--- /dev/null
+Avoid calling toString() on String objects; this is unnecessary.
\ No newline at end of file
--- /dev/null
+A field name is all in uppercase characters, which in Sun's Java naming conventions indicate a constant. However, the field is not final. Example :
+<pre>
+public class Foo {
+ // this is bad, since someone could accidentally
+ // do PI = 2.71828; which is actualy e
+ // final double PI = 3.16; is ok
+ double PI = 3.16;
+}
+</pre>
\ No newline at end of file
--- /dev/null
+The method name and parameter number are suspiciously close to equals(Object), which may mean you are intending to override the equals(Object) method. Example :
+<pre>
+public class Foo {
+ public int equals(Object o) {
+ // oops, this probably was supposed to be boolean equals
+ }
+ public boolean equals(String s) {
+ // oops, this probably was supposed to be equals(Object)
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+The method name and return type are suspiciously close to hashCode(), which may mean you are intending to override the hashCode() method. Example :
+<pre>
+public class Foo {
+ public int hashcode() {
+ // oops, this probably was supposed to be hashCode
+ }
+}</pre>
\ No newline at end of file
--- /dev/null
+A suspicious octal escape sequence was found inside a String literal. The Java language specification (section 3.10.6) says an octal escape sequence inside a literal String shall consist of a backslash followed by: OctalDigit | OctalDigit OctalDigit | ZeroToThree OctalDigit OctalDigit Any octal escape sequence followed by non-octal digits can be confusing, e.g. "\038" is interpreted as the octal escape sequence "\03" followed by the literal character 8.
\ No newline at end of file
--- /dev/null
+A high ratio of statements to labels in a switch statement implies that the switch statement is doing too much work. Consider moving the statements into new methods, or creating subclasses based on the switch variable.
\ No newline at end of file
--- /dev/null
+Switch statements should have a default label. Example :
+<pre>
+public class Foo {
+ public void bar() {
+ int x = 2;
+ switch (x) {
+ case 2: int j = 8;
+ }
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+System.(out|err).print is used, consider using a logger.
\ No newline at end of file
--- /dev/null
+Swith are designed complex branches, and allow branches to share treatement. Using a switch for only a few branches is ill advised, as switches are not as easy to understand as if. In this case, it's most likely is a good idea to use a if statement instead, at least to increase code readability. Example :
+<pre>
+// With a minimumNumberCaseForASwitch of 3
+public class Foo {
+ public void bar() {
+ switch (condition) {
+ case ONE:
+ instruction;
+ break;
+ default:
+ break; // not enough for a 'switch' stmt,
+ // a simple 'if' stmt would have been more appropriate
+ }
+ }
+}
+</pre>
\ No newline at end of file
--- /dev/null
+Classes that have too many fields could be redesigned to have fewer fields, possibly through some nested object grouping of some of the information. For example, a class with city/state/zip fields could instead have one Address field.
\ No newline at end of file
--- /dev/null
+A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.
\ No newline at end of file
--- /dev/null
+If you overuse the static import feature, it can make your program unreadable and unmaintainable, polluting its namespace with all the static members you import. Readers of your code (including you, a few months after you wrote it) will not know which class a static member comes from (Sun 1.5 Language Guide).
\ No newline at end of file
--- /dev/null
+Uncommented Empty Constructor finds instances where a constructor does not contain statements, but there is no comment. By explicitly commenting empty constructors it is easier to distinguish between intentional (commented) and unintentional empty constructors.
\ No newline at end of file
--- /dev/null
+Uncommented Empty Method finds instances where a method does not contain statements, but there is no comment. By explicitly commenting empty methods it is easier to distinguish between intentional (commented) and unintentional empty methods.
\ No newline at end of file
--- /dev/null
+Do not use if statements that are always true or always false.
\ No newline at end of file
--- /dev/null
+Using equalsIgnoreCase() is faster than using toUpperCase/toLowerCase().equals()
\ No newline at end of file
--- /dev/null
+This rule detects when a constructor is not necessary; i.e., when there's only one constructor, it's public, has an empty body, and takes no arguments.
\ No newline at end of file
--- /dev/null
+Avoid unnecessary temporaries when converting primitives to Strings
\ No newline at end of file
--- /dev/null
+When a class has the final modifier, all the methods are automatically final.
\ No newline at end of file
--- /dev/null
+Avoid unnecessarily creating local variables
\ No newline at end of file
--- /dev/null
+Sometimes expressions are wrapped in unnecessary parentheses, making them look like a function call. Example :
+<pre>
+public class Foo {
+ boolean bar() {
+ return (true);
+ }
+}
+ </pre>
\ No newline at end of file
--- /dev/null
+Avoid unnecessary return statements
\ No newline at end of file
--- /dev/null
+Parsing method should be called directy instead.
\ No newline at end of file
--- /dev/null
+SimpleDateFormat is not synchronized. Sun recomends separate format instances for each thread. If multiple threads must access a static formatter, the formatter must be synchronized either on method or block level.
\ No newline at end of file
--- /dev/null
+Avoid passing parameters to methods or constructors and then not using those parameters.
\ No newline at end of file
--- /dev/null
+Avoid unused import statements. Example :
+ <pre>
+// this is bad
+import java.io.File;
+public class Foo {}
+ </pre>
\ No newline at end of file
--- /dev/null
+Detects when a local variable is declared and/or assigned, but not used.
\ No newline at end of file
--- /dev/null
+Fields in interfaces are automatically public static final, and methods are public abstract. Classes or interfaces nested in an interface are automatically public and static (all nested interfaces are automatically static). For historical reasons, modifiers which are implied by the context are accepted by the compiler, but are superfluous.
\ No newline at end of file
--- /dev/null
+After checking an object reference for null, you should invoke equals() on that object rather than passing it to another object's equals() method.
\ No newline at end of file
--- /dev/null
+Detects when a private field is declared and/or assigned a value, but not used.
\ No newline at end of file
--- /dev/null
+Unused Private Method detects when a private method is declared but is unused. This PMD rule should be switched off and replaced by its equivalent from Squid that is more effective : it generates less false-positives and detects more dead code.
\ No newline at end of file
--- /dev/null
+ArrayList is a much better Collection implementation than Vector.
\ No newline at end of file
--- /dev/null
+The class java.util.Arrays has a asList method that should be use when you want to create a new List from an array of objects. It is faster than executing a loop to cpy all the elements of the array one by one
\ No newline at end of file
--- /dev/null
+The isEmpty() method on java.util.Collection is provided to see if a collection has any elements. Comparing the value of size() to 0 merely duplicates existing behavior.
\ No newline at end of file
--- /dev/null
+Since Java5 brought a new implementation of the Map interface, specially designed for concurrent application.
--- /dev/null
+To make sure the full stacktrace is printed out, use the logging statement with 2 arguments: a String and a Throwable.
\ No newline at end of file
--- /dev/null
+Using "==" or "!=" to compare strings only works if intern version is used on both sides.
\ No newline at end of file
--- /dev/null
+Use String.indexOf(char) when checking for the index of a single character; it executes faster.
\ No newline at end of file
--- /dev/null
+When doing a String.toLowerCase()/toUpperCase() call, use a Locale. This avoids problems with certain locales, i.e. Turkish.
\ No newline at end of file
--- /dev/null
+Thread.notify() awakens a thread monitoring the object. If more than one thread is monitoring, then only one is chosen. The thread chosen is arbitrary; thus it's usually safer to call notifyAll() instead.
\ No newline at end of file
--- /dev/null
+In J2EE getClassLoader() might not work as expected. Use Thread.currentThread().getContextClassLoader() instead.
\ No newline at end of file
--- /dev/null
+If you have a class that has nothing but static methods, consider making it a Singleton. Note that this doesn't apply to abstract classes, since their subclasses may well include non-static methods. Also, if you want this class to be a Singleton, remember to add a private constructor to prevent instantiation.
\ No newline at end of file
--- /dev/null
+Finds usages of += for appending strings.
\ No newline at end of file
--- /dev/null
+Use StringBuffer.length() to determine StringBuffer length rather than using StringBuffer.toString().equals() or StringBuffer.toString().length() ==.
\ No newline at end of file
--- /dev/null
+An operation on an Immutable object (BigDecimal or BigInteger) won't change the object itself. The result of the operation is a new object. Therefore, ignoring the operation result is an error.
\ No newline at end of file
--- /dev/null
+The overriding method merely calls the same method defined in a superclass
\ No newline at end of file
--- /dev/null
+No need to call String.valueOf to append to a string; just use the valueOf() argument directly.
\ No newline at end of file
--- /dev/null
+A variable naming conventions rule - customize this to your liking. Currently, it checks for final variables that should be fully capitalized and non-final variables that should not include underscores.
\ No newline at end of file
--- /dev/null
+Avoid using 'while' statements without using curly braces.
\ No newline at end of file
--- /dev/null
+PMD provides a very handy method for creating new rules by writing an XPath query. When the XPath query finds a match, a violation is created.
+Let's take a simple example: assume we have a Factory class that must be always declared final.
+We'd like to report a violation each time a declaration of Factory is not declared final. Consider the following class:
+<pre>
+public class a {
+ Factory f1;
+
+ void myMethod() {
+ Factory f2;
+ int a;
+ }
+}
+</pre>
+The following expression does the magic we need:
+<pre>
+//VariableDeclarator
+ [../Type/ReferenceType/ClassOrInterfaceType
+ [@Image = 'Factory'] and ..[@Final='false']]
+</pre>
+See the <a href="http://pmd.sourceforge.net/xpathruletutorial.html" target="_blank">XPath rule tutorial</a> for more information.
languagePackClassLoader = pluginRepository.getPlugin(ENGLISH_PACK_PLUGIN_KEY).getClass().getClassLoader();
bundleToClassloaders = Maps.newHashMap();
for (PluginMetadata metadata : pluginRepository.getMetadata()) {
- if (!metadata.isCore() && !ENGLISH_PACK_PLUGIN_KEY.equals(metadata.getBasePlugin())) {
- // plugin but not a language pack
- // => plugins embedd only their own bundles with all locales
+ if (!ENGLISH_PACK_PLUGIN_KEY.equals(metadata.getKey())
+ && !ENGLISH_PACK_PLUGIN_KEY.equals(metadata.getBasePlugin())) {
+ // This is a "simple" plugin, not a Language Pack
ClassLoader classLoader = pluginRepository.getPlugin(metadata.getKey()).getClass().getClassLoader();
bundleToClassloaders.put(BUNDLE_PACKAGE + metadata.getKey(), classLoader);
-
- } else if (metadata.isCore()) {
- // bundles of core plugins are defined into language packs. All language packs are supposed
- // to share the same classloader (english pack classloader)
- bundleToClassloaders.put(BUNDLE_PACKAGE + metadata.getKey(), languagePackClassLoader);
}
}
}
projects / sonarqube.git / commitdiff