All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.parboiled.common.Predicates Maven / Gradle / Ivy

    /*
 * Copyright (C) 2007 Google Inc., adapted in 2010 by Mathias Doenitz
 *
 * 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
 *
 * 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.parboiled.common;

import static org.parboiled.common.Preconditions.*;

import java.util.Collection;

public final class Predicates {

    private Predicates() {}

    /**
     * Returns a predicate that always evaluates to {@code true}.
     *
     * @return a predicate
     */
    @SuppressWarnings("unchecked")
    public static  Predicate alwaysTrue() {
        return (Predicate) AlwaysTruePredicate.INSTANCE;
    }

    /**
     * Returns a predicate that always evaluates to {@code false}.
     *
     * @return a predicate
     */
    @SuppressWarnings("unchecked")
    public static  Predicate alwaysFalse() {
        return (Predicate) AlwaysFalsePredicate.INSTANCE;
    }

    /**
     * Returns a predicate that evaluates to {@code true} if the object reference
     * being tested is null.
     *
     * @return a predicate
     */
    @SuppressWarnings("unchecked")
    public static  Predicate isNull() {
        return (Predicate) IsNullPredicate.INSTANCE;
    }

    /**
     * Returns a predicate that evaluates to {@code true} if the object reference
     * being tested is not null.
     *
     * @return a predicate
     */
    @SuppressWarnings("unchecked")
    public static  Predicate notNull() {
        return (Predicate) NotNullPredicate.INSTANCE;
    }

    /**
     * Returns a predicate that evaluates to {@code true} if the given predicate
     * evaluates to {@code false}.
     *
     * @param predicate the inner predicate
     * @return a predicate
     */
    public static  Predicate not(Predicate predicate) {
        return new NotPredicate(predicate);
    }

    /**
     * Returns a predicate that evaluates to {@code true} if each of its
     * components evaluates to {@code true}. The components are evaluated in
     * order, and evaluation will be "short-circuited" as soon as a false
     * predicate is found. It defensively copies the iterable passed in, so future
     * changes to it won't alter the behavior of this predicate. If {@code
     * components} is empty, the returned predicate will always evaluate to {@code
     * true}.
     *
     * @param components the components
     * @return a predicate
     */
    public static  Predicate and(Collection> components) {
        return new AndPredicate(components);
    }

    /**
     * Returns a predicate that evaluates to {@code true} if each of its
     * components evaluates to {@code true}. The components are evaluated in
     * order, and evaluation will be "short-circuited" as soon as a false
     * predicate is found. It defensively copies the array passed in, so future
     * changes to it won't alter the behavior of this predicate. If {@code
     * components} is empty, the returned predicate will always evaluate to {@code
     * true}.
     *
     * @param components the components
     * @return a predicate
     */
    public static  Predicate and(Predicate... components) {
        return new AndPredicate(ImmutableList.of(components));
    }

    /**
     * Returns a predicate that evaluates to {@code true} if both of its
     * components evaluate to {@code true}. The components are evaluated in
     * order, and evaluation will be "short-circuited" as soon as a false
     * predicate is found.
     *
     * @param first the first
     * @param second the second
     * @return a predicate
     */
    public static  Predicate and(Predicate first, Predicate second) {
        checkArgNotNull(first, "first");
        checkArgNotNull(second, "second");
        return new AndPredicate(ImmutableList.>of(first, second));
    }

    /**
     * Returns a predicate that evaluates to {@code true} if any one of its
     * components evaluates to {@code true}. The components are evaluated in
     * order, and evaluation will be "short-circuited" as soon as as soon as a
     * true predicate is found. It defensively copies the iterable passed in, so
     * future changes to it won't alter the behavior of this predicate. If {@code
     * components} is empty, the returned predicate will always evaluate to {@code
     * false}.
     *
     * @param components the components
     * @return a predicate
     */
    public static  Predicate or(Collection> components) {
        return new OrPredicate(components);
    }

    /**
     * Returns a predicate that evaluates to {@code true} if any one of its
     * components evaluates to {@code true}. The components are evaluated in
     * order, and evaluation will be "short-circuited" as soon as as soon as a
     * true predicate is found. It defensively copies the array passed in, so
     * future changes to it won't alter the behavior of this predicate. If {@code
     * components} is empty, the returned predicate will always evaluate to {@code
     * false}.
     *
     * @param components the components
     * @return a predicate
     */
    public static  Predicate or(Predicate... components) {
        return new OrPredicate(ImmutableList.of(components));
    }

    /**
     * Returns a predicate that evaluates to {@code true} if either of its
     * components evaluates to {@code true}. The components are evaluated in
     * order, and evaluation will be "short-circuited" as soon as as soon as a
     * true predicate is found.
     *
     * @param first the first
     * @param second the second
     * @return a predicate
     */
    public static  Predicate or(Predicate first, Predicate second) {
        checkArgNotNull(first, "first");
        checkArgNotNull(second, "second");
        return new OrPredicate(ImmutableList.>of(first, second));
    }

    /**
     * Returns a predicate that evaluates to {@code true} if the object being
     * tested {@code equals()} the given target or both are null.
     *
     * @param target the target
     * @return a predicate
     */
    public static  Predicate equalTo(T target) {
        return (target == null) ? Predicates.isNull() : new IsEqualToPredicate(target);
    }

    /**
     * Returns a predicate that evaluates to {@code true} if the object being
     * tested is an instance of the given class. If the object being tested
     * is {@code null} this predicate evaluates to {@code false}.
     * 
    
     *
     * @param clazz the clazz
     * @return a predicate
     */
    public static Predicate instanceOf(Class clazz) {
        return new InstanceOfPredicate(clazz);
    }

    /**
     * Returns a predicate that evaluates to {@code true} if the object reference
     * being tested is a member of the given collection. It does not defensively
     * copy the collection passed in, so future changes to it will alter the
     * behavior of the predicate.
     * 
    
     * This method can technically accept any Collection, but using a typed
     * collection helps prevent bugs. This approach doesn't block any potential
     * users since it is always possible to use {@code Predicates.in()}.
     *
     * @param target the collection that may contain the function input
     * @return a predicate
     */
    public static  Predicate in(Collection target) {
        return new InPredicate(target);
    }

    private static class AlwaysTruePredicate implements Predicate {
        private static final Predicate INSTANCE = new AlwaysTruePredicate();

        public boolean apply(Object o) {
            return true;
        }

        @Override
        public
        String toString() {
            return "AlwaysTrue";
        }
    }

    private static class AlwaysFalsePredicate implements Predicate {
        private static final Predicate INSTANCE = new AlwaysFalsePredicate();

        public boolean apply(Object o) {
            return false;
        }

        @Override
        public String toString() {
            return "AlwaysFalse";
        }
    }

    private static class NotPredicate implements Predicate {
        private final Predicate predicate;

        private NotPredicate(Predicate predicate) {
            checkArgNotNull(predicate, "predicate");
            this.predicate = predicate;
        }

        public boolean apply(T t) {
            return !predicate.apply(t);
        }

        public String toString() {
            return "Not(" + predicate.toString() + ")";
        }
    }

    private static class AndPredicate implements Predicate {
        private final Collection> components;

        private AndPredicate(Collection> components) {
            this.components = components;
        }

        public boolean apply(T t) {
            for (Predicate predicate : components) {
                if (!predicate.apply(t)) {
                    return false;
                }
            }
            return true;
        }

        @Override
        public String toString() {
            return "And(" + StringUtils.join(components, ", ") + ")";
        }
    }

    private static class OrPredicate implements Predicate {
        private final Collection> components;

        private OrPredicate(Collection> components) {
            this.components = components;
        }

        public boolean apply(T t) {
            for (Predicate predicate : components) {
                if (predicate.apply(t)) {
                    return true;
                }
            }
            return false;
        }

        @Override
        public String toString() {
            return "Or(" + StringUtils.join(components, ", ") + ")";
        }
    }

    private static class IsEqualToPredicate implements Predicate {
        private final T target;

        private IsEqualToPredicate(T target) {
            this.target = target;
        }

        public boolean apply(T t) {
            return target.equals(t);
        }

        @Override
        public String toString() {
            return "IsEqualTo(" + target + ")";
        }
    }

    private static class InstanceOfPredicate implements Predicate {
        private final Class clazz;

        private InstanceOfPredicate(Class clazz) {
            checkArgNotNull(clazz, "clazz");
            this.clazz = clazz;
        }

        public boolean apply(Object o) {
            return clazz.isInstance(o);
        }

        @Override
        public String toString() {
            return "IsInstanceOf(" + clazz.getName() + ")";
        }
    }

    private static class IsNullPredicate implements Predicate {
        private static final Predicate INSTANCE = new IsNullPredicate();

        public boolean apply(Object o) {
            return o == null;
        }

        @Override
        public String toString() {
            return "IsNull";
        }
    }

    private static class NotNullPredicate implements Predicate {
        private static final Predicate INSTANCE = new NotNullPredicate();

        public boolean apply(Object o) {
            return o != null;
        }

        @Override
        public String toString() {
            return "NotNull";
        }
    }

    private static class InPredicate implements Predicate {
        private final Collection target;

        private InPredicate(Collection target) {
            checkArgNotNull(target, "target");
            this.target = target;
        }

        public boolean apply(T t) {
            try {
                return target.contains(t);
            } catch (NullPointerException e) {
                return false;
            } catch (ClassCastException e) {
                return false;
            }
        }

        @Override
        public String toString() {
            return "In(" + target + ")";
        }
    }

}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy