Class BQCoreModule

bootique/src/main/java/io/bootique/BQCoreModule.java:82–386

The main BQModule of Bootique DI runtime. Declares a minimal set of services needed for a Bootique app to start: parsing command line, reading configuration, findings and running a Command.

 * start: parsing command line, reading configuration, findings and running a Command.
 */
public class BQCoreModule implements BQModule {

    private static final int TTY_MIN_COLUMNS = 40;
    private static final int TTY_DEFAULT_COLUMNS = 80;

    // Internal properties used to exclude system env vars and properties by BQTestRuntimeBuilder (JUnit 4) and
    //  TestRuntumeBuilder (JUnit 5)
    private static final String EXCLUDE_SYSTEM_VARIABLES = "bq.core.excludeSystemVariables";
    private static final String EXCLUDE_SYSTEM_PROPERTIES = "bq.core.excludeSystemProperties";

    private final String[] args;
    private final BootLogger bootLogger;
    private final ShutdownManager shutdownManager;
    private final Supplier<Collection<ModuleCrate>> modulesSource;

    protected BQCoreModule(
            String[] args,
            BootLogger bootLogger,
            ShutdownManager shutdownManager,
            Supplier<Collection<ModuleCrate>> modulesSource) {

        this.args = Objects.requireNonNull(args);
        this.bootLogger = Objects.requireNonNull(bootLogger);
        this.shutdownManager = Objects.requireNonNull(shutdownManager);
        this.modulesSource = Objects.requireNonNull(modulesSource);
    }

    /**
     * Returns an instance of {@link BQCoreModuleExtender} used by downstream modules to load custom extensions to the
     * Bootique core module. Should be invoked from a downstream Module's "configure" method.
     *
     * @param binder DI binder passed to the Module that invokes this method.
     * @return an instance of {@link BQCoreModuleExtender} that can be used to load custom extensions to the Bootique
     * core.
     */
    public static BQCoreModuleExtender extend(Binder binder) {
        return new BQCoreModuleExtender(binder);
    }

    private static Optional<Command> defaultCommand(Injector injector) {
        // default is optional, so check via injector whether it is bound...
        Key<Command> key = Key.get(Command.class, DefaultCommand.class);
        if (injector.hasProvider(key)) {
            Provider<Command> commandProvider = injector.getJakartaProvider(key);
            return Optional.of(commandProvider.get());
        }
        return Optional.empty();
    }

    /**
     * @since 3.0
     */
    @Override
    public ModuleCrate crate() {
        return ModuleCrate.of(this)
                .description("The core of Bootique runtime.")
                .build();
    }