Skip to content

Commit 4dae1fa

Browse files
anuragagarwal561994iluwatar
authored andcommitted
Resolves checkstyle errors for execute-around extension-objects (iluwatar#1071)
* Reduces checkstyle errors in execute-around * Reduces checkstyle errors in extension-objects
1 parent 5ae2ce6 commit 4dae1fa

File tree

15 files changed

+27
-29
lines changed

15 files changed

+27
-29
lines changed

execute-around/src/main/java/com/iluwatar/execute/around/App.java

+4-5
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,15 @@
2929
* The Execute Around idiom specifies some code to be executed before and after a method. Typically
3030
* the idiom is used when the API has methods to be executed in pairs, such as resource
3131
* allocation/deallocation or lock acquisition/release.
32-
* <p>
33-
* In this example, we have {@link SimpleFileWriter} class that opens and closes the file for the
34-
* user. The user specifies only what to do with the file by providing the {@link FileWriterAction}
35-
* implementation.
3632
*
33+
* <p>In this example, we have {@link SimpleFileWriter} class that opens and closes the file for
34+
* the user. The user specifies only what to do with the file by providing the {@link
35+
* FileWriterAction} implementation.
3736
*/
3837
public class App {
3938

4039
/**
41-
* Program entry point
40+
* Program entry point.
4241
*/
4342
public static void main(String[] args) throws IOException {
4443

execute-around/src/main/java/com/iluwatar/execute/around/FileWriterAction.java

-2
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,7 @@
2727
import java.io.IOException;
2828

2929
/**
30-
*
3130
* Interface for specifying what to do with the file resource.
32-
*
3331
*/
3432
@FunctionalInterface
3533
public interface FileWriterAction {

execute-around/src/main/java/com/iluwatar/execute/around/SimpleFileWriter.java

+1-3
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,13 @@
2727
import java.io.IOException;
2828

2929
/**
30-
*
3130
* SimpleFileWriter handles opening and closing file for the user. The user only has to specify what
3231
* to do with the file resource through {@link FileWriterAction} parameter.
33-
*
3432
*/
3533
public class SimpleFileWriter {
3634

3735
/**
38-
* Constructor
36+
* Constructor.
3937
*/
4038
public SimpleFileWriter(String filename, FileWriterAction action) throws IOException {
4139
try (FileWriter writer = new FileWriter(filename)) {

extension-objects/src/main/java/App.java

+11-8
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,21 @@
2424
import abstractextensions.CommanderExtension;
2525
import abstractextensions.SergeantExtension;
2626
import abstractextensions.SoldierExtension;
27+
import org.slf4j.Logger;
28+
import org.slf4j.LoggerFactory;
2729
import units.CommanderUnit;
2830
import units.SergeantUnit;
2931
import units.SoldierUnit;
3032
import units.Unit;
31-
import org.slf4j.Logger;
32-
import org.slf4j.LoggerFactory;
3333

3434
/**
35-
* Anticipate that an object’s interface needs to be extended in the future.
36-
* Additional interfaces are defined by extension objects.
35+
* Anticipate that an object’s interface needs to be extended in the future. Additional interfaces
36+
* are defined by extension objects.
3737
*/
3838
public class App {
3939

4040
/**
41-
* Program entry point
41+
* Program entry point.
4242
*
4343
* @param args command line args
4444
*/
@@ -59,9 +59,12 @@ public static void main(String[] args) {
5959
private static void checkExtensionsForUnit(Unit unit) {
6060
final Logger logger = LoggerFactory.getLogger(App.class);
6161

62-
SoldierExtension soldierExtension = (SoldierExtension) unit.getUnitExtension("SoldierExtension");
63-
SergeantExtension sergeantExtension = (SergeantExtension) unit.getUnitExtension("SergeantExtension");
64-
CommanderExtension commanderExtension = (CommanderExtension) unit.getUnitExtension("CommanderExtension");
62+
SoldierExtension soldierExtension =
63+
(SoldierExtension) unit.getUnitExtension("SoldierExtension");
64+
SergeantExtension sergeantExtension =
65+
(SergeantExtension) unit.getUnitExtension("SergeantExtension");
66+
CommanderExtension commanderExtension =
67+
(CommanderExtension) unit.getUnitExtension("CommanderExtension");
6568

6669
//if unit have extension call the method
6770
if (soldierExtension != null) {

extension-objects/src/main/java/abstractextensions/CommanderExtension.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
package abstractextensions;
2525

2626
/**
27-
* Interface with their method
27+
* Interface with their method.
2828
*/
2929
public interface CommanderExtension extends UnitExtension {
3030

extension-objects/src/main/java/abstractextensions/SergeantExtension.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
package abstractextensions;
2525

2626
/**
27-
* Interface with their method
27+
* Interface with their method.
2828
*/
2929
public interface SergeantExtension extends UnitExtension {
3030

extension-objects/src/main/java/abstractextensions/SoldierExtension.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
package abstractextensions;
2525

2626
/**
27-
* Interface with their method
27+
* Interface with their method.
2828
*/
2929
public interface SoldierExtension extends UnitExtension {
3030
void soldierReady();

extension-objects/src/main/java/abstractextensions/UnitExtension.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
package abstractextensions;
2525

2626
/**
27-
* Other Extensions will extend this interface
27+
* Other Extensions will extend this interface.
2828
*/
2929
public interface UnitExtension {
3030
}

extension-objects/src/main/java/concreteextensions/Commander.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import units.CommanderUnit;
3030

3131
/**
32-
* Class defining Commander
32+
* Class defining Commander.
3333
*/
3434
public class Commander implements CommanderExtension {
3535

extension-objects/src/main/java/concreteextensions/Sergeant.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import units.SergeantUnit;
3030

3131
/**
32-
* Class defining Sergeant
32+
* Class defining Sergeant.
3333
*/
3434
public class Sergeant implements SergeantExtension {
3535

extension-objects/src/main/java/concreteextensions/Soldier.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
import units.SoldierUnit;
3030

3131
/**
32-
* Class defining Soldier
32+
* Class defining Soldier.
3333
*/
3434
public class Soldier implements SoldierExtension {
3535
private static final Logger LOGGER = LoggerFactory.getLogger(Soldier.class);

extension-objects/src/main/java/units/CommanderUnit.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import concreteextensions.Commander;
2828

2929
/**
30-
* Class defining CommanderUnit
30+
* Class defining CommanderUnit.
3131
*/
3232
public class CommanderUnit extends Unit {
3333

extension-objects/src/main/java/units/SergeantUnit.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import concreteextensions.Sergeant;
2828

2929
/**
30-
* Class defining SergeantUnit
30+
* Class defining SergeantUnit.
3131
*/
3232
public class SergeantUnit extends Unit {
3333

extension-objects/src/main/java/units/SoldierUnit.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import concreteextensions.Soldier;
2828

2929
/**
30-
* Class defining SoldierUnit
30+
* Class defining SoldierUnit.
3131
*/
3232
public class SoldierUnit extends Unit {
3333

extension-objects/src/main/java/units/Unit.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
import abstractextensions.UnitExtension;
2727

2828
/**
29-
* Class defining Unit, other units will extend this class
29+
* Class defining Unit, other units will extend this class.
3030
*/
3131
public class Unit {
3232

0 commit comments

Comments
 (0)