de.griefed.serverpackcreator.utilities.common

Class ListUtilities

java.lang.Object

de.griefed.serverpackcreator.utilities.common.ListUtilities

@Component
public final class ListUtilities
extends java.lang.Object

Utility-class revolving around Lists.

Constructor Summary

Constructors

Constructor and Description
ListUtilities()

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<java.lang.String>	cleanList(@NotNull java.util.List<java.lang.String> listToCleanUp) Clean a given String List of any entry consisting only of whitespace or a length of 0 .
@NotNull java.lang.String	encapsulateListElements(@NotNull java.util.List<java.lang.String> listToEncapsulate) Encapsulate every element of the passed String List in quotes.
void	printListToConsoleChunked(@NotNull java.util.List<java.lang.String> list, int chunkSize, @NotNull java.lang.String prefix, boolean printIndexes) Print a list to console in chunks.
void	printListToLogChunked(@NotNull java.util.List<java.lang.String> list, int chunkSize, @NotNull java.lang.String prefix, boolean printIndexes) Print a list to our log at info level, in chunks.
@NotNull java.util.List<java.lang.String>	readStringList() Prompts the user to enter the values which will make up a String List in the new configuration file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListUtilities

@Contract(pure=true)
public ListUtilities()

Method Detail

encapsulateListElements

@NotNull
public @NotNull java.lang.String encapsulateListElements(@NotNull
                                                                  @NotNull java.util.List<java.lang.String> listToEncapsulate)

Encapsulate every element of the passed String List in quotes. Returns the list as ["element1","element2","element3" etc.

Parameters:

listToEncapsulate - The String List of which to encapsulate every element in.

Returns:

Returns a concatenated String with all elements of the passed list encapsulated.

readStringList

@NotNull
public @NotNull java.util.List<java.lang.String> readStringList()

Prompts the user to enter the values which will make up a String List in the new configuration file. If the user enters an empty line, the method is exited and the String List returned.

Returns:

Returns the list of values entered by the user.

cleanList

@Contract(value="_ -> param1")
 @NotNull
public @NotNull java.util.List<java.lang.String> cleanList(@NotNull
                                                                                                    @NotNull java.util.List<java.lang.String> listToCleanUp)

Clean a given String List of any entry consisting only of whitespace or a length of 0 .

Parameters:

listToCleanUp - The list from which to delete all entries consisting only of whitespace or with a length of zero.

Returns:

Returns the cleaned up list.

printListToConsoleChunked

public void printListToConsoleChunked(@NotNull
                                      @NotNull java.util.List<java.lang.String> list,
                                      int chunkSize,
                                      @NotNull
                                      @NotNull java.lang.String prefix,
                                      boolean printIndexes)

Print a list to console in chunks. If a chunk size of 5 is set for a list with 20 entries, the result would be 4 lines printed, with 5 entries each.

Parameters:

list - The list to print to the console.

chunkSize - The chunk size to print the list with.

prefix - A prefix to add to each line printed to the console.

printIndexes - Whether to print the indexes of the entries.

printListToLogChunked

public void printListToLogChunked(@NotNull
                                  @NotNull java.util.List<java.lang.String> list,
                                  int chunkSize,
                                  @NotNull
                                  @NotNull java.lang.String prefix,
                                  boolean printIndexes)

Print a list to our log at info level, in chunks. If a chunk size of 5 is set for a list with 20 entries, the result would be 4 lines printed, with 5 entries each.

Parameters:

list - The list to print to the console.

chunkSize - The chunk size to print the list with.

prefix - A prefix to add to each line printed to the console.

printIndexes - Whether to print the indexes of the entries.