Package dev.prozilla.pine.common.util

Class Strings

java.lang.Object

dev.prozilla.pine.common.util.Strings

public final class Strings
extends Object

Static utility methods for checking certain conditions before operation on strings.

Constructor Summary

Constructors

Constructor	Description
Strings()

Method Summary

Modifier and Type	Method	Description
static String	requireNonBlank(String string)	Checks that the given string is not blank and throws an InvalidStringException if it is not.
static String	requireNonBlank(String string, String message)	Checks that the given string is not blank and throws a customized InvalidStringException if it is.
static String	requireNonEmpty(String string)	Checks that the given string is not empty and throws an InvalidStringException if it is not.
static String	requireNonEmpty(String string, String message)	Checks that the given string is not empty and throws a customized InvalidStringException if it is.
static String	requirePrefix(String string, String prefix)	Checks that the given string starts with a prefix and throws an InvalidStringException if it doesn't.
static String	requirePrefix(String string, String prefix, String message)	Checks that the given string starts with a prefix and throws a customized InvalidStringException if it doesn't.
static String	requireSuffix(String string, String suffix)	Checks that the given string ends with a suffix and throws an InvalidStringException if it doesn't.
static String	requireSuffix(String string, String suffix, String message)	Checks that the given string ends with a suffix and throws a customized InvalidStringException if it doesn't.

Methods inherited from class java.lang.Object

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

Constructor Details

Strings

public Strings()

Method Details

requireNonBlank

public static String requireNonBlank(@Nonnull
 String string)
                              throws InvalidStringException

Checks that the given string is not blank and throws an InvalidStringException if it is not.

Parameters:

string - The string to check

Returns:

string if it is not blank.

Throws:

InvalidStringException - If string is blank.

requireNonBlank

public static String requireNonBlank(@Nonnull
 String string,
 String message)
                              throws InvalidStringException

Checks that the given string is not blank and throws a customized InvalidStringException if it is.

Parameters:

string - The string to check

message - The message to be used in the event that an InvalidStringException is thrown

Returns:

string if it is not blank.

Throws:

InvalidStringException - If string is blank.

requireNonEmpty

public static String requireNonEmpty(@Nonnull
 String string)
                              throws InvalidStringException

Checks that the given string is not empty and throws an InvalidStringException if it is not.

Parameters:

string - The string to check

Returns:

string if it is not empty.

Throws:

InvalidStringException - If string is empty.

requireNonEmpty

public static String requireNonEmpty(@Nonnull
 String string,
 String message)
                              throws InvalidStringException

Checks that the given string is not empty and throws a customized InvalidStringException if it is.

Parameters:

string - The string to check

message - The message to be used in the event that an InvalidStringException is thrown

Returns:

string if it is not empty.

Throws:

InvalidStringException - If string is empty.

requirePrefix

public static String requirePrefix(@Nonnull
 String string,
 @Nonnull
 String prefix)
                            throws InvalidStringException

Checks that the given string starts with a prefix and throws an InvalidStringException if it doesn't.

Parameters:

string - The string to check

prefix - The required prefix of the string

Returns:

string if it starts with a given prefix.

Throws:

InvalidStringException - If string does not start with a given prefix.

requirePrefix

public static String requirePrefix(@Nonnull
 String string,
 @Nonnull
 String prefix,
 String message)
                            throws InvalidStringException

Checks that the given string starts with a prefix and throws a customized InvalidStringException if it doesn't.

Parameters:

string - The string to check

prefix - The required prefix of the string

message - The message to be used in the event that an InvalidStringException is thrown

Returns:

string if it starts with a given prefix.

Throws:

InvalidStringException - If string does not start with a given prefix.

requireSuffix

public static String requireSuffix(@Nonnull
 String string,
 @Nonnull
 String suffix)
                            throws InvalidStringException

Checks that the given string ends with a suffix and throws an InvalidStringException if it doesn't.

Parameters:

string - The string to check

suffix - The required suffix of the string

Returns:

string if it ends with a given suffix.

Throws:

InvalidStringException - If string does not end with a given suffix.

requireSuffix

public static String requireSuffix(@Nonnull
 String string,
 @Nonnull
 String suffix,
 String message)
                            throws InvalidStringException

Checks that the given string ends with a suffix and throws a customized InvalidStringException if it doesn't.

Parameters:

string - The string to check

suffix - The required suffix of the string

message - The message to be used in the event that an InvalidStringException is thrown

Returns:

string if it ends with a given suffix.

Throws:

InvalidStringException - If string does not end with a given suffix.