/*
 * Copyright 2010 - 2023 JetBrains s.r.o.
 *
 * 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
 *
 * https://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 jetbrains.exodus.tree;

import jetbrains.exodus.ByteIterable;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

public interface TreeTraverser {

    void init(boolean left);

    boolean isNotEmpty();

    @NotNull
    ByteIterable getKey();

    @NotNull
    ByteIterable getValue();

    boolean hasValue();

    boolean canMoveRight();

    boolean canMoveLeft();

    boolean canMoveUp();

    boolean canMoveDown();

    @NotNull
    INode moveRight();

    @NotNull
    INode moveLeft();

    void moveUp();

    @NotNull
    INode moveDown();

    @NotNull
    INode moveDownToLast();

    int compareCurrent(@NotNull final ByteIterable key);

    void reset(@NotNull MutableTreeRoot root);

    long getCurrentAddress();

    ITree getTree();

    boolean moveTo(ByteIterable key, @Nullable ByteIterable value);

    boolean moveToRange(ByteIterable key, @Nullable ByteIterable value);
}
