/*****************************************************************
 *   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.cayenne.dba;

/**
 * Represents data structure to maintain a range of cached primary keys.
 * 
 * @author Andrus Adamchik
 * @deprecated since 3.0 repalced with a non-public LongPkRange.
 */
public final class PkRange {

    private int curValue;
    private int maxValue;

    public PkRange(int curValue, int maxValue) {
        reset(curValue, maxValue);
    }

    public void reset(int curValue, int maxValue) {
        this.curValue = curValue;
        this.maxValue = maxValue;
    }

    public boolean isExhausted() {
        return curValue > maxValue;
    }

    public Integer getNextPrimaryKey() {
        // do bound checking
        if (isExhausted()) {
            throw new RuntimeException(
                    "PkRange is exhausted and can not be used anymore.");
        }

        return Integer.valueOf(curValue++);
    }
}
