From bafd30e273d4dda221fb03e5c04ecaa5256ba650 Mon Sep 17 00:00:00 2001 From: EpicKnarvik97 Date: Thu, 2 Sep 2021 00:23:19 +0200 Subject: [PATCH] Makes sure utility classes cannot be extended or instantiated --- .../bookswithoutborders/utility/BookFormatter.java | 8 +++++--- .../utility/EncryptionHelper.java | 13 ++++++++++--- .../bookswithoutborders/utility/FileHelper.java | 9 ++++++++- .../utility/InputCleaningHelper.java | 9 ++++++++- .../utility/InventoryHelper.java | 6 +++++- 5 files changed, 36 insertions(+), 9 deletions(-) diff --git a/src/main/java/net/knarcraft/bookswithoutborders/utility/BookFormatter.java b/src/main/java/net/knarcraft/bookswithoutborders/utility/BookFormatter.java index c3a7ecd..79f0e78 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/utility/BookFormatter.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/utility/BookFormatter.java @@ -4,10 +4,12 @@ import java.util.List; /** * A class for formatting text to fit books - * - *

The book formatter

*/ -public class BookFormatter { +public final class BookFormatter { + + private BookFormatter() { + + } /** * Formats the last page of a set of pages diff --git a/src/main/java/net/knarcraft/bookswithoutborders/utility/EncryptionHelper.java b/src/main/java/net/knarcraft/bookswithoutborders/utility/EncryptionHelper.java index c47415e..1505751 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/utility/EncryptionHelper.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/utility/EncryptionHelper.java @@ -20,7 +20,14 @@ import static net.knarcraft.bookswithoutborders.BooksWithoutBordersSettings.getS import static net.knarcraft.bookswithoutborders.utility.InputCleaningHelper.cleanString; import static net.knarcraft.bookswithoutborders.utility.InputCleaningHelper.fixName; -public class EncryptionHelper { +/** + * Helper class for book encryption + */ +public final class EncryptionHelper { + + private EncryptionHelper() { + + } /** * Transforms a string key/password into its numerical values @@ -239,7 +246,7 @@ public class EncryptionHelper { * @param groupName

The group which should be able to decrypt the book

* @return

The new encrypted metadata for the book, or null if encryption failed

*/ - protected static BookMeta saveEncryptedBookForGroup(Player player, BookMeta bookMetadata, String groupName) { + private static BookMeta saveEncryptedBookForGroup(Player player, BookMeta bookMetadata, String groupName) { String path = getBookFolder() + "Encrypted" + getSlash() + cleanString(groupName) + getSlash(); File dirTest = new File(path); //Creates group dir @@ -294,7 +301,7 @@ public class EncryptionHelper { * @param key

The key to use for encryption

* @return

The new encrypted metadata for the book, or null if encryption failed

*/ - protected static Boolean saveEncryptedBook(Player player, BookMeta bookMetaData, String key) { + private static Boolean saveEncryptedBook(Player player, BookMeta bookMetaData, String key) { String path = getBookFolder() + "Encrypted" + getSlash(); String fileName = (!bookMetaData.hasTitle()) ? "Untitled," + player.getName() : bookMetaData.getTitle() + BooksWithoutBorders.titleAuthorSeparator + bookMetaData.getAuthor(); diff --git a/src/main/java/net/knarcraft/bookswithoutborders/utility/FileHelper.java b/src/main/java/net/knarcraft/bookswithoutborders/utility/FileHelper.java index 6b9547a..3bf5010 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/utility/FileHelper.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/utility/FileHelper.java @@ -9,7 +9,14 @@ import java.util.ArrayList; import java.util.List; import java.util.regex.Pattern; -public class FileHelper { +/** + * Helper class for dealing with files + */ +public final class FileHelper { + + private FileHelper() { + + } /** * Checks if a file path points to an actual book diff --git a/src/main/java/net/knarcraft/bookswithoutborders/utility/InputCleaningHelper.java b/src/main/java/net/knarcraft/bookswithoutborders/utility/InputCleaningHelper.java index d7259d4..1da2e00 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/utility/InputCleaningHelper.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/utility/InputCleaningHelper.java @@ -3,7 +3,14 @@ package net.knarcraft.bookswithoutborders.utility; import java.util.ArrayList; import java.util.List; -public class InputCleaningHelper { +/** + * Helper class for cleaning input and names + */ +public final class InputCleaningHelper { + + private InputCleaningHelper() { + + } /** * Removes null and empty items from a list diff --git a/src/main/java/net/knarcraft/bookswithoutborders/utility/InventoryHelper.java b/src/main/java/net/knarcraft/bookswithoutborders/utility/InventoryHelper.java index 1c78e06..eb80fef 100644 --- a/src/main/java/net/knarcraft/bookswithoutborders/utility/InventoryHelper.java +++ b/src/main/java/net/knarcraft/bookswithoutborders/utility/InventoryHelper.java @@ -11,7 +11,11 @@ import org.bukkit.inventory.meta.BookMeta; /** * The inventory helper mainly helps with getting and setting books */ -public class InventoryHelper { +public final class InventoryHelper { + + private InventoryHelper() { + + } /** * Gets the book the holder is playing