Add correct @since tag to ListFormatter
All checks were successful
build-and-test / test (push) Successful in 1m33s
build-and-test / build (push) Successful in 1m40s
build-and-test / generate-javadoc (push) Successful in 4m18s

This commit is contained in:
JeremyStar™ 2024-08-19 02:49:46 +02:00
parent 781f1c113c
commit 43e038d3ec
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D

View file

@ -27,13 +27,14 @@ import java.util.Set;
/** /**
* Converts various data types to {@link String}s. * Converts various data types to {@link String}s.
* This class is unfinished.
* *
* @since v1-alpha0 * @since v1-alpha4
*/ */
public final class ListFormatter { public final class ListFormatter {
/** /**
* Constructs this class. * Constructs this class.
*
* @since v1-alpha4
*/ */
public ListFormatter() {} public ListFormatter() {}
@ -42,6 +43,7 @@ public final class ListFormatter {
* *
* @param array array to convert * @param array array to convert
* @return formatted string * @return formatted string
* @since v1-alpha4
*/ */
public static @NotNull String formatArray(@NotNull Object[] array) { public static @NotNull String formatArray(@NotNull Object[] array) {
StringBuilder output = new StringBuilder(); StringBuilder output = new StringBuilder();
@ -64,6 +66,7 @@ public final class ListFormatter {
* *
* @param set set to convert * @param set set to convert
* @return formatted string * @return formatted string
* @since v1-alpha4
*/ */
public static @NotNull String formatSet(@NotNull Set<?> set) { public static @NotNull String formatSet(@NotNull Set<?> set) {
return formatArray(set.toArray()); return formatArray(set.toArray());
@ -74,6 +77,7 @@ public final class ListFormatter {
* *
* @param list list to convert * @param list list to convert
* @return formatted string * @return formatted string
* @since v1-alpha4
*/ */
public static @NotNull String formatList(@NotNull List<?> list) { public static @NotNull String formatList(@NotNull List<?> list) {
return formatArray(list.toArray()); return formatArray(list.toArray());
@ -84,6 +88,7 @@ public final class ListFormatter {
* *
* @param map map to convert * @param map map to convert
* @return formatted string * @return formatted string
* @since v1-alpha4
*/ */
public static @NotNull String formatMap(@NotNull Map<?, ?> map) { public static @NotNull String formatMap(@NotNull Map<?, ?> map) {
StringBuilder output = new StringBuilder(); StringBuilder output = new StringBuilder();