Module be.yildizgames.common.application

Package be.yildizgames.common.application.helper.cli

Class Banner

java.lang.Object

be.yildizgames.common.application.helper.cli.Banner

public class Banner
extends Object

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

Constructor Summary

Constructors

Constructor	Description
Banner(String appName)	Creates a new banner with the given application name.

Method Summary

Modifier and Type	Method	Description
final void	addLine(BannerLine line)	Adds a line of text to the banner.
final void	display()	Displays the banner in the terminal.
final void	fromFile(Path path)	Loads lines of text from the given file path.

Methods inherited from class java.lang.Object

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

Constructor Details

Banner

public Banner(String appName)

Creates a new banner with the given application name.

Parameters:

appName - the name of the application

Method Details

addLine

public final void addLine(BannerLine line)

Adds a line of text to the banner.

Parameters:

line - the text to add

fromFile

public final void fromFile(Path path)

Loads lines of text from the given file path.

Parameters:

path - the path to load lines from

display

public final void display()

Displays the banner in the terminal.