TextFormatter now uses static factory methods instead

Author: darvil82

build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 }
 
 group = "com.darvil"
-version = "1.0.0"
+version = "2.0.0"
 description = "Text formatting utilities to easily format text on the terminal for Java."
 
 dependencies {

src/main/java/textFormatter/TextFormatter.java

@@ -40,41 +40,49 @@ public class TextFormatter {
 	public static boolean debug = false;
 
 	/** A list of all the formatting options that should be applied to the text. */
-	private final @NotNull ArrayList<FormatOption> formatOptions = new ArrayList<>();
+	private final @NotNull ArrayList<FormatOption> formatOptions = new ArrayList<>(5);
 
 	/** A list of all the formatters that should be concatenated to this formatter. */
-	private final @NotNull List<TextFormatter> concatList = new ArrayList<>();
+	private final @NotNull List<TextFormatter> concatList = new ArrayList<>(0);
 
 	/** The parent formatter. Used when being concatenated to another formatter. */
 	private @Nullable TextFormatter parent;
 	private @Nullable Color foregroundColor;
 	private @Nullable Color backgroundColor;
-	private @NotNull String contents;
 	private @Nullable String concatGap;
+	private @NotNull String contents;
 
 	/**
 	 * Creates a new {@link TextFormatter} with the specified contents.
 	 * @param contents The contents of the formatter.
 	 */
-	public TextFormatter(@NotNull String contents) {
+	protected TextFormatter(@NotNull String contents) {
 		this.contents = contents;
 	}
 
+	/**
+	 * Creates a new {@link TextFormatter} with the specified contents.
+	 * @param contents The contents of the formatter.
+	 */
+	public static TextFormatter of(@NotNull String contents) {
+		return new TextFormatter(contents);
+	}
+
 	/**
 	 * Creates a new {@link TextFormatter} with the specified contents and foreground color.
 	 * @param contents The contents of the formatter.
 	 * @param foreground The foreground color of the formatter.
 	 */
-	public TextFormatter(@NotNull String contents, @Nullable Color foreground) {
-		this(contents);
-		this.foregroundColor = foreground;
+	public static TextFormatter of(@NotNull String contents, @NotNull Color foreground) {
+		return TextFormatter.of(contents).withForegroundColor(foreground);
 	}
 
 	/**
-	 * Creates a new {@link TextFormatter} with no contents.
+	 * Creates a new {@link TextFormatter} with empty contents.
+	 * @return a new {@link TextFormatter} with empty contents
 	 */
-	public TextFormatter() {
-		this.contents = "";
+	public static TextFormatter create() {
+		return new TextFormatter("");
 	}
 
 	/**
@@ -165,7 +173,7 @@ public TextFormatter concat(@NotNull TextFormatter... formatters) {
 	 */
 	public TextFormatter concat(@NotNull String... strings) {
 		for (var str : strings) {
-			this.concatList.add(new TextFormatter(str));
+			this.concatList.add(TextFormatter.of(str));
 		}
 		return this;
 	}
@@ -330,7 +338,7 @@ else if (TextFormatter.startWithDefaultColorIfNotDefined && this.parent == null)
 
 	/** Returns a template for a {@link TextFormatter} that is used for errors */
 	public static @NotNull TextFormatter ERROR(@NotNull String msg) {
-		return new TextFormatter(msg, Color.BRIGHT_RED).addFormat(FormatOption.REVERSE, FormatOption.BOLD);
+		return TextFormatter.of(msg, Color.BRIGHT_RED).addFormat(FormatOption.REVERSE, FormatOption.BOLD);
 	}
 
 	/**

src/test/java/TextFormatterTest.java

@@ -14,17 +14,17 @@ private static void check(@NotNull String expected, @NotNull String actual) {
 
 	@Test
 	public void testSimple() {
-		var formatter = new TextFormatter("Hello World").concat("!");
+		var formatter = TextFormatter.of("Hello World").concat("!");
 		check("Hello World!", formatter.toString());
 	}
 
 	@Test
 	public void testSubFormatters() {
-		var formatter = new TextFormatter("Hello World")
+		var formatter = TextFormatter.of("Hello World")
 			.concat("! ")
 			.concat(
-				new TextFormatter("(Here is a sub-formatter")
-					.concat(new TextFormatter(" (with another").concat(" sub-formatter)"))
+				TextFormatter.of("(Here is a sub-formatter")
+					.concat(TextFormatter.of(" (with another").concat(" sub-formatter)"))
 					.concat(")")
 			)
 			.concat("!");
@@ -34,10 +34,10 @@ public void testSubFormatters() {
 
 	@Test
 	public void testForegroundColoring() {
-		var formatter = new TextFormatter("red text here, ", Color.RED)
+		var formatter = TextFormatter.of("red text here, ", Color.RED)
 			.concat(
-				new TextFormatter("blue text here, ", Color.BLUE)
-					.concat(new TextFormatter("now yellow", Color.BRIGHT_YELLOW))
+				TextFormatter.of("blue text here, ", Color.BLUE)
+					.concat(TextFormatter.of("now yellow", Color.BRIGHT_YELLOW))
 					.concat(" and back to blue")
 			)
 			.concat(". back to red");
@@ -51,13 +51,13 @@ public void testForegroundColoring() {
 
 	@Test
 	public void testBackgroundColoring() {
-		var formatter = new TextFormatter("red background here, ")
+		var formatter = TextFormatter.of("red background here, ")
 			.withBackgroundColor(Color.RED)
 			.concat(
-				new TextFormatter("blue background here, ")
+				TextFormatter.of("blue background here, ")
 					.withBackgroundColor(Color.BLUE)
 					.concat(
-						new TextFormatter("now yellow")
+						TextFormatter.of("now yellow")
 							.withBackgroundColor(Color.BRIGHT_YELLOW)
 					)
 					.concat(" and back to blue")
@@ -74,9 +74,9 @@ public void testBackgroundColoring() {
 
 	@Test
 	public void testMiddleBackground() {
-		var formatter = new TextFormatter("yellow ", Color.BRIGHT_YELLOW)
+		var formatter = TextFormatter.of("yellow ", Color.BRIGHT_YELLOW)
 			.concat(
-				new TextFormatter("blue ")
+				TextFormatter.of("blue ")
 					.withBackgroundColor(Color.BLUE)
 			)
 			.concat(" and back to yellow");
@@ -90,10 +90,10 @@ public void testMiddleBackground() {
 
 	@Test
 	public void testEmpty() {
-		var formatter = new TextFormatter("parent start. ", Color.RED)
+		var formatter = TextFormatter.of("parent start. ", Color.RED)
 			.concat(
-				new TextFormatter("red text here, ")
-					.concat(new TextFormatter().addFormat(FormatOption.ITALIC).concat("subsub"))
+				TextFormatter.of("red text here, ")
+					.concat(TextFormatter.create().addFormat(FormatOption.ITALIC).concat("subsub"))
 			).concat(" end str");
 
 		check(
@@ -105,6 +105,6 @@ public void testEmpty() {
 
 	@Test
 	public void testStartWithDefault() {
-		check(Color.BRIGHT_WHITE + "test", new TextFormatter("test", Color.BRIGHT_WHITE).toString());
+		check(Color.BRIGHT_WHITE + "test", TextFormatter.of("test", Color.BRIGHT_WHITE).toString());
 	}
-}
+}