"Not enough comments" #607 patch

patch-1-notes.md

@@ -0,0 +1,69 @@
+# patch-1 Notes
+
+This pull request be to fix issue #607.
+
+NOTE: This file be to be removed after all commenting be done.
+
+ANOTHER NOTE:
+"<...>" be used to skip through many empty directories.
+
+For example,
+"/src/<...>/impl"
+be used to direct the reader to
+/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl.
+
+Another example,
+"/resources/<...>/spring.xml"
+be used to direct the reader to
+/resources/assets/configuration/spring/dependencyinjection/configuration/spring.xml.
+
+## COMPLETED
+
+### /test/java
+
+- /test/java/FizzBuzzTest.java
+- /test/java/TestConstants.java (!)
+
+### /src/<...>/impl
+
+- /src/<...>/impl/Constants.java (!)
+- /src/<...>/impl/StandardFizzBuzz.java
+- /src/<...>/impl/Main.java
+
+#### /src/<...>/impl/printers
+
+- /src/<...>/impl/printers/IntegerIntegerPrinter.java
+
+#### /src/<...>/impl/factories
+
+- /src/<...>/impl/factories/NoFizzNoBuzzStrategyFactory.java
+- /src/<...>/impl/factories/BuzzStrategyFactory.java
+- /src/<...>/impl/factories/BuzzStringPrinterFactory.java
+- /src/<...>/impl/factories/BuzzStringReturnerFactory.java
+- /src/<...>/impl/factories/EnterpriseGradeFizzBuzzSolutionStrategy.java
+
+#### /src/<...>/impl/strategies
+
+- /src/<...>/impl/strategies/NoFizzNoBuzzStrategy.java
+
+#### /src/<...>/impl/loop
+
+- /src/<...>/impl/loop/LoopCondition.java
+
+### /src/<...>/interfaces
+
+- /src/<...>/interfaces/FizzBuzz.java
+
+#### /src/<...>/interfaces/parameters
+
+- /src/<...>/interfaces/parameters/FizzBuzzUpperLimitParameter.java
+
+### /src/<...>/interfaces/printers
+
+- /src/<...>/interfaces/printers/DataPrinter.java
+- /src/<...>/interfaces/printers/StringPrinter.java
+- /src/<...>/interfaces/printers/IntegerPrinter.java
+
+## IN PROGRESS
+
+null

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Constants.java

@@ -1,23 +1,41 @@
+// Constants.java
+// Constants
+
+// add to package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl
 package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl;
 
 /**
  * Constants
  */
 public class Constants {
 
+ // create constant for message if an attempt was made to divide by zero called `AN_ATTEMPT_WAS_MADE_TO_DIVIDE_BY_ZERO` which contains the string "An attempt was made to divide by zero."
  public static final String AN_ATTEMPT_WAS_MADE_TO_DIVIDE_BY_ZERO = "An attempt was made to divide by zero.";
+ // create constant for word "Buzz" called `BUZZ`
  public static final String BUZZ = "Buzz";
+ // create constant for name of method `com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.printers.IntegerIntegerPrinter.print` called `COM_SERIOUSCOMPANY_BUSINESS_JAVA_FIZZBUZZ_PACKAGENAMINGPACKAGE_IMPL_PRINTERS_INTEGER_INTEGER_PRINTER_PRINT` which containt the string "com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.printers.IntegerIntegerPrinter.print()"
  public static final String COM_SERIOUSCOMPANY_BUSINESS_JAVA_FIZZBUZZ_PACKAGENAMINGPACKAGE_IMPL_PRINTERS_INTEGER_INTEGER_PRINTER_PRINT = "com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.printers.IntegerIntegerPrinter.print()";
+ // create constant for word "Fizz" called `FIZZ`
  public static final String FIZZ = "Fizz";
+ // create constant for the line seperator called `LINE_SEPERATOR` which contains the string "line.seperator"
  public static final String LINE_SEPARATOR = "line.separator";
+ // create constant for the name of the loop component factory called `LOOP_COMPONENT_FACTORY` which contains the string "loopComponentFactory"
  public static final String LOOP_COMPONENT_FACTORY = "loopComponentFactory";
+ // create constant for SPRING_XML which contains the string "spring.xml"
  public static final String SPRING_XML = "spring.xml";
+ // create constant for STANDARD_FIZZ_BUZZ which contains the string "standardFizzBuzz"
  public static final String STANDARD_FIZZ_BUZZ = "standardFizzBuzz";
+ // create constant for message if the integers could not be compared called `THE_INTEGERS_COULD_NOT_BE_COMPARED` which contains the string "The integers could not be compared."
  public static final String THE_INTEGERS_COULD_NOT_BE_COMPARED = "The integers could not be compared.";
+ // create constant for the default fizz buzz upper limit parameter value called `DEFAULT_FIZZ_BUZZ_UPPER_LIMIT_PARAMETER_VALUE` which contains the integer 100
  public static final int DEFAULT_FIZZ_BUZZ_UPPER_LIMIT_PARAMETER_VALUE = 100;
+ // create constant for the integer divided by zero value called `INTEGER_DIVIDE_ZERO_VALUE` which contains the integer 0
  public static final int INTEGER_DIVIDE_ZERO_VALUE = 0;
+ // create constant for the integer <origin?> zero value called `INTEGER_ORIGIN_ZERO_VALUE` which contains the integer 0
  public static final int INTEGER_ORIGIN_ZERO_VALUE = 0;
+ // create constant for the <i'm getting confused>
  public static final int LOOP_INC_VALUE = 1;
+ // create constant for the <...>
  public static final int LOOP_INIT_VALUE = 1;
 
 }

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Main.java

