ru.vyarus.dropwizard.guice.debug

Class ConfigurationDiagnostic.Builder

java.lang.Object

ru.vyarus.dropwizard.guice.debug.ConfigurationDiagnostic.Builder

Enclosing class:

ConfigurationDiagnostic

public static class ConfigurationDiagnostic.Builder
extends java.lang.Object

Diagnostic bundle builder.

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String reportTitle)

Method Summary

Modifier and Type	Method and Description
ConfigurationDiagnostic	build()
ConfigurationDiagnostic.Builder	printConfiguration(DiagnosticConfig config) Enable configuration reporting.
ConfigurationDiagnostic.Builder	printContextTree(ContextTreeConfig treeConfig) Enable context tree printing.
ConfigurationDiagnostic.Builder	printOptions(OptionsConfig config) Enables options reporting.
ConfigurationDiagnostic.Builder	printStartupStats(boolean hideSmallTimes) Enables startup statistic reporting.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(java.lang.String reportTitle)

Method Detail

printStartupStats

public ConfigurationDiagnostic.Builder printStartupStats(boolean hideSmallTimes)

Enables startup statistic reporting. Stats shows internal guicey timings and some details of configuration process.

Enabled automatically if default bundle constructor used.

Parameters:

hideSmallTimes - true to hide times less then 1 ms, false to show everything

Returns:

builder instance for chained calls

See Also:

StatsRenderer

printOptions

public ConfigurationDiagnostic.Builder printOptions(OptionsConfig config)

Enables options reporting. Some options could be read lazily and so marked as NOT_USED at reporting time.

Parameters:

config - options section configuration

Returns:

builder instance for chained calls

printConfiguration

public ConfigurationDiagnostic.Builder printConfiguration(DiagnosticConfig config)

Enable configuration reporting. Shows configuration items in compact form. Suitable for configuration overview.

In most situations default preset is enough:

     new DiagnosticConfig().printDefaults();
 

Parameters:

config - configuration reporting section configuration

Returns:

builder instance for chained calls

See Also:

DiagnosticRenderer

printContextTree

public ConfigurationDiagnostic.Builder printContextTree(ContextTreeConfig treeConfig)

Enable context tree printing. Tree provides configuration sources perspective, suitable for better understanding of configuration sources.

Note: in contrast to diagnostic config which is empty by default, tree config prints everything by default.

Parameters:

treeConfig - context tree section configuration

Returns:

builder instance for chained calls

See Also:

ContextTreeRenderer

build

public ConfigurationDiagnostic build()

Returns:

configured listener instance