Package ru.vyarus.dropwizard.guice.debug.report.option

Class OptionsConfig

  • public class OptionsConfig
extends java.lang.Object
    Options reporting configuration. By default, only user defined options are printed without not used options indication. Configuration could be performed in chained fashion: 
    
     OptionsConfig config = new OptionsConfig()
          .showNotUsedMarker()
          .showNotDefinedOptions()
    Since:
    22.08.2016
    See Also:
    for usage

    • Constructor Detail

      • OptionsConfig

        public OptionsConfig()

    • Method Detail

      • isShowNotUsedMarker

        public boolean isShowNotUsedMarker()
        Returns:
        true to show not used options marker, false otherwise

      • isShowNotDefinedOptions

        public boolean isShowNotDefinedOptions()
        CUSTOM marker is shown only when option enabled.
        Returns:
        true to show options with default values (not overridden by user), false otherwise

      • getHiddenGroups

        public java.util.Set<java.lang.Class<java.lang.Enum>> getHiddenGroups()
        Returns:
        set of option classed to hide or empty set

      • getHiddenOptions

        public java.util.Set<java.lang.Enum> getHiddenOptions()
        Returns:
        set of options to hide or empty set

      • showNotUsedMarker

        public OptionsConfig showNotUsedMarker()
        Show NOT_USED marker for not (yet) used options.
        Returns:
        config instance for chained calls

      • showNotDefinedOptions

        public OptionsConfig showNotDefinedOptions()
        Show options not customized by user (in other words show used options defaults). When enabled, CUSTOM marker is shown for user defined options.
        Returns:
        config instance for chained calls

      • hideGroups

        @SafeVarargs
public final OptionsConfig hideGroups​(java.lang.Class<java.lang.Enum>... groups)
        Hide option groups from reporting.
        Parameters:
        groups - option enum classes to hide
        Returns:
        config instance for chained calls

      • hideOptions

        public OptionsConfig hideOptions​(java.lang.Enum... options)
        Hide exact options from reporting.
        Parameters:
        options - options to hide
        Returns:
        config instance for chained calls