#2449 bump maven-checkstyle-plugin from 3.1.0 to 3.2.0 + resolve chec… by rahul-raj · Pull Request #2464 · iluwatar/java-design-patterns

rahul-raj · 2023-01-28T14:45:16Z

The intent of this PR is tp upgrade the checkstyle version from 3.1.0 to 3.2.0 and resolve all checkstyle issues.

Checkstyle issues resolved ->

Multiple classes without JavaDoc comment in it.
Class files, Method names, variable names with consecutive caps. Renamed and refactored them accordingly.
Line space before attributes (such as @param) in the JavaDoc comment section.
Remove linespaces between import statements.
Adding space (' ') between semicolons in the loop, bring logical operators (such as &&) in new lines. Checkstyles related to formatting in general.

Note ->
Added <suppress checks="RequireEmptyLineBeforeBlockTagGroup" files=".*\.java"/> in the suppressions.
This is to ignore line space requirement on the JavaDoc section.

There are two reasons behind this new suppression rule:

Need to change 300+ files for this minor checkstyle condition.
When we press "enter" while in JavaDoc comment section, all IDEs (tested on Vscode & IntelliJ) insert a space and then goes to next line. So, maven think that it is on the same line and will result in checkstyle error. This will create some confusion to people while resolving the checkstyle issues.

For me, this is not super important and unnecessary . But, if you think, it is required, then let me know. I will then go ahead and make those changes.

Sorry about the multiple commits as there was an existing etc/ directory which was removed in the checkin and I added it back. Also, there was a file FileSelectorJFrame.java that was renamed to FileSelectorJframe.java in favor of checkstyle. But it wasn't checked-in for some strange reason. I fixed that as well.

…kstyle issues

remove FileSelectorJFrame.java to resolve checkstyle issue

add refactored file with correct filename to resolve checkstyle issue

sonatype-lift · 2023-01-28T15:46:35Z

