com.palantir.atlasdb.keyvalue.api.CandidateCellForSweepingRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of atlasdb-api Show documentation

Palantir open source project

There is a newer version: 0.1152.0

/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed 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 com.palantir.atlasdb.keyvalue.api;

import java.util.OptionalInt;
import org.immutables.value.Value;

@Value.Immutable
public interface CandidateCellForSweepingRequest {
    byte[] startRowInclusive();

    OptionalInt batchSizeHint();

    /**
     *  The maximum timestamp to be returned in the resulting {@link CandidateCellForSweeping} objects.
     */
    long maxTimestampExclusive();

    /**
     *  In practice, this is true for the THOROUGH sweep strategy and false for CONSERVATIVE.
     */
    boolean shouldCheckIfLatestValueIsEmpty();

    /**
     * Whether GC sentinels (values written at timestamp -1) should be deleted by sweep.
     * In practice, this is true for the THOROUGH sweep strategy and false for CONSERVATIVE.
     */
    boolean shouldDeleteGarbageCollectionSentinels();

    default boolean shouldSweep(long timestamp) {
        if (timestamp == com.palantir.atlasdb.keyvalue.api.Value.INVALID_VALUE_TIMESTAMP) {
            return shouldDeleteGarbageCollectionSentinels();
        }

        return timestamp < maxTimestampExclusive();
    }

    default CandidateCellForSweepingRequest withStartRow(byte[] startRow) {
        return ImmutableCandidateCellForSweepingRequest.builder()
                .from(this)
                .startRowInclusive(startRow)
                .build();
    }
}