1 /*
2 * Copyright (C) 2013, Robin Rosenberg <robin.rosenberg@dewire.com>
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
44 package org.eclipse.jgit.lib;
45
46 import java.io.IOException;
47 import java.util.List;
48
49 /**
50 * Utility for reading reflog entries
51 *
52 * @since 3.0
53 */
54 public interface ReflogReader {
55
56 /**
57 * Get the last entry in the reflog
58 *
59 * @return the latest reflog entry, or null if no log
60 * @throws java.io.IOException
61 */
62 ReflogEntry getLastEntry() throws IOException;
63
64 /**
65 * Get all reflog entries in reverse order
66 *
67 * @return all reflog entries in reverse order
68 * @throws java.io.IOException
69 */
70 List<ReflogEntry> getReverseEntries() throws IOException;
71
72 /**
73 * Get specific entry in the reflog relative to the last entry which is
74 * considered entry zero.
75 *
76 * @param number a int.
77 * @return reflog entry or null if not found
78 * @throws java.io.IOException
79 */
80 ReflogEntry getReverseEntry(int number) throws IOException;
81
82 /**
83 * Get all reflog entries in reverse order
84 *
85 * @param max
86 * max number of entries to read
87 * @return all reflog entries in reverse order
88 * @throws java.io.IOException
89 */
90 List<ReflogEntry> getReverseEntries(int max) throws IOException;
91 }