+    this.eventListener = listener;
+  }
+
+  public final void removeListener(final ThreadCompleteListener listener) {


Var: Unnecessary 'final' modifier.

Suggested change

public final void removeListener(final ThreadCompleteListener listener) {

public final void removeListener(ThreadCompleteListener listener) {

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-28T15:46:37Z

+    completed();
+  }
+
+  public final void addListener(final ThreadCompleteListener listener) {


Var: Unnecessary 'final' modifier.

Suggested change

public final void addListener(final ThreadCompleteListener listener) {

public final void addListener(ThreadCompleteListener listener) {

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-28T15:46:39Z

+  @Override
+  public void run() {
+    var currentTime = System.currentTimeMillis();
+    var endTime = currentTime + (eventTime * 1000);


NarrowCalculation: This product of integers could overflow before being implicitly cast to a long.

Suggested change

var endTime = currentTime + (eventTime * 1000);

var endTime = currentTime + (eventTime * 1000L);

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-28T15:46:40Z

+    this.eventListener = listener;
+  }
+
+  public final void removeListener(final ThreadCompleteListener listener) {


UnnecessaryFinal: Since Java 8, it's been unnecessary to make local variables and parameters final for use in lambdas or anonymous classes. Marking them as final is weakly discouraged, as it adds a fair amount of noise for minimal benefit.

Suggested change

public final void removeListener(final ThreadCompleteListener listener) {

public final void removeListener( ThreadCompleteListener listener) {

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-28T15:46:42Z

+    completed();
+  }
+
+  public final void addListener(final ThreadCompleteListener listener) {


UnnecessaryFinal: Since Java 8, it's been unnecessary to make local variables and parameters final for use in lambdas or anonymous classes. Marking them as final is weakly discouraged, as it adds a fair amount of noise for minimal benefit.

Suggested change

public final void addListener(final ThreadCompleteListener listener) {

public final void addListener( ThreadCompleteListener listener) {

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-28T15:46:44Z

-          this.touches(allBubbles.get(otherId))) { //the bubbles touch
+      if (allBubbles.get(otherId) != null //the bubble hasn't been popped yet
+          && this.id != otherId  //the two bubbles are not the same
+          && this.touches(allBubbles.get(otherId))) { //the bubbles touch


NULL_DEREFERENCE: object returned by allBubbles.get(valueOf(otherId)) could be null and is dereferenced by call to touches(...) at line 73.

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-28T15:46:46Z

@@ -31,10 +31,10 @@
 * GHobbits.
 */
 @Slf4j


💬 19 similar findings have been found in this PR

UnnecessarilyFullyQualified: This fully qualified name is unambiguous to the compiler if imported.

Suggested change

@Slf4j

LoggerFactory

🔎 Expand here to view all instances of this finding

File Path Line Number

observer/src/main/java/com/iluwatar/observer/generic/GenWeather.java 33

observer/src/main/java/com/iluwatar/observer/generic/GenOrcs.java 33

event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/AsyncEvent.java 34

observer/src/main/java/com/iluwatar/observer/generic/GenWeather.java 33

observer/src/main/java/com/iluwatar/observer/generic/GenHobbits.java 33

event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/AsyncEvent.java 34

observer/src/main/java/com/iluwatar/observer/generic/GenOrcs.java 33

observer/src/main/java/com/iluwatar/observer/generic/GenOrcs.java 33

event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/AsyncEvent.java 34

event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/AsyncEvent.java 40

Showing 10 of 19 findings. Visit the Lift Web Console to see all.

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-28T15:46:48Z

🛠 Lift Auto-fix

Some of the Lift findings in this PR can be automatically fixed. You can download and apply these changes in your local project directory of your branch to review the suggestions before committing.¹

# Download the patch
curl https://lift.sonatype.com/api/patch/github.com/iluwatar/java-design-patterns/2464.diff -o lift-autofixes.diff

# Apply the patch with git
git apply lift-autofixes.diff

# Review the changes
git diff

Want it all in a single command? Open a terminal in your project's directory and copy and paste the following command:

curl https://lift.sonatype.com/api/patch/github.com/iluwatar/java-design-patterns/2464.diff | git apply

Once you're satisfied commit and push your changes in your project.

You can preview the patch by opening the patch URL in the browser. ↩

Build issue hotfixes

fix code smell from sonar report

add new testcases to improve the test coverage

sonatype-lift · 2023-01-29T13:16:10Z

@@ -162,15 +161,15 @@ public void mouseClicked(final MouseEvent e) {
    apply.addMouseListener(new MouseAdapter() {
      @Override
      public void mouseClicked(final MouseEvent e) {


💬 2 similar findings have been found in this PR

UnnecessaryFinal: Since Java 8, it's been unnecessary to make local variables and parameters final for use in lambdas or anonymous classes. Marking them as final is weakly discouraged, as it adds a fair amount of noise for minimal benefit.

Suggested change

public void mouseClicked(final MouseEvent e) {

public void mouseClicked( MouseEvent e) {

🔎 Expand here to view all instances of this finding

File Path Line Number

presentation-model/src/main/java/com/iluwatar/presentationmodel/View.java 171

presentation-model/src/main/java/com/iluwatar/presentationmodel/View.java 133

Visit the Lift Web Console to find more details in your report.

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2023-01-29T13:16:12Z

@@ -133,7 +132,7 @@ public void createView() {
      @Override
      public void mouseClicked(final MouseEvent e) {


💬 2 similar findings have been found in this PR

Var: Unnecessary 'final' modifier.

Suggested change

public void mouseClicked(final MouseEvent e) {

public void mouseClicked(MouseEvent e) {

🔎 Expand here to view all instances of this finding

File Path Line Number

presentation-model/src/main/java/com/iluwatar/presentationmodel/View.java 163

presentation-model/src/main/java/com/iluwatar/presentationmodel/View.java 171

Visit the Lift Web Console to find more details in your report.

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

…terns into build-issue-hotfixes

Build issue hotfixes

sonarqubecloud · 2023-01-29T13:50:55Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

81.3% Coverage
0.0% Duplication

iluwatar · 2023-02-04T17:23:39Z

Looks good! Thank you for the contribution 🎉

@all-contributors please add @rahul-raj for code

allcontributors · 2023-02-04T17:23:48Z

@iluwatar

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I've put up a pull request to add @rahul-raj! 🎉

rahul-raj added 9 commits January 28, 2023 19:59

#2449 bump maven-checkstyle-plugin from 3.1.0 to 3.2.0 + resolve chec…

06497c4

…kstyle issues

remove FileSelectorJFrame.java to resolve checkstyle issue

05a22d7

remove FileSelectorJFrame.java to resolve checkstyle issue

e7cc761

remove FileSelectorJFrame.java to resolve checkstyle issue

86ae9d9

Merge pull request #1 from rahul-raj/build-issue-hotfixes

20c8209

remove FileSelectorJFrame.java to resolve checkstyle issue

add refactored file with correct filename to resolve checkstyle issue

99f0f89

Merge pull request #2 from rahul-raj/build-issue-hotfixes

271278f

add refactored file with correct filename to resolve checkstyle issue

add the test data

bea13a7

change filenames from JFrame to Jframe for checkstyle

52835d2

sonatype-lift Bot reviewed Jan 28, 2023

View reviewed changes

Merge pull request #3 from rahul-raj/build-issue-hotfixes

ff55ae3

Build issue hotfixes

rahul-raj mentioned this pull request Jan 28, 2023

Update Checkstyle to 3.2.0 #2451

Closed

rahul-raj added 4 commits January 29, 2023 13:09

fix code smell from sonar report

ad9a2a3

Merge pull request #4 from rahul-raj/build-issue-hotfixes

9d06e8c

fix code smell from sonar report

add new testcases to improve the test coverage

77fb37f

Merge pull request #5 from rahul-raj/build-issue-hotfixes

fbdc81a

add new testcases to improve the test coverage

sonatype-lift Bot reviewed Jan 29, 2023

View reviewed changes

rahul-raj added 4 commits January 29, 2023 18:48

remove code smell

af162bf

Merge branch 'master' into master

6ea24dc

Merge branch 'master' of https://github.com/rahul-raj/java-design-pat…

2e45d31

…terns into build-issue-hotfixes

Merge pull request #6 from rahul-raj/build-issue-hotfixes

918c392

Build issue hotfixes

iluwatar approved these changes Feb 4, 2023

View reviewed changes

iluwatar merged commit fb7ec9b into iluwatar:master Feb 4, 2023

allcontributors Bot mentioned this pull request Feb 4, 2023

docs: add rahul-raj as a contributor for code #2468

Merged

	public final void removeListener(final ThreadCompleteListener listener) {
	public final void removeListener(ThreadCompleteListener listener) {

Command	Usage
`@sonatype-lift ignore`	Leave out the above finding from this PR
`@sonatype-lift ignoreall`	Leave out all the existing findings from this PR
`@sonatype-lift exclude <file\|issue\|path\|tool>`	Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file

	public final void addListener(final ThreadCompleteListener listener) {
	public final void addListener(ThreadCompleteListener listener) {

	var endTime = currentTime + (eventTime * 1000);
	var endTime = currentTime + (eventTime * 1000L);

	public final void removeListener(final ThreadCompleteListener listener) {
	public final void removeListener( ThreadCompleteListener listener) {

	public final void addListener(final ThreadCompleteListener listener) {
	public final void addListener( ThreadCompleteListener listener) {

File Path	Line Number
observer/src/main/java/com/iluwatar/observer/generic/GenWeather.java	33
observer/src/main/java/com/iluwatar/observer/generic/GenOrcs.java	33
event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/AsyncEvent.java	34
observer/src/main/java/com/iluwatar/observer/generic/GenWeather.java	33
observer/src/main/java/com/iluwatar/observer/generic/GenHobbits.java	33
event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/AsyncEvent.java	34
observer/src/main/java/com/iluwatar/observer/generic/GenOrcs.java	33
observer/src/main/java/com/iluwatar/observer/generic/GenOrcs.java	33
event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/AsyncEvent.java	34
event-asynchronous/src/main/java/com/iluwatar/event/asynchronous/AsyncEvent.java	40

	public void mouseClicked(final MouseEvent e) {
	public void mouseClicked( MouseEvent e) {

File Path	Line Number
presentation-model/src/main/java/com/iluwatar/presentationmodel/View.java	171
presentation-model/src/main/java/com/iluwatar/presentationmodel/View.java	133

		@@ -133,7 +132,7 @@ public void createView() {
		@Override
		public void mouseClicked(final MouseEvent e) {

	public void mouseClicked(final MouseEvent e) {
	public void mouseClicked(MouseEvent e) {

Uh oh!

Conversation

rahul-raj commented Jan 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonatype-lift Bot Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift Bot Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift Bot Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift Bot Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift Bot Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift Bot Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift Bot Jan 28, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift Bot commented Jan 28, 2023

🛠 Lift Auto-fix

Footnotes

Uh oh!

sonatype-lift Bot Jan 29, 2023

Choose a reason for hiding this comment

Uh oh!

sonatype-lift Bot Jan 29, 2023

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Jan 29, 2023

Uh oh!

iluwatar commented Feb 4, 2023

Uh oh!

allcontributors Bot commented Feb 4, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rahul-raj commented Jan 28, 2023 •

edited

Loading