jena-arq/src/main/java/org/apache/jena/atlas/data/ThresholdPolicy.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.jena.atlas.data;

public interface ThresholdPolicy<E>
{
    /**
     * Call this method each time to increment the policy's threshold count.
     * @param item The item that was added.
     */
    void increment(E item);
    
    /**
     * Determines whether or not the configured threshold has been exceeded for this policy.
     * @return <code>true</code> if the threshold has been reached; <code>false</code> otherwise.
     */
    boolean isThresholdExceeded();
    
    /**
     * Reset the policy back to the initial state.
     */
    void reset();
}