org.kuali.common.util.base

Class Precondition

java.lang.Object

org.kuali.common.util.base.Precondition

public class Precondition
extends Object

Strongly mimic's Guava's Preconditions class with a sensible default error message for common situations

 Guava:
 checkArgument(!StringUtils.isBlank(foo), "'foo' cannot be blank");
 this.foo = foo;
 
 Kuali:
 this.foo = checkNotBlank(foo, "foo");
 

Constructor Summary

Constructors

Constructor and Description
Precondition()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkEquals(Object arg, Object expected, String argName)
static File	checkExists(File arg, String argName) Ensures that a File passed as an argument exists
static File	checkIsDir(File arg, String argName) Ensures that a File passed as an argument is an existing directory
static File	checkIsFile(File arg, String argName) Ensures that a File passed as an argument is a normal file
static int	checkMax(int arg, int max, String argName) Check that arg is less than or equal to max
static long	checkMax(long arg, long max, String argName) Check that arg is less than or equal to max
static int	checkMin(int arg, int min, String argName) Check that arg is greater than or equal to min.
static long	checkMin(long arg, long min, String argName) Check that arg is greater than or equal to min.
static com.google.common.base.Optional<Integer>	checkMin(com.google.common.base.Optional<Integer> arg, int min, String argName) If arg.isPresent(), check that the Integer it contains is greater than or equal to min
static com.google.common.base.Optional<Long>	checkMin(com.google.common.base.Optional<Long> arg, long min, String argName) If arg.isPresent(), check that the Long it contains is greater than or equal to min
static com.google.common.base.Optional<String>	checkNotBlank(com.google.common.base.Optional<String> arg, String argName) Ensures that an Optional<String> passed as an argument does not contain a string that is whitespace or empty ("").
static String	checkNotBlank(String arg, String argName) Ensures that a String passed as an argument is not whitespace, empty ("") or null
static <T> T	checkNotNull(T arg, String argName) Ensures that an object reference passed as an argument is not null

Methods inherited from class java.lang.Object

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

Constructor Detail

Precondition

public Precondition()

Method Detail

checkExists

public static File checkExists(File arg,
               String argName)

Ensures that a File passed as an argument exists

Parameters:

arg - a File passed as an argument

argName - the name of the argument

Returns:

the non-null File that was validated

Throws:

NullPointerException - If arg is null. The exception message contains the name of the argument that was null

IllegalArgumentException - If arg does not exist or argName is blank

checkIsDir

public static File checkIsDir(File arg,
              String argName)

Ensures that a File passed as an argument is an existing directory

Parameters:

arg - a File passed as an argument

argName - the name of the argument

Returns:

the non-null File that was validated

Throws:

NullPointerException - If arg is null. The exception message contains the name of the argument that was null

IllegalArgumentException - If arg does not exist, is not a directory, or argName is blank

checkIsFile

public static File checkIsFile(File arg,
               String argName)

Ensures that a File passed as an argument is a normal file

Parameters:

arg - a File passed as an argument

argName - the name of the argument

Returns:

the non-null File that was validated

Throws:

NullPointerException - If arg is null. The exception message contains the name of the argument that was null

IllegalArgumentException - If arg does not exist, is not a normal file, or argName is blank

checkNotNull

public static <T> T checkNotNull(T arg,
                 String argName)

Ensures that an object reference passed as an argument is not null

Parameters:

arg - an object reference passed as an argument

argName - the name of the argument

Returns:

the non-null object reference that was validated

Throws:

NullPointerException - If arg is null. The exception message contains the name of the argument that was null

IllegalArgumentException - If argName is blank

checkNotBlank

public static String checkNotBlank(String arg,
                   String argName)

Ensures that a String passed as an argument is not whitespace, empty ("") or null

Parameters:

arg - a String passed as an argument

argName - the name of the argument

Returns:

the non-blank String that was validated

Throws:

IllegalArgumentException - If arg is blank. The exception message contains the name of the argument that was blank

IllegalArgumentException - If argName is blank

checkNotBlank

public static com.google.common.base.Optional<String> checkNotBlank(com.google.common.base.Optional<String> arg,
                                                    String argName)

Ensures that an Optional<String> passed as an argument does not contain a string that is whitespace or empty ("").

Parameters:

arg - an Optional<String> passed as an argument

argName - the name of the argument

Returns:

the non-blank Optional<String> that was validated

Throws:

IllegalArgumentException - If arg is blank. The exception message contains the name of the argument that was blank

IllegalArgumentException - If argName is blank

checkMin

public static com.google.common.base.Optional<Integer> checkMin(com.google.common.base.Optional<Integer> arg,
                                                int min,
                                                String argName)

If arg.isPresent(), check that the Integer it contains is greater than or equal to min

checkMin

public static com.google.common.base.Optional<Long> checkMin(com.google.common.base.Optional<Long> arg,
                                             long min,
                                             String argName)

If arg.isPresent(), check that the Long it contains is greater than or equal to min

checkMax

public static int checkMax(int arg,
           int max,
           String argName)

Check that arg is less than or equal to max

checkMax

public static long checkMax(long arg,
            long max,
            String argName)

Check that arg is less than or equal to max

checkMin

public static int checkMin(int arg,
           int min,
           String argName)

Check that arg is greater than or equal to min.

checkMin

public static long checkMin(long arg,
            long min,
            String argName)

Check that arg is greater than or equal to min.

checkEquals

public static void checkEquals(Object arg,
               Object expected,
               String argName)