de.weltraumschaf.commons.validate

Class Validate

java.lang.Object

de.weltraumschaf.commons.validate.Validate

public final class Validate
extends Object

Provides methods to validate inputs.

Since:

1.0.0

Author:

Sven Strittmatter

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Validate() Hidden for pure static class.

Method Summary

Methods

Modifier and Type	Method and Description
static int	greaterThan(int reference, int lowerBound) Convenience method for greaterThan(int, int, java.lang.String) with null as name.
static int	greaterThan(int reference, int lowerBound, String name) Tests that a given integer reference value is greater than the given lower bound.
static long	greaterThan(long reference, long lowerBound) Convenience method for greaterThan(long, long, java.lang.String) with null as name.
static long	greaterThan(long reference, long lowerBound, String name) Tests that a given integer reference value is greater than the given lower bound.
static int	greaterThanOrEqual(int reference, int lowerBound) Convenience method for greaterThanOrEqual(int, int, java.lang.String) with null as name.
static int	greaterThanOrEqual(int reference, int lowerBound, String name) Tests that a given integer reference value is greater than or equal the given lower bound.
static long	greaterThanOrEqual(long reference, long lowerBound) Convenience method for greaterThanOrEqual(long, long, java.lang.String) with null as name.
static long	greaterThanOrEqual(long reference, long lowerBound, String name) Tests that a given integer reference value is greater than or equal the given lower bound.
static void	isTrue(boolean expression, String message) Tests that a given expression is true.
static String	notEmpty(String reference) Convenience message for notEmpty(java.lang.String, java.lang.String) with null as second parameter.
static String	notEmpty(String reference, String name) Validates that a given string reference is not null or empty.
static <T> T	notNull(T reference) Convenience message for notNull(java.lang.Object, java.lang.String) with null as second parameter.
static <T> T	notNull(T reference, String name) Validates that a given reference is not null.

Methods inherited from class java.lang.Object

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

Constructor Detail

Validate

private Validate()

Hidden for pure static class.

Method Detail

notNull

public static <T> T notNull(T reference,
            String name)

Validates that a given reference is not null.

This example validates that input is not null. If it is null a NullPointerException will be thrown with the name as hint in the exception message.:

void someMethod(final Object input) {
     final Object validInput = Validate.notNull(input, "input");
     // ...
 }
 

The second parameter name may be omitted. Then a NullPointerException without any message will be thrown. For this purpose you can call the convenience method notNull(java.lang.Object).

Type Parameters:

T - type of reference

Parameters:

reference - validated reference

name - name of validated reference, may be null

Returns:

the reference, if it is valid

notNull

public static <T> T notNull(T reference)

Convenience message for notNull(java.lang.Object, java.lang.String) with null as second parameter.

Type Parameters:

T - type of reference

Parameters:

reference - validated reference

Returns:

the reference, if it is valid

notEmpty

public static String notEmpty(String reference,
              String name)

Validates that a given string reference is not null or empty.

This example validates that input is not null. If it is null a NullPointerException will be thrown with the name as hint in the exception message. Also it validates that input is not empty by calling String.isEmpty(). If the string is empty an IllegalArgumentException will be thrown:

void someMethod(final String input) {
     final Strign validInput = Validate.notEmpty(input, "input");
     // ...
 }
 

The second parameter name may be omitted. Then a NullPointerException or IllegalArgumentException without any message will be thrown. For this purpose you can call the convenience method notEmpty(java.lang.String).

Parameters:

reference - validated reference

name - name of validated reference, may be null

Returns:

the reference, if it is valid

notEmpty

public static String notEmpty(String reference)

Convenience message for notEmpty(java.lang.String, java.lang.String) with null as second parameter.

Parameters:

reference - validated reference

Returns:

the reference, if it is valid

greaterThan

public static int greaterThan(int reference,
              int lowerBound,
              String name)

Tests that a given integer reference value is greater than the given lower bound.

The method throws an IllegalArgumentException if the given reference is less than or equal the given lower bound value.

Parameters:

reference - validated reference

lowerBound - bound to test against

name - name of validated reference, may be null

Returns:

the reference, if it is valid

greaterThan

public static int greaterThan(int reference,
              int lowerBound)

Convenience method for greaterThan(int, int, java.lang.String) with null as name.

Parameters:

reference - validated reference

lowerBound - bound to test against

Returns:

the reference, if it is valid

greaterThanOrEqual

public static int greaterThanOrEqual(int reference,
                     int lowerBound,
                     String name)

Tests that a given integer reference value is greater than or equal the given lower bound.

The method throws an IllegalArgumentException if the given reference is less than the given lower bound value.

Parameters:

reference - validated reference

lowerBound - bound to test against

name - name of validated reference, may be null

Returns:

the reference, if it is valid

greaterThanOrEqual

public static int greaterThanOrEqual(int reference,
                     int lowerBound)

Convenience method for greaterThanOrEqual(int, int, java.lang.String) with null as name.

Parameters:

reference - validated reference

lowerBound - bound to test against

Returns:

the reference, if it is valid

greaterThan

public static long greaterThan(long reference,
               long lowerBound,
               String name)

Tests that a given integer reference value is greater than the given lower bound.

The method throws an IllegalArgumentException if the given reference is less than or equal the given lower bound value.

Parameters:

reference - validated reference

lowerBound - bound to test against

name - name of validated reference, may be null

Returns:

the reference, if it is valid

greaterThan

public static long greaterThan(long reference,
               long lowerBound)

Convenience method for greaterThan(long, long, java.lang.String) with null as name.

Parameters:

reference - validated reference

lowerBound - bound to test against

Returns:

the reference, if it is valid

greaterThanOrEqual

public static long greaterThanOrEqual(long reference,
                      long lowerBound,
                      String name)

Tests that a given integer reference value is greater than or equal the given lower bound.

The method throws an IllegalArgumentException if the given reference is less than the given lower bound value.

Parameters:

reference - validated reference

lowerBound - bound to test against

name - name of validated reference, may be null

Returns:

the reference, if it is valid

greaterThanOrEqual

public static long greaterThanOrEqual(long reference,
                      long lowerBound)

Convenience method for greaterThanOrEqual(long, long, java.lang.String) with null as name.

Parameters:

reference - validated reference

lowerBound - bound to test against

Returns:

the reference, if it is valid

isTrue

public static void isTrue(boolean expression,
          String message)

Tests that a given expression is true.

Throws an IllegalArgumentException if the expression is false.

Parameters:

expression - tested expression

message - must not be null or empty