com.thebuzzmedia.exiftool.commons.lang

Class PreConditions

java.lang.Object

com.thebuzzmedia.exiftool.commons.lang.PreConditions

public final class PreConditions
extends java.lang.Object

Static PreConditions Utilities.

Method Summary

Modifier and Type	Method and Description
static <T extends java.lang.Number> T	isPositive(T nb, java.lang.String message, java.lang.Object... params) Check if given number is strictly positive (strictly greater than zero).
static java.io.File	isReadable(java.io.File file, java.lang.String message, java.lang.Object... params) Check that a given file exist and is readable.
static java.io.File	isWritable(java.io.File file, java.lang.String message, java.lang.Object... params) Check that a given file exist and is writable.
static java.lang.String	notBlank(java.lang.String val, java.lang.String message, java.lang.Object... params) Ensures that a string is: Not null. Not empty. Not blank (i.e contains at least one character other than space).
static <T> java.lang.Iterable<T>	notEmpty(java.lang.Iterable<T> val, java.lang.String message, java.lang.Object... params) Ensures that iterable element is: Not null. Not empty.
static <T,U> java.util.Map<T,U>	notEmpty(java.util.Map<T,U> val, java.lang.String message, java.lang.Object... params) Ensures that map is: Not null. Not empty.
static <T> T[]	notEmpty(T[] val, java.lang.String message, java.lang.Object... params) Ensures that array is: Not null. Not empty.
static <T> T	notNull(T val, java.lang.String message, java.lang.Object... params) Ensures that an object reference passed as a parameter to the calling method is not null.

Methods inherited from class java.lang.Object

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

Method Detail

notNull

public static <T> T notNull(T val,
                            java.lang.String message,
                            java.lang.Object... params)

Ensures that an object reference passed as a parameter to the calling method is not null.

Type Parameters:

T - Type of parameter.

Parameters:

val - Value to check.

message - Message passed to NullPointerException.

params - Message parameters (formatted with String.format(String, Object...)).

Returns:

Original value if it is not null.

Throws:

java.lang.NullPointerException - If val is null.

notBlank

public static java.lang.String notBlank(java.lang.String val,
                                        java.lang.String message,
                                        java.lang.Object... params)

Ensures that a string is:

• Not null.
• Not empty.
• Not blank (i.e contains at least one character other than space).

Parameters:

val - Value to check.

message - Message passed to thrown exception.

params - Message parameters (formatted with String.format(String, Object...)).

Returns:

Original value if it is not null.

Throws:

java.lang.NullPointerException - If val is null.

java.lang.IllegalArgumentException - If val is empty or blank.

notEmpty

public static <T> T[] notEmpty(T[] val,
                               java.lang.String message,
                               java.lang.Object... params)

Ensures that array is:

• Not null.
• Not empty.

Type Parameters:

T - Type of elements in array.

Parameters:

val - Value to check.

message - Message passed to thrown exception.

params - Message parameters (formatted with String.format(String, Object...)).

Returns:

Original value if it is not empty.

Throws:

java.lang.NullPointerException - If val is null.

java.lang.IllegalArgumentException - If val is empty.

notEmpty

public static <T,U> java.util.Map<T,U> notEmpty(java.util.Map<T,U> val,
                                                java.lang.String message,
                                                java.lang.Object... params)

Ensures that map is:

• Not null.
• Not empty.

Type Parameters:

T - Type of keys in map.

U - Type of values in map.

Parameters:

val - Value to check.

message - Message passed to thrown exception.

params - Message parameters (formatted with String.format(String, Object...)).

Returns:

Original value if it is not empty.

Throws:

java.lang.NullPointerException - If val is null.

java.lang.IllegalArgumentException - If val is empty.

notEmpty

public static <T> java.lang.Iterable<T> notEmpty(java.lang.Iterable<T> val,
                                                 java.lang.String message,
                                                 java.lang.Object... params)

Ensures that iterable element is:

• Not null.
• Not empty.

Type Parameters:

T - Type of elements in iterable structure.

Parameters:

val - Value to check.

message - Message passed to thrown exception.

params - Message parameters (formatted with String.format(String, Object...)).

Returns:

Original value if it is not empty.

Throws:

java.lang.NullPointerException - If val is null.

java.lang.IllegalArgumentException - If val is empty.

isPositive

public static <T extends java.lang.Number> T isPositive(T nb,
                                                        java.lang.String message,
                                                        java.lang.Object... params)

Check if given number is strictly positive (strictly greater than zero).

Type Parameters:

T - Type of number.

Parameters:

nb - Number.

message - Error message.

params - Message parameters (formatted with String.format(String, Object...)).

Returns:

Original number.

Throws:

java.lang.NullPointerException - If nb is null.

java.lang.IllegalArgumentException - If nb is less than or equal to zero.

isReadable

public static java.io.File isReadable(java.io.File file,
                                      java.lang.String message,
                                      java.lang.Object... params)

Check that a given file exist and is readable.

Parameters:

file - File to check.

message - Error message.

params - Message parameters (formatted with String.format(String, Object...)).

Returns:

Original file.

Throws:

java.lang.NullPointerException - If file is null.

UnreadableFileException - If file does not exist.

UnreadableFileException - If file cannot be read.

isWritable

public static java.io.File isWritable(java.io.File file,
                                      java.lang.String message,
                                      java.lang.Object... params)

Check that a given file exist and is writable.

Parameters:

file - File to check.

message - Error message.

params - Message parameters (formatted with String.format(String, Object...)).

Returns:

Original file.

Throws:

java.lang.NullPointerException - If file is null.

UnreadableFileException - If file does not exist.

UnreadableFileException - If file cannot be updated.