org.yarnandtail.andhow.internal

Class ReportGenerator

java.lang.Object

org.yarnandtail.andhow.internal.ReportGenerator

public class ReportGenerator
extends Object

Author:

ericeverman

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LINE_WIDTH

Constructor Summary

Constructors

Constructor and Description
ReportGenerator()

Method Summary

Modifier and Type	Method and Description
static void	printConfigSamples(StaticPropertyConfigurationInternal appDef, File sampleDir, List<Loader> loaders, boolean isDueToErrors) Print configurations samples for Loaders that support it.
static File	printConfigSamples(StaticPropertyConfigurationInternal appDef, List<Loader> loaders, boolean isDueToErrors) Writes sample configuration files for all Loaders that support it.
static void	printConstructionProblems(PrintStream out, List<ConstructionProblem> probs, StaticPropertyConfigurationInternal appDef)
static void	printLoaderProblems(PrintStream out, List<LoaderProblem> probs, StaticPropertyConfigurationInternal appDef)
static void	printProblemHR(PrintStream out)
static void	printProblems(PrintStream out, AppFatalException fatalException, StaticPropertyConfigurationInternal appDef)
static void	printRequirementProblems(PrintStream out, List<RequirementProblem> probs, StaticPropertyConfigurationInternal appDef)
static void	printSingleLoader(StaticPropertyConfigurationInternal appDef, PrintStream out, SamplePrinter printer)
static void	printValueProblems(PrintStream out, List<ValueProblem> probs, StaticPropertyConfigurationInternal appDef)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_LINE_WIDTH

public static final int DEFAULT_LINE_WIDTH

See Also:

Constant Field Values

Constructor Detail

ReportGenerator

public ReportGenerator()

Method Detail

printProblems

public static void printProblems(PrintStream out,
                                 AppFatalException fatalException,
                                 StaticPropertyConfigurationInternal appDef)

printConstructionProblems

public static void printConstructionProblems(PrintStream out,
                                             List<ConstructionProblem> probs,
                                             StaticPropertyConfigurationInternal appDef)

printLoaderProblems

public static void printLoaderProblems(PrintStream out,
                                       List<LoaderProblem> probs,
                                       StaticPropertyConfigurationInternal appDef)

printValueProblems

public static void printValueProblems(PrintStream out,
                                      List<ValueProblem> probs,
                                      StaticPropertyConfigurationInternal appDef)

printRequirementProblems

public static void printRequirementProblems(PrintStream out,
                                            List<RequirementProblem> probs,
                                            StaticPropertyConfigurationInternal appDef)

printProblemHR

public static void printProblemHR(PrintStream out)

printConfigSamples

public static File printConfigSamples(StaticPropertyConfigurationInternal appDef,
                                      List<Loader> loaders,
                                      boolean isDueToErrors)

Writes sample configuration files for all Loaders that support it. Sample files are written to the the directory specified by: Options.SAMPLES_DIRECTORY, which defaults to something under the java.io.temp directory.

Parameters:

appDef -

loaders -

isDueToErrors -

Returns:

The File directory the sample configuration files were written to.

printConfigSamples

public static void printConfigSamples(StaticPropertyConfigurationInternal appDef,
                                      File sampleDir,
                                      List<Loader> loaders,
                                      boolean isDueToErrors)

Print configurations samples for Loaders that support it.

Parameters:

sampleDir - The directory to write configuration samples to

appDef -

loaders -

isDueToErrors - If true, the reason for these samples is b/c there was a startup error.

printSingleLoader

public static void printSingleLoader(StaticPropertyConfigurationInternal appDef,
                                     PrintStream out,
                                     SamplePrinter printer)