@@ -1,11 +1,21 @@
+// Main.java
+// Main
+
+// add to package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl
 package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl;
 
+// imports org.springframework.context.ApplicationContext
 import org.springframework.context.ApplicationContext;
+// imports org.springframework.context.ConfigurableApplicationContext
 import org.springframework.context.ConfigurableApplicationContext;
+// imports org.springframework.context.support.ClassPathXmlApplicationContext
 import org.springframework.context.support.ClassPathXmlApplicationContext;
 
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.parameters.DefaultFizzBuzzUpperLimitParameter
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.parameters.DefaultFizzBuzzUpperLimitParameter;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.FizzBuzz
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.FizzBuzz;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.parameters.FizzBuzzUpperLimitParameter
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.parameters.FizzBuzzUpperLimitParameter;
 
 /**
@@ -17,11 +27,16 @@ public final class Main {
  * @param args
  */
  public static void main(final String[] args) {
+ // create a constant for the ApplicationContext called `context` that uses constant `SPRING_XML` from Constants
  final ApplicationContext context = new ClassPathXmlApplicationContext(Constants.SPRING_XML);
+ // creates a constant using FizzBuzz called `myFizzBuzz` which accesses the constant `STANDARD_FIZZ_BUZZ` from Constants
  final FizzBuzz myFizzBuzz = (FizzBuzz) context.getBean(Constants.STANDARD_FIZZ_BUZZ);
+ // create a constant for the FizzBuzz Upper Limit using FizzBuzzUpperLimitParameter called `fizzBuzzUpperLimit`
  final FizzBuzzUpperLimitParameter fizzBuzzUpperLimit = new DefaultFizzBuzzUpperLimitParameter();
+ // set myFizzBuzz.fizzBuzz to the FizzBuzz Upper Limit by using the obtainUpperLimitValue method from fizzBuzz UpperLimit
  myFizzBuzz.fizzBuzz(fizzBuzzUpperLimit.obtainUpperLimitValue());
 
+ // close application context
  ((ConfigurableApplicationContext) context).close();
 
  }

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/StandardFizzBuzz.java

@@ -1,35 +1,50 @@
+// StandardFizzBuzz.java
+// Standard FizzBuzz
+
+// add to package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl
 package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl;
 
+// imports org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Autowired;
+// imports org.springframework.stereotype.Service
 import org.springframework.stereotype.Service;
 
