All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.lang3.compare.ComparableUtils Maven / Gradle / Ivy

There is a newer version: 4.1.4
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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
 *
 *      http://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.apache.commons.lang3.compare;

import java.util.function.Predicate;

/**
 * 

Utility library to provide helper methods for translating {@link Comparable#compareTo} result into a boolean.

* *

Example: {@code boolean x = is(myComparable).lessThanOrEqualTo(otherComparable)}

* *

#ThreadSafe#

* * @since 3.10 */ public class ComparableUtils { /** * Provides access to the available methods * * @param the type of objects that this object may be compared against. */ public static class ComparableCheckBuilder> { private final A a; private ComparableCheckBuilder(final A a) { this.a = a; } /** * Checks if {@code [b <= a <= c]} or {@code [b >= a >= c]} where the {@code a} is object passed to {@link #is}. * * @param b the object to compare to the base object * @param c the object to compare to the base object * @return true if the base object is between b and c */ public boolean between(final A b, final A c) { return betweenOrdered(b, c) || betweenOrdered(c, b); } /** * Checks if {@code (b < a < c)} or {@code (b > a > c)} where the {@code a} is object passed to {@link #is}. * * @param b the object to compare to the base object * @param c the object to compare to the base object * @return true if the base object is between b and c and not equal to those */ public boolean betweenExclusive(final A b, final A c) { return betweenOrderedExclusive(b, c) || betweenOrderedExclusive(c, b); } private boolean betweenOrdered(final A b, final A c) { return greaterThanOrEqualTo(b) && lessThanOrEqualTo(c); } private boolean betweenOrderedExclusive(final A b, final A c) { return greaterThan(b) && lessThan(c); } /** * Checks if the object passed to {@link #is} is equal to {@code b} * * @param b the object to compare to the base object * @return true if the value returned by {@link Comparable#compareTo} is equal to {@code 0} */ public boolean equalTo(final A b) { return a.compareTo(b) == 0; } /** * Checks if the object passed to {@link #is} is greater than {@code b} * * @param b the object to compare to the base object * @return true if the value returned by {@link Comparable#compareTo} is greater than {@code 0} */ public boolean greaterThan(final A b) { return a.compareTo(b) > 0; } /** * Checks if the object passed to {@link #is} is greater than or equal to {@code b} * * @param b the object to compare to the base object * @return true if the value returned by {@link Comparable#compareTo} is greater than or equal to {@code 0} */ public boolean greaterThanOrEqualTo(final A b) { return a.compareTo(b) >= 0; } /** * Checks if the object passed to {@link #is} is less than {@code b} * * @param b the object to compare to the base object * @return true if the value returned by {@link Comparable#compareTo} is less than {@code 0} */ public boolean lessThan(final A b) { return a.compareTo(b) < 0; } /** * Checks if the object passed to {@link #is} is less than or equal to {@code b} * * @param b the object to compare to the base object * @return true if the value returned by {@link Comparable#compareTo} is less than or equal to {@code 0} */ public boolean lessThanOrEqualTo(final A b) { return a.compareTo(b) <= 0; } } /** * Checks if {@code [b <= a <= c]} or {@code [b >= a >= c]} where the {@code a} is the tested object. * * @param b the object to compare to the tested object * @param c the object to compare to the tested object * @param type of the test object * @return a predicate for true if the tested object is between b and c */ public static > Predicate between(final A b, final A c) { return a -> is(a).between(b, c); } /** * Checks if {@code (b < a < c)} or {@code (b > a > c)} where the {@code a} is the tested object. * * @param b the object to compare to the tested object * @param c the object to compare to the tested object * @param type of the test object * @return a predicate for true if the tested object is between b and c and not equal to those */ public static > Predicate betweenExclusive(final A b, final A c) { return a -> is(a).betweenExclusive(b, c); } /** * Checks if the tested object is greater than or equal to {@code b} * * @param b the object to compare to the tested object * @param type of the test object * @return a predicate for true if the value returned by {@link Comparable#compareTo} * is greater than or equal to {@code 0} */ public static > Predicate ge(final A b) { return a -> is(a).greaterThanOrEqualTo(b); } /** * Checks if the tested object is greater than {@code b} * * @param b the object to compare to the tested object * @param type of the test object * @return a predicate for true if the value returned by {@link Comparable#compareTo} is greater than {@code 0} */ public static > Predicate gt(final A b) { return a -> is(a).greaterThan(b); } /** * Provides access to the available methods * * @param a base object in the further comparison * @param type of the base object * @return a builder object with further methods */ public static > ComparableCheckBuilder is(final A a) { return new ComparableCheckBuilder<>(a); } /** * Checks if the tested object is less than or equal to {@code b} * * @param b the object to compare to the tested object * @param type of the test object * @return a predicate for true if the value returned by {@link Comparable#compareTo} * is less than or equal to {@code 0} */ public static > Predicate le(final A b) { return a -> is(a).lessThanOrEqualTo(b); } /** * Checks if the tested object is less than {@code b} * * @param b the object to compare to the tested object * @param type of the test object * @return a predicate for true if the value returned by {@link Comparable#compareTo} is less than {@code 0} */ public static > Predicate lt(final A b) { return a -> is(a).lessThan(b); } private ComparableUtils() {} }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy