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 <Type> Type[]	nullCheck(Type[] array, String failMessage) Checks if an array is null or contains null elements.
static <Type> Type	nullCheck(Type object, String failMessage) Checks if an object is null.
static String	safeMessageCheck(String message) Checks if a message contains CR, LF, or NUL.
static String	safeMessageCheck(String message, String name) Checks if a string contains CR, LF, or NUL.
static void	truthiness(boolean bool, 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

@Nonnull
public static <Type> Type nullCheck(@Nullable
                                              Type object,
                                              @Nonnull
                                              String failMessage)

Checks if an object is null.

Type Parameters:

Type - type of object checked

Parameters:

object - object to check

failMessage - message to throw

Returns:

the sane object

Throws:

IllegalArgumentException - if the object is null

nullCheck

@Nonnull
public static <Type> Type[] nullCheck(@Nullable
                                                Type[] array,
                                                @Nonnull
                                                String failMessage)

Checks if an array is null or contains null elements.

Type Parameters:

Type - type of object checked

Parameters:

array - array to check

failMessage - message to throw

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

@Nonnull
public static 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

@Nonnull
public static 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