Skip to content

Commit e514d06

Browse files
committed
docs: ConsoleFormatterBannerBuildItem
1 parent 38efa45 commit e514d06

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

core/deployment/src/main/java/io/quarkus/deployment/builditem/ConsoleFormatterBannerBuildItem.java

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,34 @@
66
import io.quarkus.builder.item.SimpleBuildItem;
77
import io.quarkus.runtime.RuntimeValue;
88

9+
/**
10+
* Um {@link SimpleBuildItem} que carrega um fornecedor de banner opcional para o formatador de console.
11+
* <p>
12+
* Produzido durante a compilação e consumido pela configuração de registro para fornecer um banner em tempo de execução por
13+
* meio de
14+
* {@link RuntimeValue}.
15+
*/
916
public final class ConsoleFormatterBannerBuildItem extends SimpleBuildItem {
17+
/**
18+
* A RuntimeValue that holds an Optional Supplier of String.
19+
* The Supplier is used to generate the banner text when needed.
20+
* The Optional allows for the possibility that no banner supplier is provided, in which case the banner will not be
21+
* printed.
22+
*/
1023
private final RuntimeValue<Optional<Supplier<String>>> bannerSupplier;
1124

25+
/**
26+
* Creates a build item holding the optional banner supplier.
27+
*
28+
* @param supplierValue runtime value that may contain the banner supplier
29+
*/
1230
public ConsoleFormatterBannerBuildItem(final RuntimeValue<Optional<Supplier<String>>> supplierValue) {
1331
bannerSupplier = supplierValue;
1432
}
1533

34+
/**
35+
* @return runtime value containing the optional banner supplier
36+
*/
1637
public RuntimeValue<Optional<Supplier<String>>> getBannerSupplier() {
1738
return bannerSupplier;
1839
}

0 commit comments

Comments
 (0)