org.springframework.data.util.Predicates Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-commons Show documentation
There is a newer version: 3.4.0
/*
 * Copyright 2021-2023 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.util;

import java.lang.reflect.Constructor;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.function.Predicate;

import org.springframework.util.Assert;

/**
 * Utility methods to work with {@link Predicate}s.
 *
 * @author Mark Paluch
 * @since 2.7
 */
public interface Predicates {

	Predicate IS_ENUM_MEMBER = member -> member.getDeclaringClass().isEnum();
	Predicate IS_HIBERNATE_MEMBER = member -> member.getName().startsWith("$$_hibernate"); // this
	// should
	// go
	// into
	// JPA
	Predicate IS_OBJECT_MEMBER = member -> Object.class.equals(member.getDeclaringClass());
	Predicate IS_JAVA = member -> member.getDeclaringClass().getPackageName().startsWith("java.");
	Predicate IS_NATIVE = member -> Modifier.isNative(member.getModifiers());
	Predicate IS_PRIVATE = member -> Modifier.isPrivate(member.getModifiers());
	Predicate IS_PROTECTED = member -> Modifier.isProtected(member.getModifiers());
	Predicate IS_PUBLIC = member -> Modifier.isPublic(member.getModifiers());
	Predicate IS_SYNTHETIC = Member::isSynthetic;

	Predicate> IS_KOTLIN = KotlinReflectionUtils::isSupportedKotlinClass;
	Predicate IS_STATIC = member -> Modifier.isStatic(member.getModifiers());

	Predicate IS_BRIDGE_METHOD = Method::isBridge;

	/**
	 * A {@link Predicate} that yields always {@code true}.
	 *
	 * @return a {@link Predicate} that yields always {@code true}.
	 */
	static  Predicate isTrue() {
		return t -> true;
	}

	/**
	 * A {@link Predicate} that yields always {@code false}.
	 *
	 * @return a {@link Predicate} that yields always {@code false}.
	 */
	static  Predicate isFalse() {
		return t -> false;
	}

	/**
	 * Returns a {@link Predicate} that represents the logical negation of {@code predicate}.
	 *
	 * @return a {@link Predicate} that represents the logical negation of {@code predicate}.
	 */
	static  Predicate negate(Predicate predicate) {

		Assert.notNull(predicate, "Predicate must not be null");
		return predicate.negate();
	}

	/**
	 * Whether to consider a {@link Constructor}. We generally exclude synthetic constructors for non-Kotlin classes.
	 *
	 * @param candidate
	 * @return
	 */
	static boolean isIncluded(Constructor candidate) {
		return !isExcluded(candidate);
	}

	/**
	 * Whether to not consider a {@link Constructor}. We generally exclude synthetic constructors for non-Kotlin classes.
	 *
	 * @param candidate
	 * @return
	 */
	static boolean isExcluded(Constructor candidate) {

		if (IS_KOTLIN.test(candidate.getDeclaringClass())) {
			return false;
		}

		return IS_SYNTHETIC.test(candidate);
	}
}