LogCursor.java

  1. /*
  2.  * Copyright (C) 2017, Google Inc.
  3.  * and other copyright owners as documented in the project's IP log.
  4.  *
  5.  * This program and the accompanying materials are made available
  6.  * under the terms of the Eclipse Distribution License v1.0 which
  7.  * accompanies this distribution, is reproduced below, and is
  8.  * available at http://www.eclipse.org/org/documents/edl-v10.php
  9.  *
  10.  * All rights reserved.
  11.  *
  12.  * Redistribution and use in source and binary forms, with or
  13.  * without modification, are permitted provided that the following
  14.  * conditions are met:
  15.  *
  16.  * - Redistributions of source code must retain the above copyright
  17.  *   notice, this list of conditions and the following disclaimer.
  18.  *
  19.  * - Redistributions in binary form must reproduce the above
  20.  *   copyright notice, this list of conditions and the following
  21.  *   disclaimer in the documentation and/or other materials provided
  22.  *   with the distribution.
  23.  *
  24.  * - Neither the name of the Eclipse Foundation, Inc. nor the
  25.  *   names of its contributors may be used to endorse or promote
  26.  *   products derived from this software without specific prior
  27.  *   written permission.
  28.  *
  29.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  30.  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  31.  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  33.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  34.  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  35.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  36.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  37.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  38.  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39.  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  40.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  41.  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42.  */

  43. package org.eclipse.jgit.internal.storage.reftable;

  44. import java.io.IOException;

  45. import org.eclipse.jgit.lib.ReflogEntry;

  46. /**
  47.  * Iterator over logs inside a
  48.  * {@link org.eclipse.jgit.internal.storage.reftable.Reftable}.
  49.  */
  50. public abstract class LogCursor implements AutoCloseable {
  51.     /**
  52.      * Check if another log record is available.
  53.      *
  54.      * @return {@code true} if there is another result.
  55.      * @throws java.io.IOException
  56.      *             logs cannot be read.
  57.      */
  58.     public abstract boolean next() throws IOException;

  59.     /**
  60.      * Get name of the current reference.
  61.      *
  62.      * @return name of the current reference.
  63.      */
  64.     public abstract String getRefName();

  65.     /**
  66.      * Get identifier of the transaction that created the log record.
  67.      *
  68.      * @return identifier of the transaction that created the log record.
  69.      */
  70.     public abstract long getUpdateIndex();

  71.     /**
  72.      * Get current log entry.
  73.      *
  74.      * @return current log entry.
  75.      */
  76.     public abstract ReflogEntry getReflogEntry();

  77.     /** {@inheritDoc} */
  78.     @Override
  79.     public abstract void close();
  80. }