ru.vyarus.dropwizard.guice.debug.report.diagnostic

Class DiagnosticConfig

java.lang.Object

ru.vyarus.dropwizard.guice.debug.report.diagnostic.DiagnosticConfig

public final class DiagnosticConfig
extends java.lang.Object

Diagnostic reporting configuration. Config instance could be configured in chained fashion:

     DiagnosticConfig config = new DiagnosticConfig()
          .printBundles()
          .printInstallers()
          .printExtensions()
 

There are two presets for enabling default info logging (most commonly useful, {printDefaults()}) and all info logging (printAll()):

     DiagnosticConfig config = new DiagnosticConfig().printDefaults()
 

Since:

13.07.2016

See Also:

for usage

Constructor Summary

Constructors

Constructor and Description
DiagnosticConfig()

Method Summary

Modifier and Type	Method and Description
boolean	isEmptyConfig()
boolean	isPrintBundles()
boolean	isPrintCommands()
boolean	isPrintDisabledItems()
boolean	isPrintExtensions()
boolean	isPrintInstallerInterfaceMarkers()
boolean	isPrintInstallers()
boolean	isPrintModules()
boolean	isPrintNotUsedInstallers()
DiagnosticConfig	printAll() Shortcut method to enables all possible prints.
DiagnosticConfig	printBundles() Enables used bundles print.
DiagnosticConfig	printCommands() Enables installed commands (with classpath scan) print.
DiagnosticConfig	printDefaults() Enables default prints (most useful info): commands, bundles, installers, extensions, modules.
DiagnosticConfig	printDisabledItems() Enables disabled items print.
DiagnosticConfig	printExtensions() Enables extensions print.
DiagnosticConfig	printInstallerInterfaceMarkers() Enables installer markers interfaces indication.
DiagnosticConfig	printInstallers() Enables installers print.
DiagnosticConfig	printModules() Enables registered guice modules print (only directly registered modules).
DiagnosticConfig	printNotUsedInstallers() Enables not used installers print.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagnosticConfig

public DiagnosticConfig()

Method Detail

isEmptyConfig

public boolean isEmptyConfig()

Returns:

true if no prints configured, false otherwise

isPrintCommands

public boolean isPrintCommands()

Returns:

true if commands logging enabled

isPrintBundles

public boolean isPrintBundles()

Returns:

true if bundles logging enabled

isPrintInstallers

public boolean isPrintInstallers()

Returns:

true if installers logging enabled

isPrintDisabledItems

public boolean isPrintDisabledItems()

Returns:

true if disabled items logging enabled

isPrintNotUsedInstallers

public boolean isPrintNotUsedInstallers()

Returns:

true if not used installers (without extensions) logging enabled

isPrintInstallerInterfaceMarkers

public boolean isPrintInstallerInterfaceMarkers()

Returns:

true to show additional installer markers indicating implemented interfaces

isPrintExtensions

public boolean isPrintExtensions()

Returns:

true if extensions logging enabled

isPrintModules

public boolean isPrintModules()

Returns:

true if guice modules logging enabled

printCommands

public DiagnosticConfig printCommands()

Enables installed commands (with classpath scan) print.

Returns:

config instance for chained calls

printBundles

public DiagnosticConfig printBundles()

Enables used bundles print.

Returns:

config instance for chained calls

printInstallers

public DiagnosticConfig printInstallers()

Enables installers print. By default prints only installers which install at least one extension.

If extensions printing enabled (printExtensions()), then extensions will be printed just after installer.

Both installers and extensions printed in execution order (sorted).

If disabled installers print enabled (printDisabledItems()) then they will be printed at the end of installers list.

All installers printing may be enabled with not used installers (printNotUsedInstallers()).

Returns:

config instance for chained calls

printDisabledItems

public DiagnosticConfig printDisabledItems()

Enables disabled items print. Only printed items affected (e.g. installers when printInstallers() enabled).

Returns:

config instance for chained calls

printNotUsedInstallers

public DiagnosticConfig printNotUsedInstallers()

Enables not used installers print. Requires printInstallers() enabled.

Returns:

config instance for chained calls

printInstallerInterfaceMarkers

public DiagnosticConfig printInstallerInterfaceMarkers()

Enables installer markers interfaces indication. Useful to understand what installer will do (e.g. install extension by type or by instance or if it performs custom bindings).

Returns:

config instance for chained calls

printExtensions

public DiagnosticConfig printExtensions()

Enables extensions print. If installers print enabled (printInstallers()) then extensions will be printed relative to used installer, otherwise extensions printed as simple list.

Returns:

config instance for chained calls

printModules

public DiagnosticConfig printModules()

Enables registered guice modules print (only directly registered modules).

Returns:

config instance for chained calls

printAll

public DiagnosticConfig printAll()

Shortcut method to enables all possible prints.

Returns:

config instance for chained calls

printDefaults

public DiagnosticConfig printDefaults()

Enables default prints (most useful info): commands, bundles, installers, extensions, modules.

Returns:

config instance for chained calls