be.yildizgames.common.application.helper.cli.Banner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of common-application Show documentation
Common Util library to build application.
The newest version!
/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *  Copyright (c) 2020-2024 Grégory Van den Borre
 *  More infos available: https://engine.yildiz-games.be
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 *  documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 *  the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright
 *  notice and this permission notice shall be included in all copies or substantial portions of the  Software.
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 *  OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

package be.yildizgames.common.application.helper.cli;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Stream;

/**
 * A banner to display at the startup of the application in the terminal.
 * This will not be displayed in logs.
 *
 * @author Grégory Van den Borre
 */
public class Banner {

    /**
     * The length of each line in the banner.
     */
    private static final int LINE_LENGTH = 80;

    private static final String BORDER_LINE = "*".repeat(LINE_LENGTH);

    private static final String SIDE_LINE = "*" + " ".repeat(LINE_LENGTH - 2) + "*";

    /**
     * The application name for this banner.
     */
    private final String appName;

    /**
     * Lines of text that have been directly added to the banner.
     */
    private final List lines = new ArrayList<>();

    /**
     * Additional banner lines that have been added.
     */
    private final List addedLines = new ArrayList<>();

    /**
     * Creates a new banner with the given application name.
     *
     * @param appName the name of the application
     */
    public Banner(String appName) {
        this.appName = appName;
        this.addLines();
    }

    /**
     * Adds a line of text to the banner.
     *
     * @param line the text to add
     */
    public final void addLine(BannerLine line) {
        this.addedLines.add(line);
    }

    /**
     * Loads lines of text from the given file path.
     *
     * @param path the path to load lines from
     */
    public final void fromFile(Path path) {
        this.lines.clear();
        try (Stream content = Files.lines(path)) {
            content.forEach(this.lines::add);
        } catch (IOException e) {
            Terminal.println(e.toString());
            this.addLines();
            this.lines.add("*-- ERROR reading file: " + path);
        }
    }

    /**
     * Adds a banner line to the additional lines.
     */
    private void addLines() {
        this.lines.add(BORDER_LINE);
        this.lines.add(SIDE_LINE);
        int start = ((LINE_LENGTH - 2) - this.appName.length()) >> 1;
        var l = "*" + " ".repeat(start) + this.appName;
        this.lines.add(l + " ".repeat(LINE_LENGTH - l.length() - 1) + "*");
        this.lines.add(SIDE_LINE);
        var s = "*   Powered by Yildiz-Engine";
        this.lines.add(s + " ".repeat(LINE_LENGTH - s.length() - 1) + "*");
        var e = "https://engine.yildiz-games.be   *";
        this.lines.add("*" + " ".repeat(LINE_LENGTH - e.length() - 1) + e);
    }

    /**
     * Displays the banner in the terminal.
     */
    public final void display() {
        this.lines.forEach(Terminal::println);
        this.addedLines.forEach(l -> Terminal.println(l.print()));
        Terminal.println(SIDE_LINE);
        Terminal.println(BORDER_LINE);
    }
}