org.junitpioneer.internal.PioneerPreconditions Maven / Gradle / Ivy
/*
* Copyright 2016-2022 the original author or authors.
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v2.0 which
* accompanies this distribution and is available at
*
* http://www.eclipse.org/legal/epl-v20.html
*/
package org.junitpioneer.internal;
import java.util.Collection;
import java.util.function.Supplier;
import org.junit.platform.commons.PreconditionViolationException;
/**
* Pioneer-internal utility class to handle preconditions.
* DO NOT USE THIS CLASS - IT MAY CHANGE SIGNIFICANTLY IN ANY MINOR UPDATE.
*/
public class PioneerPreconditions {
private PioneerPreconditions() {
// private constructor to prevent instantiation of utility class
}
/**
* Asserts that the supplied string is not blank.
* @param str the string to check
* @param message the precondition violation message
* @return the supplied string
*/
public static String notBlank(String str, String message) {
if (str == null || str.trim().isEmpty()) {
throw new PreconditionViolationException(message);
}
return str;
}
/**
* Asserts that the supplied string is not blank.
* @param str the string to check
* @param messageSupplier the precondition violation message supplier
* @return the supplied string
*/
public static String notBlank(String str, Supplier messageSupplier) {
if (str == null || str.trim().isEmpty()) {
throw new PreconditionViolationException(messageSupplier.get());
}
return str;
}
/**
* Asserts that the supplied object is not null.
* @param object the object to check
* @param message the precondition violation message
* @return the supplied object
*/
public static T notNull(T object, String message) {
if (object == null) {
throw new PreconditionViolationException(message);
}
return object;
}
/**
* Asserts that the supplied object is not null.
* @param object the object to check
* @param messageSupplier the precondition violation message supplier
* @return the supplied object
*/
public static T notNull(T object, Supplier messageSupplier) {
if (object == null) {
throw new PreconditionViolationException(messageSupplier.get());
}
return object;
}
/**
* Asserts that the supplied collection is not empty.
* @param collection the collection to check
* @param message the precondition violation message
* @return the supplied string
*/
public static > T notEmpty(T collection, String message) {
if (collection == null || collection.isEmpty()) {
throw new PreconditionViolationException(message);
}
return collection;
}
/**
* Asserts that the supplied collection is not empty.
* @param collection the collection to check
* @param messageSupplier the precondition violation message supplier
* @return the supplied string
*/
public static > T notEmpty(T collection, Supplier messageSupplier) {
if (collection == null || collection.isEmpty()) {
throw new PreconditionViolationException(messageSupplier.get());
}
return collection;
}
}