server-common/src/main/java/org/apache/kafka/timeline/Revertable.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.kafka.timeline;

/**
 * An API which all snapshot data structures implement, indicating that their contents
 * can be reverted to a point in time.
 */
interface Revertable {
    /**
     * Revert to the target epoch.
     *
     * @param targetEpoch   The epoch to revert to.
     * @param delta         The delta associated with this epoch for this object.
     */
    void executeRevert(long targetEpoch, Delta delta);

    /**
     * Reverts to the initial value.
     */
    void reset();
}