lib/src/main/java/io/v/syncbase/v23/services/syncbase/nosql/RowRange.java

// Copyright 2015 The Vanadium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package io.v.syncbase.v23.services.syncbase.nosql;

import io.v.syncbase.v23.services.syncbase.util.Util;

/**
 * Represents all rows with keys in {@code [start, limit)}.  If limit is {@code ""}, all rows with
 * keys ≥ {@code start} are included.
 */
public class RowRange {
    private final String start, limit;

    /**
     * Creates a new row range with keys in {@code [start, limit)}.
     */
    public RowRange(String start, String limit) {
        this.start = start;
        this.limit = limit;
    }

    /**
     * Creates a row range containing a single {@code row}.
     */
    public RowRange(String row) {
        this.start = row;
        this.limit = row + "\u0000";
    }

    /**
     * Returns {@code true} iff the provided row is inside this range.
     */
    public boolean isWithin(String row) {
        return this.start.compareTo(row) <= 0 &&
                (this.limit.isEmpty() || this.limit.compareTo(row) > 0);
    }

    /**
     * Returns the key that marks the start of the row range.
     */
    public String getStart() { return this.start; }

    /**
     * Returns the key that marks the limit of the row range.
     */
    public String getLimit() { return this.limit; }
}