Package org.vast.util

Class Asserts

java.lang.Object
org.vast.util.Asserts
public final class Asserts extends Object
Modified Asserts utility methods based on Guava implementation

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    checkArgument(boolean expression)
    Ensures the truth of an expression involving one or more parameters to the calling method.
    static void
    checkArgument(boolean expression, Object errorMessage)
    Ensures the truth of an expression involving one or more parameters to the calling method.
    static void
    checkArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)
    Ensures the truth of an expression involving one or more parameters to the calling method.
    static <E extends Enum<E>>
    E
    checkArgumentInEnum(String val, Class<E> enumClass, String desc)
    Ensures that a string value is one of the allowed values from an enum
    static <T> T
    checkArgumentInSet(T val, Set<T> allowedValues, String desc)
    Ensures that a value is one of the allowed values in a set
    static <T> T[]
    checkArraySize(T[] array, Object errorMessage, int minSize, int maxSize)
    Ensures that an array is not null and has the correct size
    static <T extends CharSequence>
    T
    checkCharLength(T str, Object errorMessage, int minSize, int maxSize)
    Ensures that a character sequence (e.g.
    static <T extends Collection<?>>
    T
    checkCollectionSize(T collection, Object errorMessage, int minSize, int maxSize)
    Ensures that a collection is not null and has the correct size
    static int
    checkElementIndex(int index, int size)
    Ensures that index specifies a valid element in an array, list or string of size size.
    static int
    checkElementIndex(int index, int size, String desc)
    Ensures that index specifies a valid element in an array, list or string of size size.
    static <T> T
    checkNotNull(T reference)
    Ensures that an object reference passed as a parameter to the calling method is not null.
    static <T> T
    checkNotNull(T reference, Object errorMessage)
    Ensures that an object reference passed as a parameter to the calling method is not null.
    static <T> T
    checkNotNull(T reference, String errorMessageTemplate, Object... errorMessageArgs)
    Ensures that an object reference passed as a parameter to the calling method is not null.
    static String
    checkNotNullOrBlank(String str, Object errorMessage)
    Ensures that a String is not null and contains at least one non-whitespace character
    static byte[]
    checkNotNullOrEmpty(byte[] array, Object errorMessage)
    Ensures that a byte array is neither null nor empty
    static char[]
    checkNotNullOrEmpty(char[] array, Object errorMessage)
    Ensures that a char array is neither null nor empty
    static double[]
    checkNotNullOrEmpty(double[] array, Object errorMessage)
    Ensures that a double array is neither null nor empty
    static float[]
    checkNotNullOrEmpty(float[] array, Object errorMessage)
    Ensures that a float array is neither null nor empty
    static int[]
    checkNotNullOrEmpty(int[] array, Object errorMessage)
    Ensures that an int array is neither null nor empty
    static long[]
    checkNotNullOrEmpty(long[] array, Object errorMessage)
    Ensures that a long array is neither null nor empty
    static <T> Collection<T>
    checkNotNullOrEmpty(Collection<T> reference, Object errorMessage)
    Ensures that a collection is neither null nor empty
    static <T> T[]
    checkNotNullOrEmpty(T[] array, Object errorMessage)
    Ensures that an array is neither null nor empty
    static <T extends CharSequence>
    T
    checkNotNullOrEmpty(T reference, Object errorMessage)
    Ensures that a CharSequence is neither null nor empty
    static int
    checkPositionIndex(int index, int size)
    Ensures that index specifies a valid position in an array, list or string of size size.
    static int
    checkPositionIndex(int index, int size, String desc)
    Ensures that index specifies a valid position in an array, list or string of size size.
    static void
    checkPositionIndexes(int start, int end, int size)
    Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order.
    static void
    checkState(boolean expression)
    Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
    static void
    checkState(boolean expression, Object errorMessage)
    Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
    static void
    checkState(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)
    Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
    static <T extends Comparable<T>>
    T
    checkValueInRange(T val, com.google.common.collect.Range<T> range, String desc)
    Ensures that a comparable value (e.g.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • checkArgument

      public static void checkArgument(boolean expression)
      Ensures the truth of an expression involving one or more parameters to the calling method.
      Parameters:
      expression - a boolean expression
      Throws:
      IllegalArgumentException - if expression is false

    • checkArgument

      public static void checkArgument(boolean expression, Object errorMessage)
      Ensures the truth of an expression involving one or more parameters to the calling method.
      Parameters:
      expression - a boolean expression
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Throws:
      IllegalArgumentException - if expression is false

    • checkArgument

      public static void checkArgument(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)
      Ensures the truth of an expression involving one or more parameters to the calling method.
      Parameters:
      expression - a boolean expression
      errorMessageTemplate - a template for the exception message should the check fail. The message is formed by replacing each '{}' placeholder in the template with an argument. These are matched by position - the first '{}' gets errorMessageArgs[0], etc. Unmatched arguments will be appended to the formatted message in square braces. Unmatched placeholders will be left as-is.
      errorMessageArgs - the arguments to be substituted into the message template. Arguments are converted to strings using String.valueOf(Object).
      Throws:
      IllegalArgumentException - if expression is false
      NullPointerException - if the check fails and either errorMessageTemplate or errorMessageArgs is null (don't let this happen)

    • checkValueInRange

      public static <T extends Comparable<T>> T checkValueInRange(T val, com.google.common.collect.Range<T> range, String desc)
      Ensures that a comparable value (e.g. numerical) is within the provided range
      Parameters:
      val - value of comparable to be checked
      range - range of allowed value (bounds can be inclusive or exclusive)
      desc - name of variable being checked (will be used in error message)
      Returns:
      The provided value if valid
      Throws:
      IllegalArgumentException - if value is not in range

    • checkArgumentInSet

      public static <T> T checkArgumentInSet(T val, Set<T> allowedValues, String desc)
      Ensures that a value is one of the allowed values in a set
      Parameters:
      val - value of variable to be checked
      allowedValues - set of allowed values
      desc - name of variable being checked (will be used in error message)
      Returns:
      The provided value if valid
      Throws:
      IllegalArgumentException - if value is not in set

    • checkArgumentInEnum

      public static <E extends Enum<E>> E checkArgumentInEnum(String val, Class<E> enumClass, String desc)
      Ensures that a string value is one of the allowed values from an enum
      Parameters:
      val - value of variable to be checked
      enumClass - enum class
      desc - name of variable being checked (will be used in error message)
      Returns:
      The corresponding enum constant if it exists
      Throws:
      IllegalArgumentException - if value is not in enum

    • checkState

      public static void checkState(boolean expression)
      Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
      Parameters:
      expression - a boolean expression
      Throws:
      IllegalStateException - if expression is false

    • checkState

      public static void checkState(boolean expression, Object errorMessage)
      Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
      Parameters:
      expression - a boolean expression
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Throws:
      IllegalStateException - if expression is false

    • checkState

      public static void checkState(boolean expression, String errorMessageTemplate, Object... errorMessageArgs)
      Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the calling method.
      Parameters:
      expression - a boolean expression
      errorMessageTemplate - a template for the exception message should the check fail. The message is formed by replacing each '{}' placeholder in the template with an argument. These are matched by position - the first '{}' gets errorMessageArgs[0], etc. Unmatched arguments will be appended to the formatted message in square braces. Unmatched placeholders will be left as-is.
      errorMessageArgs - the arguments to be substituted into the message template. Arguments are converted to strings using String.valueOf(Object).
      Throws:
      IllegalStateException - if expression is false
      NullPointerException - if the check fails and either errorMessageTemplate or errorMessageArgs is null (don't let this happen)

    • checkNotNull

      public static <T> T checkNotNull(T reference)
      Ensures that an object reference passed as a parameter to the calling method is not null.
      Parameters:
      reference - an object reference
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNull

      public static <T> T checkNotNull(T reference, Object errorMessage)
      Ensures that an object reference passed as a parameter to the calling method is not null.
      Parameters:
      reference - an object reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNull

      public static <T> T checkNotNull(T reference, String errorMessageTemplate, Object... errorMessageArgs)
      Ensures that an object reference passed as a parameter to the calling method is not null.
      Parameters:
      reference - an object reference
      errorMessageTemplate - a template for the exception message should the check fail. The message is formed by replacing each '{}' placeholder in the template with an argument. These are matched by position - the first '{}' gets errorMessageArgs[0], etc. Unmatched arguments will be appended to the formatted message in square braces. Unmatched placeholders will be left as-is.
      errorMessageArgs - the arguments to be substituted into the message template. Arguments are converted to strings using String.valueOf(Object).
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static <T extends CharSequence> T checkNotNullOrEmpty(T reference, Object errorMessage)
      Ensures that a CharSequence is neither null nor empty
      Parameters:
      reference - a CharSequence reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static <T> Collection<T> checkNotNullOrEmpty(Collection<T> reference, Object errorMessage)
      Ensures that a collection is neither null nor empty
      Parameters:
      reference - a collection reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static <T> T[] checkNotNullOrEmpty(T[] array, Object errorMessage)
      Ensures that an array is neither null nor empty
      Parameters:
      array - an array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static byte[] checkNotNullOrEmpty(byte[] array, Object errorMessage)
      Ensures that a byte array is neither null nor empty
      Parameters:
      array - an array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static char[] checkNotNullOrEmpty(char[] array, Object errorMessage)
      Ensures that a char array is neither null nor empty
      Parameters:
      array - a array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static int[] checkNotNullOrEmpty(int[] array, Object errorMessage)
      Ensures that an int array is neither null nor empty
      Parameters:
      array - an array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static long[] checkNotNullOrEmpty(long[] array, Object errorMessage)
      Ensures that a long array is neither null nor empty
      Parameters:
      array - an array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static float[] checkNotNullOrEmpty(float[] array, Object errorMessage)
      Ensures that a float array is neither null nor empty
      Parameters:
      array - an array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrEmpty

      public static double[] checkNotNullOrEmpty(double[] array, Object errorMessage)
      Ensures that a double array is neither null nor empty
      Parameters:
      array - an array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkNotNullOrBlank

      public static String checkNotNullOrBlank(String str, Object errorMessage)
      Ensures that a String is not null and contains at least one non-whitespace character
      Parameters:
      str - an array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      Returns:
      the String that was validated
      Throws:
      IllegalArgumentException - if str is null or blank

    • checkCharLength

      public static <T extends CharSequence> T checkCharLength(T str, Object errorMessage, int minSize, int maxSize)
      Ensures that a character sequence (e.g. String) is not null and has the correct size
      Parameters:
      str - a character sequence reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      minSize -
      maxSize -
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkArraySize

      public static <T> T[] checkArraySize(T[] array, Object errorMessage, int minSize, int maxSize)
      Ensures that an array is not null and has the correct size
      Parameters:
      array - an array reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      minSize -
      maxSize -
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkCollectionSize

      public static <T extends Collection<?>> T checkCollectionSize(T collection, Object errorMessage, int minSize, int maxSize)
      Ensures that a collection is not null and has the correct size
      Parameters:
      collection - a collection reference
      errorMessage - the exception message to use if the check fails; will be converted to a string using String.valueOf(Object)
      minSize -
      maxSize -
      Returns:
      the non-null reference that was validated
      Throws:
      NullPointerException - if reference is null

    • checkElementIndex

      public static int checkElementIndex(int index, int size)
      Ensures that index specifies a valid element in an array, list or string of size size. An element index may range from zero, inclusive, to size, exclusive.
      Parameters:
      index - a user-supplied index identifying an element of an array, list or string
      size - the size of that array, list or string
      Returns:
      the value of index
      Throws:
      IndexOutOfBoundsException - if index is negative or is not less than size
      IllegalArgumentException - if size is negative

    • checkElementIndex

      public static int checkElementIndex(int index, int size, String desc)
      Ensures that index specifies a valid element in an array, list or string of size size. An element index may range from zero, inclusive, to size, exclusive.
      Parameters:
      index - a user-supplied index identifying an element of an array, list or string
      size - the size of that array, list or string
      desc - the text to use to describe this index in an error message
      Returns:
      the value of index
      Throws:
      IndexOutOfBoundsException - if index is negative or is not less than size
      IllegalArgumentException - if size is negative

    • checkPositionIndex

      public static int checkPositionIndex(int index, int size)
      Ensures that index specifies a valid position in an array, list or string of size size. A position index may range from zero to size, inclusive.
      Parameters:
      index - a user-supplied index identifying a position in an array, list or string
      size - the size of that array, list or string
      Returns:
      the value of index
      Throws:
      IndexOutOfBoundsException - if index is negative or is greater than size
      IllegalArgumentException - if size is negative

    • checkPositionIndex

      public static int checkPositionIndex(int index, int size, String desc)
      Ensures that index specifies a valid position in an array, list or string of size size. A position index may range from zero to size, inclusive.
      Parameters:
      index - a user-supplied index identifying a position in an array, list or string
      size - the size of that array, list or string
      desc - the text to use to describe this index in an error message
      Returns:
      the value of index
      Throws:
      IndexOutOfBoundsException - if index is negative or is greater than size
      IllegalArgumentException - if size is negative

    • checkPositionIndexes

      public static void checkPositionIndexes(int start, int end, int size)
      Ensures that start and end specify a valid positions in an array, list or string of size size, and are in order. A position index may range from zero to size, inclusive.
      Parameters:
      start - a user-supplied index identifying a starting position in an array, list or string
      end - a user-supplied index identifying a ending position in an array, list or string
      size - the size of that array, list or string
      Throws:
      IndexOutOfBoundsException - if either index is negative or is greater than size, or if end is less than start
      IllegalArgumentException - if size is negative