validation

This library helps to handle custom validations in Java.

Requirements

• Java 1.8+

How to Use

To start, add that Maven dependency:

<dependency>
  <groupId>br.com.leverinfo</groupId>
  <artifactId>validation</artifactId>
  <version>0.4.0</version>
</dependency>

or Gradle:

implementation 'br.com.leverinfo:validation:0.4.0'

...then implement the interface ValidationMessage by enum (it can be by a class as well):

public enum MyMessages implements ValidationMessage {

  UNEXPECTED_ERROR("0001", "An unexpected error was encountered"),
  NAME_REQUIRED("0002", "Name is required");
  // ...

  MyMessages(String code, String message) {
    this.code = code;
    this.message = message;
  }

  private final String code;
  private final String message;

  public String getCode() {
    return code;
  }

  public final String getMessage() {
    return message;
  }
}

then, in your method, you can validate arguments like this:

...
import br.com.leverinfo.validation.ArgumentValidations;
...

public class Foo {
    
  public String printName(String name) {
    ArgumentValidations.isNotBlank(name, MyMessages.NAME_REQUIRED);
  
    return System.out.println(name);
  }
}

• If argument value is null, then a RequiredArgumentException will be thrown.
• If argument value is blank, then a InvalidArgumentException will be thrown.

Available Validations

Below are the available validations:

ArgumentValidations

Recommended to handle with argument validations

• isNull(<T>) - Throws InvalidArgumentException if value is not null
• isNotNull(<T>) - Throws RequiredArgumentException if value is null
• isBlank(CharSequence) - Throws RequiredArgumentException if value is null or InvalidArgumentException if value is not blank
• isNotBlank(CharSequence) - Throws RequiredArgumentException if value is null or InvalidArgumentException if value is blank
• anyIsNotNull(Iterable<T>) - Throws InvalidArgumentException if all values are null
• anyIsNotBlank(Iterable<CharSequence>) - Throws InvalidArgumentException if all values are null or blank
• onlyOneIsNotNull(Iterable<T>) - Throws InvalidArgumentException if more than one value is not null or if all values are null
• onlyOneIsNotBlank(Iterable<CharSequence>) - Throws InvalidArgumentException if more than one value is not blank or if all values are blank
• isEmpty(Map<K, V> | Collection<T>) - Throws RequiredArgumentException if value is null or InvalidArgumentException if value is not empty
• isNotEmpty(Map<K, V> | Collection<T>) - Throws RequiredArgumentException if value is null or InvalidArgumentException if value is empty
• isEqualTo(<T>) - Throws InvalidArgumentException if value is not equal to other value
• isNotEqualTo(<T>) - Throws InvalidArgumentException if value is equal to other value
• isNotEqualToZero(byte | short | int | long | float | double | BigDecimal) - Throws InvalidArgumentException if value is equal to zero
• isLessThan(byte | short | int | long | float | double | Comparable<T>) - Throws InvalidArgumentException if value is greater than or equal to other value
• isLessThanZero(byte | short | int | long | float | double | BigDecimal) - Throws InvalidArgumentException if value is greater than or equal to zero
• isLessThanOrEqualTo(byte | short | int | long | float | double | Comparable<T>) - Throws InvalidArgumentException if value is greater than other value
• isGreaterThanOrEqualToZero(byte | short | int | long | float | double | BigDecimal) - Throws InvalidArgumentException if value is greater than zero
• isGreaterThan(byte | short | int | long | float | double | Comparable<T>) - Throws InvalidArgumentException if value is less than or equal to other value
• isGreaterThanZero(byte | short | int | long | float | double | BigDecimal) - Throws InvalidArgumentException if value is less than or equal to zero
• isGreaterThanOrEqualTo(byte | short | int | long | float | double | Comparable<T>) - Throws InvalidArgumentException if value is less than other value
• isGreaterThanOrEqualToZero(byte | short | int | long | float | double | BigDecimal) - Throws InvalidArgumentException if value is less than zero
• isBetween(byte | short | int | long | float | double | BigDecimal) - Throws InvalidArgumentException if value is not between limits
• isTrue(boolean) - Throws InvalidArgumentException if condition is false
• isFalse(boolean) - Throws InvalidArgumentException if condition is true
• matchesPattern(CharSequence) - Throws InvalidArgumentException if value does not match with pattern
• contains(Collection<T>) - Throws InvalidArgumentException if collection does not contain value
• doesNotContain(Collection<T>) - Throws InvalidArgumentException if collection contains value
• hasSize(CharSequence | Map<K, V> | Collection<T>) - Throws InvalidArgumentException if value has not desired size
• hasSizeBetween(CharSequence | Map<K, V> | Collection<T>) - Throws InvalidArgumentException if value has not desired size range
• isInstanceOf(<T>) - Throws InvalidArgumentException if value is not instance of type

ConditionValidations

Recommended to handle with condition validations

• isTrue(boolean) - Throws NotAllowedException if condition is false
• isFalse(boolean) - Throws NotAllowedException if condition is true

Custom Exceptions

This library provides some exception classe to handle with some validations situations.

• RequiredArgumentException - Recommended to be thrown when some argument value is missing
• InvalidArgumentException - Recommended to be thrown when some argument value is invalid
• NotAllowedException - Recommended to be thrown when some operation is not allowed
• NotFoundException - Recommended to be thrown when some item is not found
• DependencyNotFoundException - Recommended to be thrown when some dependency is not found
• DuplicatedException - Recommended to be thrown when some item is duplicated

Roadmap

• Implement custom bean validations
• Configure CI/CD pipeline

Your contribution is appreciated.