com.cinchapi.common.base.validate.BiCheck Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2013-2017 Cinchapi Inc.
 * 
 * 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 com.cinchapi.common.base.validate;

/**
 * A function that determines whether a two values pass a test (usually a
 * comparison).
 * 
 * @author Jeff Nelson
 */
@FunctionalInterface
public interface BiCheck {

    /**
     * Return {@code true} if the {@code value1} and {@code value2}, together,
     * pass the test.
     * 
     * @param value1 a value to check
     * @param value2 a value to check
     * @return a boolean
     */
    public boolean passes(T1 value1, T2 value2);

}