Resolves checkstyle errors for facade factory-kit spatial-partition state step-builder (#1077)

* Reduces checkstyle errors in facade

* Reduces checkstyle errors in factory-kit

* Reduces checkstyle errors in spatial-partition

* Reduces checkstyle errors in state

* Reduces checkstyle errors in step-builder
This commit is contained in:
Anurag Agarwal
2019-11-12 01:51:12 +05:30
committed by Ilkka Seppälä
parent 2628cc0dfc
commit c954a436ad
29 changed files with 195 additions and 197 deletions

View File

@ -27,17 +27,16 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Factory-kit is a creational pattern which defines a factory of immutable content
* with separated builder and factory interfaces to deal with the problem of
* creating one of the objects specified directly in the factory-kit instance.
* Factory-kit is a creational pattern which defines a factory of immutable content with separated
* builder and factory interfaces to deal with the problem of creating one of the objects specified
* directly in the factory-kit instance.
*
* <p>
* In the given example {@link WeaponFactory} represents the factory-kit, that contains
* four {@link Builder}s for creating new objects of
* the classes implementing {@link Weapon} interface.
* <br>Each of them can be called with {@link WeaponFactory#create(WeaponType)} method, with
* an input representing an instance of {@link WeaponType} that needs to
* be mapped explicitly with desired class type in the factory instance.
* <p>In the given example {@link WeaponFactory} represents the factory-kit, that contains four
* {@link Builder}s for creating new objects of the classes implementing {@link Weapon} interface.
*
* <p>Each of them can be called with {@link WeaponFactory#create(WeaponType)} method, with
* an input representing an instance of {@link WeaponType} that needs to be mapped explicitly with
* desired class type in the factory instance.
*/
public class App {

View File

@ -24,7 +24,7 @@
package com.iluwatar.factorykit;
/**
* Class representing Axe
* Class representing Axe.
*/
public class Axe implements Weapon {
@Override

View File

@ -24,7 +24,7 @@
package com.iluwatar.factorykit;
/**
* Class representing Bows
* Class representing Bows.
*/
public class Bow implements Weapon {
@Override

View File

@ -22,8 +22,9 @@
*/
package com.iluwatar.factorykit;
/**
* Class representing Spear
* Class representing Spear.
*/
public class Spear implements Weapon {
@Override

View File

@ -22,8 +22,9 @@
*/
package com.iluwatar.factorykit;
/**
* Class representing Swords
* Class representing Swords.
*/
public class Sword implements Weapon {
@Override

View File

@ -39,6 +39,7 @@ public interface WeaponFactory {
/**
* Creates an instance of the given type.
*
* @param name representing enum of an object type to be created.
* @return new instance of a requested class implementing {@link Weapon} interface.
*/
@ -46,6 +47,7 @@ public interface WeaponFactory {
/**
* Creates factory - placeholder for specified {@link Builder}s.
*
* @param consumer for the new builder to the factory.
* @return factory with specified {@link Builder}s
*/

View File

@ -24,7 +24,7 @@
package com.iluwatar.factorykit;
/**
* Enumerates {@link Weapon} types
* Enumerates {@link Weapon} types.
*/
public enum WeaponType {
SWORD, AXE, BOW, SPEAR