org.kitteh.irc.client.library.util

Class Sanity

java.lang.Object

org.kitteh.irc.client.library.util.Sanity

public final class Sanity
extends Object

Do you know the definition of sanity?

Method Summary

Modifier and Type	Method and Description
static @NonNull String	noSpaces(@NonNull String string, @NonNull String name) Checks if a string contains spaces.
static <Type> Type[]	nullCheck(Type[] array, @NonNull String name) Checks if an array is null or contains null elements.
static <Type> Type	nullCheck(Type object, @NonNull String name) Checks if an object is null.
static @NonNull String	safeMessageCheck(@NonNull String message) Checks if a message contains CR, LF, or NUL.
static @NonNull String	safeMessageCheck(@Nullable String message, @NonNull String name) Checks if a string contains CR, LF, or NUL.
static void	truthiness(boolean bool, @NonNull String failMessage) Checks if a boolean is true.

Methods inherited from class java.lang.Object

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

Method Detail

nullCheck

public static <Type> Type nullCheck(Type object,
                                    @NonNull String name)

Checks if an object is null.

Type Parameters:

Type - type of object checked

Parameters:

object - object to check

name - name of the string

Returns:

the sane object

Throws:

IllegalArgumentException - if the object is null

nullCheck

public static <Type> Type[] nullCheck(Type[] array,
                                      @NonNull String name)

Checks if an array is null or contains null elements.

Type Parameters:

Type - type of object checked

Parameters:

array - array to check

name - name of the string

Returns:

the sane object

Throws:

IllegalArgumentException - if null or contains null elements

truthiness

public static void truthiness(boolean bool,
                              @NonNull String failMessage)

Checks if a boolean is true.

Parameters:

bool - value to test

failMessage - message to throw

Throws:

IllegalArgumentException - if false

safeMessageCheck

public static @NonNull String safeMessageCheck(@NonNull String message)

Checks if a message contains CR, LF, or NUL.

Parameters:

message - message to check

Returns:

the safe message

Throws:

IllegalArgumentException - if found

safeMessageCheck

public static @NonNull String safeMessageCheck(@Nullable String message,
                                               @NonNull String name)

Checks if a string contains CR, LF, or NUL.

Parameters:

message - string to check

name - name of the string

Returns:

the safe message

Throws:

IllegalArgumentException - if found

noSpaces

public static @NonNull String noSpaces(@NonNull String string,
                                       @NonNull String name)

Checks if a string contains spaces.

Parameters:

string - string to check

name - name of item being checked

Returns:

the string

Throws:

IllegalArgumentException - if found