+// com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.FizzBuzz
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.FizzBuzz;
+// com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.FizzBuzzSolutionStrategyFactory
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.FizzBuzzSolutionStrategyFactory;
+// com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.FizzBuzzSolutionStrategy
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.FizzBuzzSolutionStrategy;
 
 /**
  * Standard FizzBuzz
  */
 @Service
 public class StandardFizzBuzz implements FizzBuzz {
-
+
+ // create a private constant which uses FizzBuzzSolutionStrategyFactory called `_fizzBuzzSolutionStrategyFactory`
  private final FizzBuzzSolutionStrategyFactory _fizzBuzzSolutionStrategyFactory;
 
  /**
  * @param _fizzBuzzSolutionStrategyFactory
  */
  @Autowired
  public StandardFizzBuzz(final FizzBuzzSolutionStrategyFactory _fizzBuzzSolutionStrategyFactory) {
+ // create a quick pointer `super` thing to access the accessor from the accessor method of the accessed object
  super();
+ // initialize the attribute _fizzBuzzSolutionStrategy using param _fizzBuzzSolutionStrategy
  this._fizzBuzzSolutionStrategyFactory = _fizzBuzzSolutionStrategyFactory;
  }
 
  /**
  * @param nFizzBuzzUpperLimit
  */
  public void fizzBuzz(final int nFizzBuzzUpperLimit) {
+ // create a constant which uses FizzBuzzSolutionStrategy called `mySolutionStrategy`
  final FizzBuzzSolutionStrategy mySolutionStrategy =
- this._fizzBuzzSolutionStrategyFactory.createFizzBuzzSolutionStrategy();
+ // set mySolutionStrategy to the returned value of the method `createFizzBuzzSolutionStrategy` from the class attribute `_fizzBuzzSolutionStrategyFactory`
+ this._fizzBuzzSolutionStrategyFactory.createFizzBuzzSolutionStrategy();
+ // use the method runSolution with argument of parameter of nFizzBuzzUpperLimit from mySolutionStrategy
  mySolutionStrategy.runSolution(nFizzBuzzUpperLimit);
  }
 

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/factories/BuzzStrategyFactory.java

@@ -1,10 +1,19 @@
+// BuzzStrategyFactory.java
+// Factory for BuzzStrategy
+
+// add to package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories
 package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories;
 
+// imports org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Autowired;
+// imports org.springframework.stereotype.Service
 import org.springframework.stereotype.Service;
 
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.BuzzStrategy
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.BuzzStrategy;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.IsEvenlyDivisibleStrategyFactory
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.IsEvenlyDivisibleStrategyFactory;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.IsEvenlyDivisibleFactory
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.IsEvenlyDivisibleStrategy;
 
 /**
@@ -13,14 +22,18 @@
 @Service
 public class BuzzStrategyFactory implements IsEvenlyDivisibleStrategyFactory {
 
+ // create a private constant using BuzzStrategy called `_buzzStrategy` with no value
  private final BuzzStrategy _buzzStrategy;
 
  /**
  * @param _buzzStrategy BuzzStrategy
  */
  @Autowired
+ // create constructor
  public BuzzStrategyFactory(final BuzzStrategy _buzzStrategy) {
+ // create a quick pointer `super` thing to access the accessor from the accessor method of the accessed object
  super();
+ // set the attribute `_buzzStrategy` to the parameter constant `buzzStrategy` of type BuzzStrategy
  this._buzzStrategy = _buzzStrategy;
  }
 
@@ -29,6 +42,7 @@ public BuzzStrategyFactory(final BuzzStrategy _buzzStrategy) {
  */
  @Override
  public IsEvenlyDivisibleStrategy createIsEvenlyDivisibleStrategy() {
+ // return the attribute `_buzzStrategy`
  return this._buzzStrategy;
  }
 

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/factories/BuzzStringPrinterFactory.java

@@ -1,10 +1,19 @@
+// BuzzStringPrinterFactory.java
+// Faactory for BuzzStringPrinter
+
+// add to package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories
 package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories;
 
+// imports org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Autowired;
+// imports org.springframework.stereotype.Service
 import org.springframework.stereotype.Service;
 
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.printers.BuzzStringPrinter
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.printers.BuzzStringPrinter;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.StringPrinterFactory
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.StringPrinterFactory;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.StringPrinter
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.StringPrinter;
 
 /**
@@ -13,22 +22,28 @@
 @Service
 public class BuzzStringPrinterFactory implements StringPrinterFactory {
 
+ // create a private constant using BuzzStringPrinter called `_buzzStringPrinter` with no value
  private final BuzzStringPrinter _buzzStringPrinter;
 
  /**
  * @param _buzzStringPrinter BuzzStringPrinter
  */
  @Autowired
+ // create constructor
  public BuzzStringPrinterFactory(final BuzzStringPrinter _buzzStringPrinter) {
+ // create a quick pointer `super` thing to access the accessor from the accessor method of the accessed object
  super();
+ // set attribute `_buzzStringPrinter` to parameter constant `_buzzStringParameter`
  this._buzzStringPrinter = _buzzStringPrinter;
  }
 
  /**
  * @return StringPrinter
  */
  @Override
+ // create public method called `createStringPrinter` which returns type StringPrinter
  public StringPrinter createStringPrinter() {
+ // return attribute `_buzzStringPrinter`
  return this._buzzStringPrinter;
  }
 

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/factories/BuzzStringReturnerFactory.java

@@ -1,10 +1,19 @@
+// BuzzStringReturnerFactory.java
+// Factory for BuzzStringReturner
+
+// add to package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories
 package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories;
 
+// imports org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Autowired;
+// imports org.springframework.stereotype.Service
 import org.springframework.stereotype.Service;
 
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.stringreturners.BuzzStringReturner
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.stringreturners.BuzzStringReturner;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.StringStringReturnerFactory
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.StringStringReturnerFactory;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.StringStringReturner
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.StringStringReturner;
 
 /**
@@ -13,14 +22,18 @@
 @Service
 public class BuzzStringReturnerFactory implements StringStringReturnerFactory {
 
+ // create a private constant the uses BuzzStringReturner called `_myBuzzStringReturner`
  private final BuzzStringReturner _myBuzzStringReturner;
 
  /**
  * @param _myBuzzStringReturner BuzzStringReturner
  */
  @Autowired
+ // create a constructor that take a constant final parameter called `_myBuzzStringReturner` of type BuzzStringReturner
  public BuzzStringReturnerFactory(final BuzzStringReturner _myBuzzStringReturner) {
+ // create a quick pointer `super` thing to access the accessor from the accessor method of the accessed object
  super();
+ // set attribute `_myBuzzStringReturner` to parameter constant `_myBuzzStringReturner`
  this._myBuzzStringReturner = _myBuzzStringReturner;
  }
 
@@ -29,6 +42,7 @@ public BuzzStringReturnerFactory(final BuzzStringReturner _myBuzzStringReturner)
  */
  @Override
  public StringStringReturner createStringStringReturner() {
+ // return attribute `_myBuzzStringReturner`
  return this._myBuzzStringReturner;
  }
 

src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/factories/EnterpriseGradeFizzBuzzSolutionStrategyFactory.java

@@ -1,9 +1,17 @@
+// EnterpriseGradeFizzBuzzSolutionStrategyFactory
+// Factory for EnterpriseGradeFizzBuzzSolutionStrategy
+
+// add to package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories
 package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories;
 
+// imports org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Autowired;
+// imports the Service class from the steretype package from the springframework package from the org package
 import org.springframework.stereotype.Service;
 
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.FizzBuzzSolutionFactory
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.FizzBuzzSolutionStrategyFactory;
+// imports com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.FizzBuzzSolutionStrategy
 import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.FizzBuzzSolutionStrategy;
 
 /**
@@ -12,14 +20,18 @@
 @Service
 public class EnterpriseGradeFizzBuzzSolutionStrategyFactory implements FizzBuzzSolutionStrategyFactory {
 
+ // create a private constant which uses `FizzBuzzSolutionStrategy` called `_fizzBuzzSolutionStrategy`
  private final FizzBuzzSolutionStrategy _fizzBuzzSolutionStrategy;
 
  /**
  * @param _fizzBuzzSolutionStrategy FizzBuzzSolutionStrategy
  */
  @Autowired
+ // create a constructor which take a constant parameter called `_fizzBuzzSolutionStrategy` of type FizzBuzzSolutionStrategy
  public EnterpriseGradeFizzBuzzSolutionStrategyFactory(final FizzBuzzSolutionStrategy _fizzBuzzSolutionStrategy) {
+ // create a quick pointer `super` thing to access the accessor from the accessor method of the accessed object
  super();
+ // set attribute `_fizzBuzzSolutionStrategy` to argument parameter constant `_fizzBuzzSolutionStrategy`
  this._fizzBuzzSolutionStrategy = _fizzBuzzSolutionStrategy;
  }
 
@@ -28,6 +40,7 @@ public EnterpriseGradeFizzBuzzSolutionStrategyFactory(final FizzBuzzSolutionStra
  */
  @Override
  public FizzBuzzSolutionStrategy createFizzBuzzSolutionStrategy() {
+ // return attribute `_fizzBuzzSolutionStrategy`
  return this._fizzBuzzSolutionStrategy;
  }