modules/metastorage/src/main/java/org/apache/ignite/internal/metastorage/server/Condition.java

/*
 * 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.ignite.internal.metastorage.server;

import java.util.Collection;
import org.apache.ignite.internal.metastorage.Entry;

/**
 * Defines interface for boolean condition which could be applied to an array of entries.
 *
 * @see KeyValueStorage#invoke(Condition, Collection, Collection)
 */
public interface Condition {
    /**
     * Returns the keys which identifies an entries which condition will be applied to.
     *
     * @return The keys which identifies an entries which condition will be applied to.
     */
    byte[][] keys();

    /**
     * Tests the given entries on condition.
     *
     * @param entries Array of entries which will be tested on the condition. Can't be {@code null}.
     * @return {@code True} if the given entries satisfies to the condition, otherwise - {@code false}.
     */
    boolean test(Entry... entries);
}