From c615ac6d0bf5622583843347b5b97977aa388a0f Mon Sep 17 00:00:00 2001 From: Emily Curtin Date: Thu, 2 Mar 2017 16:29:00 -0500 Subject: [PATCH] Touchups after pulling updates from main branch. Added javadoc comments to most interface declarations. --- .../impl/ApplicationContextHolder.java | 16 ++++++++++++++++ .../packagenamingpackage/impl/Constants.java | 3 +++ .../fizzbuzz/packagenamingpackage/impl/Main.java | 3 +++ .../impl/StandardFizzBuzz.java | 3 +++ .../impl/loop/LoopRunner.java | 1 + .../impl/math/arithmetics/IntegerDivider.java | 3 +++ .../NumberIsMultipleOfAnotherNumberVerifier.java | 11 +++++++++++ .../impl/printers/BuzzPrinter.java | 6 ++++++ .../impl/printers/FizzPrinter.java | 6 ++++++ .../impl/printers/IntegerPrinter.java | 6 ++++++ .../impl/printers/NewLinePrinter.java | 6 ++++++ .../FizzBuzzOutputGenerationContext.java | 3 +++ .../FizzBuzzOutputGenerationContextVisitor.java | 3 +++ .../interfaces/FizzBuzz.java | 3 +++ .../factories/FizzBuzzOutputStrategyFactory.java | 3 +++ .../FizzBuzzSolutionStrategyFactory.java | 3 +++ .../factories/IntegerPrinterFactory.java | 3 +++ .../factories/IntegerStringReturnerFactory.java | 3 +++ .../IsEvenlyDivisibleStrategyFactory.java | 3 +++ .../OutputGenerationContextVisitorFactory.java | 3 +++ .../factories/StringPrinterFactory.java | 3 +++ .../factories/StringStringReturnerFactory.java | 3 +++ .../loop/LoopContextStateManipulation.java | 7 +++++-- .../loop/LoopContextStateRetrieval.java | 3 +++ .../interfaces/loop/LoopPayloadExecution.java | 3 +++ .../parameters/FizzBuzzUpperLimitParameter.java | 3 +++ .../interfaces/printers/DataPrinter.java | 5 ++++- .../interfaces/printers/IntegerPrinter.java | 3 +++ .../interfaces/printers/StringPrinter.java | 3 +++ .../FizzBuzzExceptionSafeOutputStrategy.java | 3 +++ .../strategies/FizzBuzzOutputStrategy.java | 3 +++ .../strategies/FizzBuzzSolutionStrategy.java | 3 +++ .../strategies/IsEvenlyDivisibleStrategy.java | 3 +++ .../strategies/OutputGenerationStrategy.java | 3 +++ .../SingleStepOutputGenerationParameter.java | 3 +++ .../stringreturners/IntegerStringReturner.java | 3 +++ .../stringreturners/StringStringReturner.java | 3 +++ .../visitors/OutputGenerationContext.java | 3 +++ .../visitors/OutputGenerationContextVisitor.java | 3 +++ 39 files changed, 151 insertions(+), 3 deletions(-) diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/ApplicationContextHolder.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/ApplicationContextHolder.java index 6a81f918..6d6c10d9 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/ApplicationContextHolder.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/ApplicationContextHolder.java @@ -5,17 +5,26 @@ import org.springframework.context.ApplicationContextAware; import org.springframework.stereotype.Service; +/** + * Holder for Application Context + */ @Service public class ApplicationContextHolder implements ApplicationContextAware { private static ApplicationContext applicationContext; + /** + * Updater for ApplicationContextReference + */ private static class ApplicationContextReferenceUpdater { void updateApplicationContextReference(final ApplicationContext applicationContext) { ApplicationContextHolder.applicationContext = applicationContext; } } + /** + * Holder for ApplicationContextReferenceUpdater + */ private static class ApplicationContextReferenceUpdaterHolder { static ApplicationContextReferenceUpdater INSTANCE = new ApplicationContextReferenceUpdater(); } @@ -24,11 +33,18 @@ private ApplicationContextHolder() { super(); } + /** + * @param applicationContext + * @throws BeansException + */ @Override public void setApplicationContext(final ApplicationContext applicationContext) throws BeansException { ApplicationContextReferenceUpdaterHolder.INSTANCE.updateApplicationContextReference(applicationContext); } + /** + * @return + */ public static ApplicationContext getApplicationContext() { return ApplicationContextHolder.applicationContext; } diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Constants.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Constants.java index 09d331ea..f351e327 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Constants.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Constants.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl; +/** + * Constants + */ public class Constants { public static final String AN_ATTEMPT_WAS_MADE_TO_DIVIDE_BY_ZERO = "An attempt was made to divide by zero."; diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Main.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Main.java index 83b2b4f9..22409508 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Main.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/Main.java @@ -8,6 +8,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.FizzBuzz; import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.parameters.FizzBuzzUpperLimitParameter; +/** + * Main + */ public final class Main { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/StandardFizzBuzz.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/StandardFizzBuzz.java index a1e33864..acc15f54 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/StandardFizzBuzz.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/StandardFizzBuzz.java @@ -7,6 +7,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.factories.FizzBuzzSolutionStrategyFactory; import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.FizzBuzzSolutionStrategy; +/** + * Standard FizzBuzz + */ @Service public class StandardFizzBuzz implements FizzBuzz { diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopRunner.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopRunner.java index 13b589ab..da29e3dc 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopRunner.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/loop/LoopRunner.java @@ -27,6 +27,7 @@ public LoopRunner(final LoopContextStateManipulation stateManipulation, } /** + * @return */ public void runLoop() { for (this.myStateManipulation.start(); this.myStateManipulation.shouldProceed(); this.myStateManipulation.proceed()) { diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/IntegerDivider.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/IntegerDivider.java index 9d4102c2..7230dfdb 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/IntegerDivider.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/IntegerDivider.java @@ -10,6 +10,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.converters.primitivetypesconverters.DoubleToIntConverter; import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.converters.primitivetypesconverters.IntToDoubleConverter; +/** + * IntegerDivider + */ @Service public class IntegerDivider { diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/NumberIsMultipleOfAnotherNumberVerifier.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/NumberIsMultipleOfAnotherNumberVerifier.java index 82df46e9..d58d6b27 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/NumberIsMultipleOfAnotherNumberVerifier.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/math/arithmetics/NumberIsMultipleOfAnotherNumberVerifier.java @@ -9,6 +9,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.strategies.comparators.integercomparator.IntegerForEqualityComparator; +/** + * NumberIsMultipleOfAnotherNumberVerifier + */ @Service public class NumberIsMultipleOfAnotherNumberVerifier { @@ -17,6 +20,9 @@ public class NumberIsMultipleOfAnotherNumberVerifier { @Autowired private ApplicationContextHolder applicationContextHolder; + /** + * @return + */ @PostConstruct public void init() { final ApplicationContext applicationContext = applicationContextHolder.getApplicationContext(); @@ -24,6 +30,11 @@ public void init() { this.integerDivider = applicationContext.getBean(IntegerDivider.class); } + /** + * @param nFirstNumber + * @param nSecondNumber + * @return + */ public static boolean numberIsMultipleOfAnotherNumber(final int nFirstNumber, final int nSecondNumber) { try { final int nDivideFirstIntegerBySecondIntegerResult = diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/BuzzPrinter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/BuzzPrinter.java index 512cb3ff..558da0fa 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/BuzzPrinter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/BuzzPrinter.java @@ -5,11 +5,17 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories.SystemOutFizzBuzzOutputStrategyFactory; +/** + * Printer for Buzz + */ @Service public class BuzzPrinter { private final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory; + /** + * @param _systemOutFizzBuzzOutputStrategyFactory + */ @Autowired public BuzzPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory) { super(); diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/FizzPrinter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/FizzPrinter.java index 60cca487..1b95394a 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/FizzPrinter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/FizzPrinter.java @@ -5,11 +5,17 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories.SystemOutFizzBuzzOutputStrategyFactory; +/** + * Printer for Fizz + */ @Service public class FizzPrinter { private final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory; + /** + * @param _systemOutFizzBuzzOutputStrategyFactory + */ @Autowired public FizzPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory) { super(); diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/IntegerPrinter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/IntegerPrinter.java index 7717cdf9..e256c115 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/IntegerPrinter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/IntegerPrinter.java @@ -5,11 +5,17 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories.SystemOutFizzBuzzOutputStrategyFactory; +/** + * Printer for Integers + */ @Service public class IntegerPrinter { private final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory; + /** + * @param _systemOutFizzBuzzOutputStrategyFactory + */ @Autowired public IntegerPrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory) { super(); diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/NewLinePrinter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/NewLinePrinter.java index 6e9e5452..448643ba 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/NewLinePrinter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/printers/NewLinePrinter.java @@ -5,11 +5,17 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.impl.factories.SystemOutFizzBuzzOutputStrategyFactory; +/** + * Printer for New Line + */ @Service public class NewLinePrinter { private final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory; + /** + * @param _systemOutFizzBuzzOutputStrategyFactory + */ @Autowired public NewLinePrinter(final SystemOutFizzBuzzOutputStrategyFactory _systemOutFizzBuzzOutputStrategyFactory) { super(); diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/visitors/FizzBuzzOutputGenerationContext.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/visitors/FizzBuzzOutputGenerationContext.java index e6fb233f..cc41f966 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/visitors/FizzBuzzOutputGenerationContext.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/visitors/FizzBuzzOutputGenerationContext.java @@ -4,6 +4,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.IsEvenlyDivisibleStrategy; import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.visitors.OutputGenerationContext; +/** + * Context for FizzBuzzOutputGeneration + */ public final class FizzBuzzOutputGenerationContext implements OutputGenerationContext { private final DataPrinter printer; diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/visitors/FizzBuzzOutputGenerationContextVisitor.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/visitors/FizzBuzzOutputGenerationContextVisitor.java index e4bd55fb..dc372059 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/visitors/FizzBuzzOutputGenerationContextVisitor.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/impl/visitors/FizzBuzzOutputGenerationContextVisitor.java @@ -7,6 +7,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.visitors.OutputGenerationContext; import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.visitors.OutputGenerationContextVisitor; +/** + * Visitor for FizzBuzzOutputGenerationContext + */ @Service public class FizzBuzzOutputGenerationContextVisitor implements OutputGenerationContextVisitor { diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/FizzBuzz.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/FizzBuzz.java index 2fe430fd..d0147978 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/FizzBuzz.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/FizzBuzz.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces; +/** + * FizzBuzz + */ public interface FizzBuzz { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/FizzBuzzOutputStrategyFactory.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/FizzBuzzOutputStrategyFactory.java index 4225b688..f252d35f 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/FizzBuzzOutputStrategyFactory.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/FizzBuzzOutputStrategyFactory.java @@ -2,6 +2,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.FizzBuzzOutputStrategy; +/** + * Factory for FizzBuzzOutputStrategy + */ public interface FizzBuzzOutputStrategyFactory { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/FizzBuzzSolutionStrategyFactory.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/FizzBuzzSolutionStrategyFactory.java index 77d25c1e..685bb226 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/FizzBuzzSolutionStrategyFactory.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/FizzBuzzSolutionStrategyFactory.java @@ -2,6 +2,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.FizzBuzzSolutionStrategy; +/** + * Factory for FizzBuzzSolutionStrategy + */ public interface FizzBuzzSolutionStrategyFactory { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IntegerPrinterFactory.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IntegerPrinterFactory.java index 6d169397..06dcd129 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IntegerPrinterFactory.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IntegerPrinterFactory.java @@ -2,6 +2,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.IntegerPrinter; +/** + * Factory for IntegerPrinter + */ public interface IntegerPrinterFactory { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IntegerStringReturnerFactory.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IntegerStringReturnerFactory.java index d8f2c908..57946ad7 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IntegerStringReturnerFactory.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IntegerStringReturnerFactory.java @@ -2,6 +2,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.IntegerStringReturner; +/** + * Factory for IntegerStringReturner + */ public interface IntegerStringReturnerFactory { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IsEvenlyDivisibleStrategyFactory.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IsEvenlyDivisibleStrategyFactory.java index 26c91cef..915d32ec 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IsEvenlyDivisibleStrategyFactory.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/IsEvenlyDivisibleStrategyFactory.java @@ -2,6 +2,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.IsEvenlyDivisibleStrategy; +/** + * Factory for IsEvenlyDivisibleStrategy + */ public interface IsEvenlyDivisibleStrategyFactory { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/OutputGenerationContextVisitorFactory.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/OutputGenerationContextVisitorFactory.java index e4053441..f3bf1e95 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/OutputGenerationContextVisitorFactory.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/OutputGenerationContextVisitorFactory.java @@ -2,6 +2,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.visitors.OutputGenerationContextVisitor; +/** + * Factory for OutputGenerationContextVisitor + */ public interface OutputGenerationContextVisitorFactory { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/StringPrinterFactory.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/StringPrinterFactory.java index 78906e85..c09cb7c9 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/StringPrinterFactory.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/StringPrinterFactory.java @@ -2,6 +2,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.StringPrinter; +/** + * Factory for StringPrinter + */ public interface StringPrinterFactory { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/StringStringReturnerFactory.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/StringStringReturnerFactory.java index b0cd2c66..a1c9974e 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/StringStringReturnerFactory.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/factories/StringStringReturnerFactory.java @@ -2,6 +2,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners.StringStringReturner; +/** + * Factory for StringStringReturner + */ public interface StringStringReturnerFactory { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopContextStateManipulation.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopContextStateManipulation.java index c404b79a..e471463f 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopContextStateManipulation.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopContextStateManipulation.java @@ -1,9 +1,12 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.loop; +/** + * Manipulation for LoopContextState + */ public interface LoopContextStateManipulation { /** - * + * @return */ public void start(); @@ -13,7 +16,7 @@ public interface LoopContextStateManipulation { public boolean shouldProceed(); /** - * + * @return */ public void proceed(); diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopContextStateRetrieval.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopContextStateRetrieval.java index 26c0e338..388d264d 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopContextStateRetrieval.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopContextStateRetrieval.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.loop; +/** + * Retrieval for LoopContextState + */ public interface LoopContextStateRetrieval { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopPayloadExecution.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopPayloadExecution.java index 847321d4..c29683a5 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopPayloadExecution.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/loop/LoopPayloadExecution.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.loop; +/** + * Execution for LoopPayload + */ public interface LoopPayloadExecution { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/parameters/FizzBuzzUpperLimitParameter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/parameters/FizzBuzzUpperLimitParameter.java index 3b0336c7..35b75231 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/parameters/FizzBuzzUpperLimitParameter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/parameters/FizzBuzzUpperLimitParameter.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.parameters; +/** + * Parameter for FizzBuzzUpperLimit + */ public interface FizzBuzzUpperLimitParameter { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/DataPrinter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/DataPrinter.java index c71e5497..7627df06 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/DataPrinter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/DataPrinter.java @@ -1,9 +1,12 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers; +/** + * Printer for Data + */ public interface DataPrinter { /** - * + * @return */ public void print(); diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/IntegerPrinter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/IntegerPrinter.java index fbda2386..e011bfa7 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/IntegerPrinter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/IntegerPrinter.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers; +/** + * Printer for Integer + */ public interface IntegerPrinter extends DataPrinter { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/StringPrinter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/StringPrinter.java index db119381..001aeab4 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/StringPrinter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/printers/StringPrinter.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers; +/** + * Printer for String + */ public interface StringPrinter extends DataPrinter { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzExceptionSafeOutputStrategy.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzExceptionSafeOutputStrategy.java index 08c2a339..b77576ec 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzExceptionSafeOutputStrategy.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzExceptionSafeOutputStrategy.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies; +/** + * Strategy for FizzBuzzExceptionSafeOutput + */ public interface FizzBuzzExceptionSafeOutputStrategy { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzOutputStrategy.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzOutputStrategy.java index c129e93f..bf245aa9 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzOutputStrategy.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzOutputStrategy.java @@ -2,6 +2,9 @@ import java.io.IOException; +/** + * Strategy for FizzBuzzOutput + */ public interface FizzBuzzOutputStrategy { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzSolutionStrategy.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzSolutionStrategy.java index 15e66744..197d271c 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzSolutionStrategy.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/FizzBuzzSolutionStrategy.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies; +/** + * Strategy for FizzBuzzSolution + */ public interface FizzBuzzSolutionStrategy { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/IsEvenlyDivisibleStrategy.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/IsEvenlyDivisibleStrategy.java index 5bf8ee28..6a30ff41 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/IsEvenlyDivisibleStrategy.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/IsEvenlyDivisibleStrategy.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies; +/** + * Strategy for IsEvenlyDivisible + */ public interface IsEvenlyDivisibleStrategy { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/OutputGenerationStrategy.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/OutputGenerationStrategy.java index 3ef421fc..6794a38e 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/OutputGenerationStrategy.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/OutputGenerationStrategy.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies; +/** + * Strategy for OutputGeneration + */ public interface OutputGenerationStrategy { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/SingleStepOutputGenerationParameter.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/SingleStepOutputGenerationParameter.java index 09f6a46d..7fc12d0c 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/SingleStepOutputGenerationParameter.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/strategies/SingleStepOutputGenerationParameter.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies; +/** + * Parameter for SingleStepOutputGeneration + */ public interface SingleStepOutputGenerationParameter { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/stringreturners/IntegerStringReturner.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/stringreturners/IntegerStringReturner.java index bb6efa26..9e461e65 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/stringreturners/IntegerStringReturner.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/stringreturners/IntegerStringReturner.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners; +/** + * Returner for IntegerString + */ public interface IntegerStringReturner { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/stringreturners/StringStringReturner.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/stringreturners/StringStringReturner.java index 97e1f16f..24adf9ab 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/stringreturners/StringStringReturner.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/stringreturners/StringStringReturner.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.stringreturners; +/** + * Returner for StringString + */ public interface StringStringReturner { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/visitors/OutputGenerationContext.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/visitors/OutputGenerationContext.java index 85c40cb3..f8877092 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/visitors/OutputGenerationContext.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/visitors/OutputGenerationContext.java @@ -3,6 +3,9 @@ import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.printers.DataPrinter; import com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.strategies.IsEvenlyDivisibleStrategy; +/** + * Context for OutputGeneration + */ public interface OutputGenerationContext { /** diff --git a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/visitors/OutputGenerationContextVisitor.java b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/visitors/OutputGenerationContextVisitor.java index be5999fe..b42cfd2d 100644 --- a/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/visitors/OutputGenerationContextVisitor.java +++ b/src/main/java/com/seriouscompany/business/java/fizzbuzz/packagenamingpackage/interfaces/visitors/OutputGenerationContextVisitor.java @@ -1,5 +1,8 @@ package com.seriouscompany.business.java.fizzbuzz.packagenamingpackage.interfaces.visitors; +/** + * Visitor for OutputGenerationContext + */ public interface OutputGenerationContextVisitor { /**