com.github.cukedoctor.util.Assert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cukedoctor-converter Show documentation
The newest version!
package com.github.cukedoctor.util;

import java.io.Serializable;
import java.util.Collection;
import java.util.Map;

/** Created by rafael-pestano on 26/06/2015. */
public class Assert implements Serializable {

  private Assert() {}

  /**
   * @param object to assert
   * @return TRUE assertion when given objects is not null, FALSE otherwise
   */
  public static boolean notNull(Object object) {

    return object != null;
  }

  /**
   * @param object to assert
   * @return TRUE assertion when given objects is null, FALSE otherwise
   */
  public static boolean isNull(Object object) {

    return object == null;
  }

  /**
   * @param assertion expression to be negated
   * @return just negates the assertion
   */
  public static boolean not(boolean assertion) {

    return !assertion;
  }

  /**
   * @param text to assert
   * @return TRUE when given text has any character, FALSE otherwise
   */
  public static boolean hasText(String text) {
    if (notNull(text) && text.trim().length() > 0) {
      return true;
    }
    return false;
  }

  /**
   * @param textToSearch complete text
   * @param substring text to search in textToSearch param
   * @return TRUE when given text contains the given substring, FALSE otherwise
   */
  public static boolean contains(String textToSearch, String substring) {
    if (notNull(textToSearch) && textToSearch.contains(substring)) {
      return true;
    }
    return false;
  }

  /**
   * @param array list to check emptiness
   * @return TRUE when given array has elements; that is, it must not be {@code null} and must have
   *     at least one element. FALSE otherwise
   */
  public static boolean notEmpty(Object[] array) {
    if (array == null || array.length == 0) {
      return false;
    }
    for (Object element : array) {
      if (element != null) {
        return true;
      }
    }
    return false;
  }

  /**
   * @param collection collection to check emptiness
   * @return TRUE when given collection has elements; that is, it must not be {@code null} and must
   *     have at least one element. @return FALSE otherwise
   */
  public static boolean notEmpty(Collection collection) {
    if (notNull(collection) && !collection.isEmpty()) {
      return true;
    } else {
      return false;
    }
  }

  /**
   * @param array to check elements
   * @return TRUE when given array has at least one not null element; FALSE otherwise
   */
  public static boolean hasElements(Object[] array) {
    if (array == null || array.length > 0) {
      return false;
    }
    for (Object o : array) {
      if (o != null) {
        return true;
      }
    }
    return false;
  }

  /**
   * @param array to check elements
   * @return TRUE when given array has at least one not null element; FALSE otherwise
   */
  public static boolean hasElements(Collection array) {
    if (array == null || array.isEmpty()) {
      return false;
    }
    for (Object o : array) {
      if (o != null) {
        return true;
      }
    }
    return false;
  }

  /**
   * @param map to check emptiness
   * @return TRUE if given Map has entries; that is, it must not be {@code null} and must have at
   *     least one entry. Queue FALSE otherwise
   */
  public static boolean notEmpty(Map map) {
    if (map == null) {
      return false;
    }
    if (hasElements(map.entrySet().toArray())) {
      return true;
    }
    return false;
  }

  /**
   * Assert that an array has no null elements. Note: Does not complain if the array is empty!
   *
   *    * Assert.noNullElements(array, "The array must have non-null elements");
   * 
   *
   * @param array the array
   * @return TRUE when given array has no null elements; FALSE otherwise
   */
  public static boolean notNull(Object[] array) {
    if (array != null) {
      for (Object element : array) {
        if (element == null) {
          return false;
        }
      }
    }
    return true;
  }
}