Class SynopsisHelpGeneratorModule

  • All Implemented Interfaces:
    com.google.inject.Module

    public class SynopsisHelpGeneratorModule
    extends com.google.inject.AbstractModule
    Module for creating the help generator with synopsis.
    Since:
    15.0
    Version:
    17.0 2020-01-04 14:41:57
    Author:
    Stéphane GALLAND
    Maven Group Id:
    org.arakhne.afc.bootique
    Maven Artifact Id:
    bootique-synopsishelp
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void configure()  
      io.bootique.help.HelpGenerator provideHelpGenerator​(io.bootique.meta.application.ApplicationMetadata metadata, com.google.inject.Injector injector, io.bootique.terminal.Terminal terminal)
      Provide the help generator with synopsis.
      • Methods inherited from class com.google.inject.AbstractModule

        addError, addError, addError, bind, bind, bind, bindConstant, binder, bindInterceptor, bindListener, bindListener, bindScope, configure, convertToTypes, currentStage, getMembersInjector, getMembersInjector, getProvider, getProvider, install, requestInjection, requestStaticInjection, requireBinding, requireBinding
    • Constructor Detail

      • SynopsisHelpGeneratorModule

        public SynopsisHelpGeneratorModule()
    • Method Detail

      • configure

        protected void configure()
        Overrides:
        configure in class com.google.inject.AbstractModule
      • provideHelpGenerator

        @Provides
        public io.bootique.help.HelpGenerator provideHelpGenerator​(io.bootique.meta.application.ApplicationMetadata metadata,
                                                                   com.google.inject.Injector injector,
                                                                   io.bootique.terminal.Terminal terminal)
        Provide the help generator with synopsis.
        Parameters:
        metadata - the application metadata.
        injector - the injector.
        terminal - the terminal description.
        Returns:
        the help generator.