htsjdk.utils

Class ValidationUtils

java.lang.Object

htsjdk.utils.ValidationUtils

public class ValidationUtils
extends java.lang.Object

Simple functions that streamline the checking of values.

Constructor Summary

Constructors

Constructor and Description
ValidationUtils()

Method Summary

Modifier and Type	Method and Description
static boolean	isNonEmpty(java.util.Collection<?> collection) Checks that a Collection is not null and that it is not empty.
static java.lang.String	nonEmpty(java.lang.String string) Checks that a String is not null and that it is not empty.
static java.lang.String	nonEmpty(java.lang.String string, java.lang.String nameOfObject) Checks that a String is not null and that it is not empty.
static <I,T extends java.util.Collection<I>> T	nonEmpty(T collection) Checks that a Collection is not null and that it is not empty.
static <T extends java.util.Collection<?>> T	nonEmpty(T collection, java.lang.String nameOfObject) Checks that a Collection is not null and that it is not empty.
static <T> T	nonNull(T object) Checks that an Object object is not null and returns the same object or throws an IllegalArgumentException
static <T> T	nonNull(T object, java.lang.String nameOfObject) Checks that an Object is not null and returns the same object or throws an IllegalArgumentException
static <T> T	nonNull(T object, java.util.function.Supplier<java.lang.String> message) Checks that an Object is not null and returns the same object or throws an IllegalArgumentException
static void	validateArg(boolean condition, java.lang.String msg)
static void	validateArg(boolean condition, java.util.function.Supplier<java.lang.String> msg)

Methods inherited from class java.lang.Object

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

Constructor Detail

ValidationUtils

public ValidationUtils()

Method Detail

nonNull

public static <T> T nonNull(T object)

Checks that an Object object is not null and returns the same object or throws an IllegalArgumentException

Parameters:

object - any Object

Returns:

the same object

Throws:

java.lang.IllegalArgumentException - if a o == null

nonNull

public static <T> T nonNull(T object,
                            java.lang.String nameOfObject)

Checks that an Object is not null and returns the same object or throws an IllegalArgumentException

Parameters:

object - any Object

nameOfObject - the name of the object that is being checked for null. ( is used in the exception thrown when o == null.)

Returns:

the same object

Throws:

java.lang.IllegalArgumentException - if a o == null

nonNull

public static <T> T nonNull(T object,
                            java.util.function.Supplier<java.lang.String> message)

Checks that an Object is not null and returns the same object or throws an IllegalArgumentException

Parameters:

object - any Object

message - the text message that would be passed to the exception thrown when o == null.

Returns:

the same object

Throws:

java.lang.IllegalArgumentException - if a o == null

nonEmpty

public static <T extends java.util.Collection<?>> T nonEmpty(T collection,
                                                             java.lang.String nameOfObject)

Checks that a Collection is not null and that it is not empty. If it's non-null and non-empty it returns the input, otherwise it throws an IllegalArgumentException

Parameters:

collection - any Collection

nameOfObject - the name of the object that is being checked for non-emptiness. ( is used in the exception thrown when o.isEmpty().)

Returns:

the original collection

Throws:

java.lang.IllegalArgumentException - if collection is null or empty

isNonEmpty

public static boolean isNonEmpty(java.util.Collection<?> collection)

Checks that a Collection is not null and that it is not empty. If it's non-null and non-empty it returns the true

Parameters:

collection - any Collection

Returns:

true if the collection exists and has elements

nonEmpty

public static java.lang.String nonEmpty(java.lang.String string,
                                        java.lang.String nameOfObject)

Checks that a String is not null and that it is not empty. If it's non-null and non-empty it returns the input, otherwise it throws an IllegalArgumentException

Parameters:

string - any String

nameOfObject - a message to include in the output

Returns:

the original string

Throws:

java.lang.IllegalArgumentException - if string is null or empty

nonEmpty

public static java.lang.String nonEmpty(java.lang.String string)

Checks that a String is not null and that it is not empty. If it's non-null and non-empty it returns the input, otherwise it throws an IllegalArgumentException

Parameters:

string - any String

Returns:

the original string

Throws:

java.lang.IllegalArgumentException - if string is null or empty

nonEmpty

public static <I,T extends java.util.Collection<I>> T nonEmpty(T collection)

Checks that a Collection is not null and that it is not empty. If it's non-null and non-empty it returns the input, otherwise it throws an IllegalArgumentException

Parameters:

collection - any Collection

Returns:

the original collection

Throws:

java.lang.IllegalArgumentException - if collection is null or empty

validateArg

public static void validateArg(boolean condition,
                               java.lang.String msg)

validateArg

public static void validateArg(boolean condition,
                               java.util.function.Supplier<java.lang.String> msg)