subprojects/s4-core/src/main/java/org/apache/s4/core/ft/CheckpointingConfig.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.s4.core.ft;

import java.util.concurrent.TimeUnit;

/**
 * Checkpointing configuration: event count based vs time interval, frequency. User the {@link Builder} class to build
 * instances.
 *
 */
public class CheckpointingConfig {

    /**
     * Identifies the kind of checkpointing: time based, event count, or no checkpointing
     *
     */
    public static enum CheckpointingMode {
        TIME, EVENT_COUNT, NONE
    }

    public final CheckpointingMode mode;
    public final int frequency;
    public final TimeUnit timeUnit;

    private CheckpointingConfig(CheckpointingMode mode, int frequency, TimeUnit timeUnit) {
        this.mode = mode;
        this.frequency = frequency;
        this.timeUnit = timeUnit;
    }

    public static class Builder {
        private CheckpointingMode mode;
        private int frequency;
        private TimeUnit timeUnit = TimeUnit.MILLISECONDS;

        public Builder(CheckpointingMode mode) {
            this.mode = mode;
        }

        public Builder frequency(int frequency) {
            this.frequency = frequency;
            return this;
        }

        public Builder timeUnit(TimeUnit timeUnit) {
            this.timeUnit = timeUnit;
            return this;
        }

        public CheckpointingConfig build() {
            return new CheckpointingConfig(mode, frequency, timeUnit);
        }

    }

}