pmd / pmd / 798

80%

push

github

[java] Deprecate statementOrderMatters property of VariableCanBeInlined (refs #3124) (#7065)

* [java] Fix #3124: Deprecate statementOrderMatters property of VariableCanBeInlined

The property silently migrated into the replacement rule when
UnnecessaryLocalBeforeReturn was deprecated (#5847): setting it to false
relaxes the rule under the assumption that the statements between the
declaration and the return/throw have no side effects, which is unsafe
and could introduce an application bug when following the suggestion.

Mark the property as deprecated using DEPRECATED_RULE_PROPERTY_MARKER:
configuring it now issues a warning when the ruleset is loaded, and the
rule documentation displays a deprecated label. Behavior is unchanged
while deprecated (the conservative default, statementOrderMatters=true,
stays the default); the property will be removed later.

Signed-off-by: 付典 <fudianchn@gmail.com>

* New rule name in changelog entry

* We really don't need a test for that.

Only make actually removing the property harder.

* Explicitely call out the deprecation/removal version.

---------

Signed-off-by: 付典 <fudianchn@gmail.com>
Co-authored-by: Sören Glimm <git@uncleowen.de>

19807 of 25918 branches covered (76.42%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

42760 of 52813 relevant lines covered (80.96%)

0.82 hits per line