/*******************************************************************************
* Copyright (c) 2005, 2016 QNX Software Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* QNX - Initial API and implementation
* Markus Schorn (Wind River Systems)
*******************************************************************************/
package org.eclipse.jdt.internal.core.nd.db;
/**
* The visitor visits all records where compare returns 0.
*/
public interface IBTreeVisitor {
/**
* Compare the record against an internally held key. The comparison must be
* compatible with the one used for the btree.
* Used for visiting.
*
* @param record
* @return -1 if record < key, 0 if record == key, 1 if record > key
* @throws IndexException
*/
public abstract int compare(long record) throws IndexException;
/**
* Visit a given record and return whether to continue or not.
* @return <code>true</code> to continue the visit, <code>false</code> to abort it.
* @throws IndexException
*/
public abstract boolean visit(long record) throws IndexException;
}